Ir al contenido principal

raygeo.sketch.entities

Entity​

The common base class of every entity binding: a nominal Entity type for isinstance checks and annotations. The per-class members live on the subclasses; polymorphism is carried by the Rust-side Entity trait.

array_copy​

array_copy: bool

Whether the entity is part of an array.

constrained​

constrained: bool

Whether the entity's geometry is fully determined by the solver.

construction​

construction: bool

Whether the entity is construction geometry.

fill_color​

fill_color: Optional[tuple[float, float, float, float]]

The fill color, when one is set.

id​

id: int

The unique entity id.

invisible​

invisible: bool

Whether the entity is hidden from output generation.

type​

type: str

The entity kind label ("line", "arc", ...).

append_to_geometry()​

append_to_geometry(
geo: geo.Geometry,
registry: protocols.Registry,
forward: bool = True,
) -> None

Appends the entity's outline to the geometry.

ParameterTypeDescription
geogeo.Geometry
registryprotocols.Registry
forwardbool = True
ReturnsNone

as_offset_item()​

as_offset_item(sketch: Any) -> Optional[Any]

The offsettable item this entity forms on its own; the reference default is None.

ParameterTypeDescription
sketchAny
ReturnsOptional[Any]

characteristic_length()​

characteristic_length(registry: protocols.Registry) -> float

The entity's characteristic length.

ParameterTypeDescription
registryprotocols.Registry
Returnsfloat

characteristic_length_pairs()​

characteristic_length_pairs() -> list[list[int]]

The entity's characteristic-length point pairs.

ParameterTypeDescription
Returnslist[list[int]]

clear_helper_references()​

clear_helper_references() -> None

Clears the entity's helper point references.

ParameterTypeDescription
ReturnsNone

contains_point()​

contains_point(registry: protocols.Registry, x: float, y: float) -> bool

Whether the model-space point lies inside the entity.

ParameterTypeDescription
registryprotocols.Registry
xfloat
yfloat
Returnsbool

create_fill_geometry()​

create_fill_geometry(registry: protocols.Registry) -> Optional[geo.Geometry]

The fill geometry of the entity, if it supports fills.

ParameterTypeDescription
registryprotocols.Registry
ReturnsOptional[geo.Geometry]

enclosed_signed_area()​

enclosed_signed_area(registry: protocols.Registry) -> float

The signed area the entity encloses on its own; raises NotImplementedError when unsupported.

ParameterTypeDescription
registryprotocols.Registry
Returnsfloat

geometry_signature()​

geometry_signature(registry: protocols.Registry) -> tuple

The geometry signature used for change detection.

ParameterTypeDescription
registryprotocols.Registry
Returnstuple

get_all_frame_point_ids()​

get_all_frame_point_ids(registry: protocols.Registry) -> list[int]

The ids of all frame points, including text box frames.

ParameterTypeDescription
registryprotocols.Registry
Returnslist[int]

get_drag_anchor_points()​

get_drag_anchor_points(point_id: int) -> list[int]

The ids of the entity's drag anchor points.

ParameterTypeDescription
point_idint
Returnslist[int]

get_endpoint_ids()​

get_endpoint_ids() -> list[int]

The ids of the entity's endpoints.

ParameterTypeDescription
Returnslist[int]

get_helper_ids()​

get_helper_ids() -> list[int]

The ids of the entity's helper points.

ParameterTypeDescription
Returnslist[int]

get_ignorable_unconstrained_points()​

get_ignorable_unconstrained_points() -> list[int]

The ids of points that may stay unconstrained.

ParameterTypeDescription
Returnslist[int]

get_junction_point_ids()​

get_junction_point_ids() -> list[int]

The ids of the entity's junction points.

ParameterTypeDescription
Returnslist[int]

get_point_ids()​

get_point_ids() -> list[int]

The ids of all control points used by this entity.

ParameterTypeDescription
Returnslist[int]

get_rigidly_connected_points()​

get_rigidly_connected_points(point_id: int) -> list[int]

The ids of points rigidly connected to the given point.

ParameterTypeDescription
point_idint
Returnslist[int]

get_state()​

get_state() -> Optional[dict]

Solver-relevant discrete state for undo/redo snapshots.

ParameterTypeDescription
ReturnsOptional[dict]

hit_test()​

hit_test(
mx: float,
my: float,
threshold: float,
registry: protocols.Registry,
) -> bool

Whether the entity is hit at model coordinates (mx, my).

ParameterTypeDescription
mxfloat
myfloat
thresholdfloat
registryprotocols.Registry
Returnsbool

intersects_rect()​

intersects_rect(
rect: tuple[float, float, float, float],
registry: protocols.Registry,
) -> bool

Whether the entity intersects the given rect.

ParameterTypeDescription
recttuple[float, float, float, float]
registryprotocols.Registry
Returnsbool

is_closed_loop()​

is_closed_loop() -> bool

Whether the entity alone forms a closed loop.

ParameterTypeDescription
Returnsbool

is_contained_by()​

is_contained_by(
rect: tuple[float, float, float, float],
registry: protocols.Registry,
) -> bool

Whether the entity is fully contained by the given rect.

ParameterTypeDescription
recttuple[float, float, float, float]
registryprotocols.Registry
Returnsbool

is_edge_entity()​

is_edge_entity() -> bool

Whether the entity is an edge entity.

ParameterTypeDescription
Returnsbool

is_radius_entity()​

is_radius_entity() -> bool

Whether the entity has a radius.

ParameterTypeDescription
Returnsbool

mirror()​

mirror(axis: Any) -> None

Mirrors the entity across the reference axis object.

ParameterTypeDescription
axisAny
ReturnsNone

plan_offset()​

plan_offset(
registry: protocols.Registry,
offset: float,
_allocate_id: Any,
) -> Optional[OffsetPlan]

Returns a pure description of the offset changes; the reference default is None (no analytic offset).

ParameterTypeDescription
registryprotocols.Registry
offsetfloat
_allocate_idAny
ReturnsOptional[OffsetPlan]

preview_polylines()​

preview_polylines(
registry: protocols.Registry,
offset: float,
) -> list[list[tuple[float, float]]]

Coarse polylines of the entity's offset for live preview; the reference default is no preview.

ParameterTypeDescription
registryprotocols.Registry
offsetfloat
Returnslist[list[tuple[float, float]]]

remap_references()​

remap_references(id_map: Mapping[int, int]) -> None

Rewrites every point/entity id reference through id_map.

ParameterTypeDescription
id_mapMapping[int, int]
ReturnsNone

rewrite_offsets_from()​

rewrite_offsets_from(template: Any, placement: Any) -> None

Re-derives copy state from a template.

ParameterTypeDescription
templateAny
placementAny
ReturnsNone

set_fill_color()​

set_fill_color(color: Optional[Sequence[float]]) -> bool

Sets the fill color; returns whether the entity supports fills.

ParameterTypeDescription
colorOptional[Sequence[float]]
Returnsbool

set_state()​

set_state(state: dict) -> None

Restores solver-relevant discrete state from a snapshot.

ParameterTypeDescription
statedict
ReturnsNone

signed_distance_to()​

signed_distance_to(
px: float,
py: float,
registry: protocols.Registry,
) -> Optional[float]

Signed distance from the model-space point, if defined.

ParameterTypeDescription
pxfloat
pyfloat
registryprotocols.Registry
ReturnsOptional[float]

supports_fill()​

supports_fill() -> bool

Whether the entity supports fills.

ParameterTypeDescription
Returnsbool

supports_point_on_curve()​

supports_point_on_curve() -> bool

Whether the entity supports point-on-curve constraints.

ParameterTypeDescription
Returnsbool

tangent_at()​

tangent_at(registry: protocols.Registry, point_id: int) -> tuple[float, float]

Tangent direction at the point nearest the model-space point; raises NotImplementedError when the entity has no tangent.

ParameterTypeDescription
registryprotocols.Registry
point_idint
Returnstuple[float, float]

to_dict()​

to_dict() -> dict

Serializes the entity to the reference dictionary shape.

ParameterTypeDescription
Returnsdict

to_geometry()​

to_geometry(registry: protocols.Registry) -> geo.Geometry

Returns the entity's toolpath geometry in model coordinates.

ParameterTypeDescription
registryprotocols.Registry
Returnsgeo.Geometry

to_polygon_vertices()​

to_polygon_vertices(
registry: protocols.Registry,
forward: bool = True,
) -> list[tuple[float, float]]

Returns the entity's outline as polygon vertices.

ParameterTypeDescription
registryprotocols.Registry
forwardbool = True
Returnslist[tuple[float, float]]

to_polyline()​

to_polyline(
registry: protocols.Registry,
tolerance: float = 0.1,
) -> list[tuple[float, float]]

Returns the entity's centerline as polyline vertices.

ParameterTypeDescription
registryprotocols.Registry
tolerancefloat = 0.1
Returnslist[tuple[float, float]]

to_polylines()​

to_polylines(
registry: protocols.Registry,
tolerance: float = 0.1,
) -> list[list[tuple[float, float]]]

Samples the entity into one or more polylines.

ParameterTypeDescription
registryprotocols.Registry
tolerancefloat = 0.1
Returnslist[list[tuple[float, float]]]

transform_offsets()​

transform_offsets(placement: Any) -> None

Transforms entity-internal offset state for a placement.

ParameterTypeDescription
placementAny
ReturnsNone

update_constrained_status()​

update_constrained_status(
registry: protocols.Registry,
constraints: Any,
) -> None

Updates the constrained flag from defining-point status and constraints that dimension this entity's radius or length.

ParameterTypeDescription
registryprotocols.Registry
constraintsAny
ReturnsNone

OffsetPlan​

Description of the changes one offset operation makes.

entities​

entities: list

point_moves​

point_moves: dict

points​

points: list

removed_entity_ids​

removed_entity_ids: list

PolygonOutline​

A sampled outline produced from a connected chain of entities.

closed​

closed: bool

source_ids​

source_ids: list[int]

vertices​

vertices: list[tuple[float, float]]

offset()​

offset(
distance: float,
tolerance: float,
) -> list[tuple[list[tuple[float, float]], bool]]

Offsets the outline into (vertices, closed) pairs.

ParameterTypeDescription
distancefloat
tolerancefloat
Returnslist[tuple[list[tuple[float, float]], bool]]

plan_offset()​

plan_offset(
_registry: protocols.Registry,
offset: float,
allocate_id: Any,
) -> Optional[OffsetPlan]

Plans the replacement geometry for this outline.

ParameterTypeDescription
_registryprotocols.Registry
offsetfloat
allocate_idAny
ReturnsOptional[OffsetPlan]

preview_polylines()​

preview_polylines(
_registry: protocols.Registry,
offset: float,
) -> list[list[tuple[float, float]]]

Coarse polylines of the offset result for live preview.

ParameterTypeDescription
_registryprotocols.Registry
offsetfloat
Returnslist[list[tuple[float, float]]]

Functions​

quantize()​

quantize(value: float) -> float

Rounds a coordinate to the model's six-decimal precision.

ParameterTypeDescription
valuefloat
Returnsfloat