Zum Hauptinhalt springen

raygeo.sketch.registry

Sketch document model.

Model is the registry of points and entities of a sketch document: it stores the same data as the reference entity classes and serializes to and from the same dictionaries (.ryp compatible). Entities are addressed by id; use add_line/add_arc/add_circle/ add_ellipse/add_bezier/add_polygon/add_text_box to extend the document and entity_point_ids/entity_endpoint_ids/entity_type for polymorphic queries.

EntityRegistry​

The sketch document model: points, entities, id allocation.

Serializes to and from the same dictionaries the reference entities produce (.ryp compatible).

add_arc()​

add_arc(
start: int,
end: int,
center: int,
clockwise: bool = False,
construction: bool = False,
) -> int

Adds an arc and returns its id.

ParameterTypeDescription
startint
endint
centerint
clockwisebool = False
constructionbool = False
Returnsint

add_bezier()​

add_bezier(
start: int,
end: int,
construction: bool = False,
cp1: Optional[tuple[float, float]] = None,
cp2: Optional[tuple[float, float]] = None,
) -> int

Adds a bezier and returns its id.

ParameterTypeDescription
startint
endint
constructionbool = False
cp1Optional[tuple[float, float]] = None
cp2Optional[tuple[float, float]] = None
Returnsint

add_circle()​

add_circle(center: int, radius_point: int, construction: bool = False) -> int

Adds a circle and returns its id.

ParameterTypeDescription
centerint
radius_pointint
constructionbool = False
Returnsint

add_constraint_json()​

add_constraint_json(dict: dict) -> int

Adds a constraint from a reference constraint dictionary (.ryp shape), resolving entity references through the registry. Returns the constraint handle.

ParameterTypeDescription
dictdict
Returnsint

add_ellipse()​

add_ellipse(
center: int,
radius_x_point: int,
radius_y_point: int,
construction: bool = False,
) -> int

Adds an ellipse and returns its id.

ParameterTypeDescription
centerint
radius_x_pointint
radius_y_pointint
constructionbool = False
Returnsint

add_line()​

add_line(p1: int, p2: int, construction: bool = False) -> int

Adds a line and returns its id.

ParameterTypeDescription
p1int
p2int
constructionbool = False
Returnsint

add_point()​

add_point(x: float, y: float, fixed: bool = False) -> int

Adds a point and returns its id.

ParameterTypeDescription
xfloat
yfloat
fixedbool = False
Returnsint

add_points()​

add_points(points: Sequence[tuple[int, float, float, bool]]) -> None

Appends pre-built points given as (id, x, y, fixed) tuples.

ParameterTypeDescription
pointsSequence[tuple[int, float, float, bool]]
ReturnsNone

add_polygon()​

add_polygon(
center: int,
handle: int,
vertices: Sequence[tuple[float, float]],
closed: bool = False,
construction: bool = False,
rings: Optional[Sequence[Sequence[tuple[float, float]]]] = None,
) -> int

Adds a polygon and returns its id.

ParameterTypeDescription
centerint
handleint
verticesSequence[tuple[float, float]]
closedbool = False
constructionbool = False
ringsOptional[Sequence[Sequence[tuple[float, float]]]] = None
Returnsint

add_text_box()​

add_text_box(
origin: int,
width: int,
height: int,
content: str = '',
font_family: str = 'sans-serif',
font_size: float = 10.0,
bold: bool = False,
italic: bool = False,
) -> int

Adds a text box and returns its id.

ParameterTypeDescription
originint
widthint
heightint
contentstr = ''
font_familystr = 'sans-serif'
font_sizefloat = 10.0
boldbool = False
italicbool = False
Returnsint

append_to_geometry()​

append_to_geometry(geo: geo.Geometry, id: int, forward: bool) -> None

Appends the entity's geometry (traversal direction aware) to an existing Geometry object.

ParameterTypeDescription
geogeo.Geometry
idint
forwardbool
ReturnsNone

characteristic_length()​

characteristic_length(id: int) -> float

Characteristic length used by equal-length constraints.

ParameterTypeDescription
idint
Returnsfloat

clear_helper_references()​

clear_helper_references(id: int) -> None

Drops the entity's references to its helper entities.

ParameterTypeDescription
idint
ReturnsNone

constraint_count()​

constraint_count() -> int

Number of stored constraints.

ParameterTypeDescription
Returnsint

constraint_dict()​

constraint_dict(index: int) -> dict

The stored reference dictionary of a constraint.

ParameterTypeDescription
indexint
Returnsdict

constraint_residuals()​

constraint_residuals() -> list[float]

Residual values of all stored constraints at the current point positions.

ParameterTypeDescription
Returnslist[float]

contains_point()​

contains_point(id: int, x: float, y: float) -> bool

Whether a point is inside the entity (closed shapes).

ParameterTypeDescription
idint
xfloat
yfloat
Returnsbool

drag_anchor_points()​

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

Points pinned while point_id is dragged.

ParameterTypeDescription
point_idint
Returnslist[int]

enclosed_signed_area()​

enclosed_signed_area(id: int) -> Optional[float]

Signed area enclosed by a closed single-entity loop.

ParameterTypeDescription
idint
ReturnsOptional[float]

entity_count()​

entity_count() -> int

Entity count.

ParameterTypeDescription
Returnsint

entity_endpoint_ids()​

entity_endpoint_ids(id: int) -> Optional[list[int]]

Endpoint ids of an edge entity, or None.

ParameterTypeDescription
idint
ReturnsOptional[list[int]]

entity_ids()​

entity_ids() -> list[int]

All entity ids in insertion order.

ParameterTypeDescription
Returnslist[int]

entity_point_ids()​

entity_point_ids(id: int) -> Optional[list[int]]

Control point ids of an entity, or None.

ParameterTypeDescription
idint
ReturnsOptional[list[int]]

entity_to_dict()​

entity_to_dict(id: int) -> dict

Serializes the entity to a reference entity dictionary.

ParameterTypeDescription
idint
Returnsdict

entity_type()​

entity_type(id: int) -> Optional[str]

The serialization type string of an entity, or None.

ParameterTypeDescription
idint
ReturnsOptional[str]

entity_version()​

entity_version() -> int

Monotonic entity-list version.

ParameterTypeDescription
Returnsint

from_dict()​

from_dict(dict: dict) -> EntityRegistry

Deserializes the model from a reference registry dictionary.

ParameterTypeDescription
dictdict
ReturnsEntityRegistry

geometry_signature()​

geometry_signature(id: int) -> Any

The entity's geometry signature (quantized defining points plus kind-specific state), or None for unknown ids.

ParameterTypeDescription
idint
ReturnsAny

get_point()​

get_point(id: int) -> Optional[tuple[float, float]]

Coordinates of a point as (x, y), or None.

ParameterTypeDescription
idint
ReturnsOptional[tuple[float, float]]

get_state()​

get_state(id: int) -> Any

Solver-relevant state snapshot of an entity, or None.

ParameterTypeDescription
idint
ReturnsAny

helper_ids()​

helper_ids(id: int) -> list[int]

Helper/child ids of a compound entity.

ParameterTypeDescription
idint
Returnslist[int]

hit_test()​

hit_test(id: int, mx: float, my: float, threshold: float) -> bool

Whether the point lies within threshold distance of the entity.

ParameterTypeDescription
idint
mxfloat
myfloat
thresholdfloat
Returnsbool

ignorable_unconstrained_points()​

ignorable_unconstrained_points(id: int) -> list[int]

Points that can stay unconstrained when the entity is constrained.

ParameterTypeDescription
idint
Returnslist[int]

intersects_rect()​

intersects_rect(id: int, rect: Sequence[float]) -> bool

Whether the entity intersects the rect or is contained by it.

ParameterTypeDescription
idint
rectSequence[float]
Returnsbool

is_closed_loop()​

is_closed_loop(id: int) -> bool

Whether the entity alone forms a closed loop.

ParameterTypeDescription
idint
Returnsbool

is_constrained()​

is_constrained(id: int) -> bool

Whether the entity is fully constrained.

ParameterTypeDescription
idint
Returnsbool

is_construction()​

is_construction(id: int) -> bool

Whether the entity is a construction entity.

ParameterTypeDescription
idint
Returnsbool

is_contained_by()​

is_contained_by(id: int, rect: Sequence[float]) -> bool

Whether the entity is fully strictly contained in the rect.

ParameterTypeDescription
idint
rectSequence[float]
Returnsbool

is_edge_entity()​

is_edge_entity(id: int) -> bool

Whether the entity participates in edge/chaining adjacency.

ParameterTypeDescription
idint
Returnsbool

is_point_used()​

is_point_used(id: int) -> bool

Whether the point is referenced by any entity.

ParameterTypeDescription
idint
Returnsbool

is_radius_entity()​

is_radius_entity(id: int) -> bool

Whether the entity has a radius.

ParameterTypeDescription
idint
Returnsbool

junction_point_ids()​

junction_point_ids(id: int) -> list[int]

Junction point ids of an entity.

ParameterTypeDescription
idint
Returnslist[int]

mirror()​

mirror(id: int, direction: str, position: float) -> None

Mirrors entity-internal state across the axis (arc chirality, bezier offsets, polygon winding).

ParameterTypeDescription
idint
directionstr
positionfloat
ReturnsNone

point_constrained()​

point_constrained(id: int) -> bool

Whether the point is solver-constrained.

ParameterTypeDescription
idint
Returnsbool

point_count()​

point_count() -> int

Point count.

ParameterTypeDescription
Returnsint

point_ids()​

point_ids() -> list[int]

All point ids in insertion order.

ParameterTypeDescription
Returnslist[int]

remove_constraint()​

remove_constraint(index: int) -> None

Removes a constraint by handle.

ParameterTypeDescription
indexint
ReturnsNone

remove_entities()​

remove_entities(entity_ids: Sequence[int]) -> None

Removes entities by id.

ParameterTypeDescription
entity_idsSequence[int]
ReturnsNone

remove_points()​

remove_points(point_ids: Sequence[int]) -> None

Removes the given points.

ParameterTypeDescription
point_idsSequence[int]
ReturnsNone

rigidly_connected_points()​

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

Points that move rigidly with point_id.

ParameterTypeDescription
point_idint
Returnslist[int]

set_construction()​

set_construction(id: int, construction: bool) -> None

Sets the construction flag.

ParameterTypeDescription
idint
constructionbool
ReturnsNone

set_point_constrained()​

set_point_constrained(id: int, constrained: bool) -> bool

Sets a point's solver-constrained flag.

ParameterTypeDescription
idint
constrainedbool
Returnsbool

set_point_position()​

set_point_position(id: int, x: float, y: float) -> bool

Sets a point's coordinates.

ParameterTypeDescription
idint
xfloat
yfloat
Returnsbool

set_state()​

set_state(id: int, state: dict) -> None

Restores an entity's state snapshot.

ParameterTypeDescription
idint
statedict
ReturnsNone

signed_distance_to()​

signed_distance_to(id: int, px: float, py: float) -> Optional[float]

Signed distance from a point to the entity's locus, or None when unsupported.

ParameterTypeDescription
idint
pxfloat
pyfloat
ReturnsOptional[float]

supports_point_on_curve()​

supports_point_on_curve(id: int) -> bool

Whether a point can be constrained onto this entity's curve.

ParameterTypeDescription
idint
Returnsbool

tangent_at()​

tangent_at(id: int, point_id: int) -> Optional[tuple[float, float]]

Tangent vector at a defining point, or None when the entity has no directional tangent.

ParameterTypeDescription
idint
point_idint
ReturnsOptional[tuple[float, float]]

to_dict()​

to_dict() -> dict

Serializes the model to a reference registry dictionary.

ParameterTypeDescription
Returnsdict

to_geometry()​

to_geometry(id: int) -> geo.Geometry

The entity as a raygeo Geometry object.

ParameterTypeDescription
idint
Returnsgeo.Geometry

to_polygon_vertices()​

to_polygon_vertices(id: int, forward: bool) -> list[tuple[float, float]]

Polygon vertices of the entity (sampled for curves).

ParameterTypeDescription
idint
forwardbool
Returnslist[tuple[float, float]]

to_polyline()​

to_polyline(id: int, tolerance: float = 0.1) -> list[tuple[float, float]]

Sampled polyline of the entity.

ParameterTypeDescription
idint
tolerancefloat = 0.1
Returnslist[tuple[float, float]]

to_polylines()​

to_polylines(
id: int,
tolerance: float = 0.1,
) -> list[list[tuple[float, float]]]

Sampled polylines of the entity (multi-contour for text).

ParameterTypeDescription
idint
tolerancefloat = 0.1
Returnslist[list[tuple[float, float]]]

update_constrained_status()​

update_constrained_status(
radius_constrained_entity_ids: Sequence[int] = [],
) -> None

Re-computes constrained flags. Entities whose radius is explicitly dimensioned are listed in radius_constrained_entity_ids.

ParameterTypeDescription
radius_constrained_entity_idsSequence[int] = []
ReturnsNone

waypoint_type()​

waypoint_type(id: int) -> Optional[str]

Waypoint type string of a point ("sharp"/"smooth"/"symmetric").

ParameterTypeDescription
idint
ReturnsOptional[str]