Class Selection

Entity selection.

Hierarchy (View Summary)

Subscribable<Selection>
- Selection

Implements

Iterable<Entity>

Index

Accessors

empty length subscribed

Methods

[iterator] add at bounds clear contains remove set subscribe unsubscribe

Accessors

empty

get empty(): boolean
Whether the selection is empty.

Returns boolean

length

get length(): number
The number of entities selected.

Returns number

subscribed

get subscribed(): boolean
Whether there are any subscribers.

Returns boolean
Inherited from Subscribable.subscribed

Methods

[iterator]

"[iterator]"(): Iterator<Entity>
Iterator for selected entities.

Returns Iterator<Entity>
Implementation of Iterable.[iterator]

add

add(entity: Entity): boolean
Selects the specified entity.
Parameters
- entity: Entity
  The entity.
Returns boolean
True if the entity was selected, false otherwise.

at

at(index: number): Entity
Retrieves the selected entity at the specified index.
Parameters
- index: number
  The index.
Returns Entity
The selected entity.

bounds

bounds(): Aabb
Calculates the world bounding box for the selection.

Returns Aabb
The world bounding box.

clear

clear(): void
Clears the selection, deselecting all entities.

Returns void

contains

contains(entity: Entity): boolean
Determines whether the specified entity is selected.
Parameters
- entity: Entity
  The entity.
Returns boolean
True if the entity is selected, false otherwise.

remove

remove(entity: Entity): boolean
Deselects the specified entity.
Parameters
- entity: Entity
  The entity.
Returns boolean
True if the entity was deselected, false otherwise.

set

set(entities: readonly Entity[]): void
Sets the selection to the specified list of entities.
Parameters
- entities: readonly Entity[]
  The entities to be selected.
Returns void
Remarks
Any entities currently selected will first be deselected.

subscribe(subscriber: Subscriber<Selection>): void
Subscribes to be notified when an event occurs.
Parameters
- subscriber: Subscriber<Selection>
  The callback function.
Returns void
Inherited from Subscribable.subscribe

unsubscribe

unsubscribe(callback: Subscriber<Selection>): boolean
Unsubscribes.
Parameters
- callback: Subscriber<Selection>
  The callback function.
Returns boolean
True if the subscription was canceled, false otherwise.

Inherited from Subscribable.unsubscribe