Skip to main content

inspect_nearby_entities_rdescriptor

Kind: Function
Domain: Inspection
Canonical import: from cadflow.inspect.brep import inspect_nearby_entities_rdescriptor

Signature

def inspect_nearby_entities_rdescriptor(model: 'ModelInput', *, location: 'Sequence[float] | None' = None, region: 'Mapping[str, Any] | str | None' = None, radius: 'float' = 1.0, entity_types: 'Sequence[str]' = ('face', 'edge', 'vertex'), max_results: 'int' = 30) -> 'dict[str, Any]'

Description

Find stable entities whose exact geometry lies near a point or region.

Parameters

NameTypeRequiredDefaultSource description
model'ModelInput'yes-Not explicitly described in the source docstring.
location'Sequence[float] | None'noNoneNot explicitly described in the source docstring.
region'Mapping[str, Any] | str | None'noNoneNot explicitly described in the source docstring.
radius'float'no1.0Not explicitly described in the source docstring.
entity_types'Sequence[str]'no('face', 'edge', 'vertex')Not explicitly described in the source docstring.
max_results'int'no30Not explicitly described in the source docstring.

Returns

Type: 'dict[str, Any]'

The source docstring does not declare additional return semantics.

Errors

The source docstring does not declare a narrower exception contract. Invalid types, values, ownership, paths, or backend state may still raise the corresponding public error.

Behavior and constraints

  • The contract below is generated from the current public runtime signature. Check domain notes for ownership and workflow constraints.

Import check

from cadflow.inspect.brep import inspect_nearby_entities_rdescriptor

See also