Zum Hauptinhalt springen

raygeo.sketch.selection

Selection​

The current editor selection: point ids, entity ids, a constraint index and an optional junction point.

constraint_idx​

constraint_idx: Optional[int]

Selected constraint index.

entity_ids​

entity_ids: list[types.EntityID]

Selected entity ids.

junction_pid​

junction_pid: Optional[types.EntityID]

Selected implicit junction point.

point_ids​

point_ids: list[types.EntityID]

Selected point ids.

add_entity()​

add_entity(entity_id: types.EntityID) -> None

Adds one entity without clearing other selection kinds.

ParameterTypeDescription
entity_idtypes.EntityID
ReturnsNone

add_point()​

add_point(pid: types.EntityID) -> None

Adds one point without clearing other selection kinds.

ParameterTypeDescription
pidtypes.EntityID
ReturnsNone

clear()​

clear() -> None

Clears every selected item.

ParameterTypeDescription
ReturnsNone

clear_entities()​

clear_entities() -> None

Clears only the selected entities.

ParameterTypeDescription
ReturnsNone

clear_points()​

clear_points() -> None

Clears only the selected points.

ParameterTypeDescription
ReturnsNone

copy()​

copy() -> Selection

Creates a shallow copy of the selection.

ParameterTypeDescription
ReturnsSelection

is_empty()​

is_empty() -> bool

Whether nothing is selected.

ParameterTypeDescription
Returnsbool

select_connected_entities()​

select_connected_entities(
entity_id: types.EntityID,
registry: registry.EntityRegistry,
) -> None

Adds all entities connected through shared points.

ParameterTypeDescription
entity_idtypes.EntityID
registryregistry.EntityRegistry
ReturnsNone

select_constraint()​

select_constraint(idx: int, is_multi: bool) -> None

Selects a constraint by index.

ParameterTypeDescription
idxint
is_multibool
ReturnsNone

select_entity()​

select_entity(entity_id: types.EntityID, is_multi: bool) -> None

Selects an entity by id.

ParameterTypeDescription
entity_idtypes.EntityID
is_multibool
ReturnsNone

select_junction()​

select_junction(pid: types.EntityID, is_multi: bool) -> None

Selects an implicit junction point.

ParameterTypeDescription
pidtypes.EntityID
is_multibool
ReturnsNone

select_point()​

select_point(pid: types.EntityID, is_multi: bool) -> None

Selects a point by id.

ParameterTypeDescription
pidtypes.EntityID
is_multibool
ReturnsNone