Skip to main content

inspect_point_rdescriptor

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

Signature

def inspect_point_rdescriptor(model_or_path: 'BRepModel | TopoDS_Shape | str | Path', point: 'Sequence[float]', entity_kinds: 'Sequence[str]' = ('face', 'edge', 'vertex'), limit: 'int' = 20) -> 'dict[str, Any]'

Description

Return exact point-to-entity distances, ordered by distance then stable id.

Parameters

NameTypeRequiredDefaultSource description
model_or_path'BRepModel | TopoDS_Shape | str | Path'yes-Not explicitly described in the source docstring.
point'Sequence[float]'yes-Not explicitly described in the source docstring.
entity_kinds'Sequence[str]'no('face', 'edge', 'vertex')Not explicitly described in the source docstring.
limit'int'no20Not 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_point_rdescriptor

See also