raygeo.sketch.arrays
ArrayDefinition
Persistent definition of a sketch array.
align_to_tangent
align_to_tangent: bool
Whether curve-along copies follow the tangent.
count
count: int
Number of members.
guide_circle_id
guide_circle_id: types.EntityID
Guide circle or guide path entity id.
members
members: list[tuple[int, list[types.EntityID]]]
Array members as (slot, [entity_id, ...]) pairs.
mode
mode: str
Array mode: circular or curve_along.
offset_to_start
offset_to_start: float
Curve-along start offset.
path_entity_id
path_entity_id: int
Curve-along guide path entity id.
rotate_copies
rotate_copies: bool
Whether copies are rotated with the guide.
spacing
spacing: float
Curve-along spacing.
standalone_pids
standalone_pids: list[tuple[int, list[types.EntityID]]]
Standalone member points as (slot, [point_id, ...]) pairs.
template_anchor
template_anchor: Optional[tuple[tuple[float, float], float]]
Curve-along template anchor.
total_angle_deg
total_angle_deg: float
Circular-array sweep angle.
uid
uid: str
Unique array id.
circular()
circular(
uid: str,
guide_circle_id: types.EntityID,
members: Optional[Sequence[tuple[int, Sequence[types.EntityID]]]] = None,
count: int = 6,
total_angle_deg: float = 360.0,
rotate_copies: bool = True,
) -> ArrayDefinition
| Parameter | Type | Description |
|---|---|---|
uid | str | |
guide_circle_id | types.EntityID | |
members | Optional[Sequence[tuple[int, Sequence[types.EntityID]]]] = None | |
count | int = 6 | |
total_angle_deg | float = 360.0 | |
rotate_copies | bool = True | |
| Returns | ArrayDefinition |
copy()
copy() -> ArrayDefinition
Creates a copy of the definition.
| Parameter | Type | Description |
|---|---|---|
| Returns | ArrayDefinition |
curve_along()
curve_along(
uid: str,
guide_circle_id: types.EntityID,
members: Optional[Sequence[tuple[int, Sequence[types.EntityID]]]] = None,
count: int = 6,
rotate_copies: bool = True,
path_entity_id: int = -1,
align_to_tangent: bool = True,
offset_to_start: float = 0.0,
spacing: float = 0.0,
template_anchor: Optional[tuple[tuple[float, float], float]] = None,
) -> ArrayDefinition
| Parameter | Type | Description |
|---|---|---|
uid | str | |
guide_circle_id | types.EntityID | |
members | Optional[Sequence[tuple[int, Sequence[types.EntityID]]]] = None | |
count | int = 6 | |
rotate_copies | bool = True | |
path_entity_id | int = -1 | |
align_to_tangent | bool = True | |
offset_to_start | float = 0.0 | |
spacing | float = 0.0 | |
template_anchor | Optional[tuple[tuple[float, float], float]] = None | |
| Returns | ArrayDefinition |
from_dict()
from_dict(dict: dict) -> ArrayDefinition
Deserializes a definition.
| Parameter | Type | Description |
|---|---|---|
dict | dict | |
| Returns | ArrayDefinition |
restore()
restore(state: Any) -> None
Restores editable state from a snapshot.
| Parameter | Type | Description |
|---|---|---|
state | Any | |
| Returns | None |
snapshot()
snapshot() -> Any
Captures editable state for undo.
| Parameter | Type | Description |
|---|---|---|
| Returns | Any |
to_dict()
to_dict() -> dict
Serializes the definition.
| Parameter | Type | Description |
|---|---|---|
| Returns | dict |