Class SelectionEventData

An event sent whenever a prism is selected or deselected.

The deselection event for the currently selected prism will always be sent before the selection event for a newly selected prism.

Only the currently selected prism receives input events.

Hierarchy

ServerEvent
- SelectionEventData

Index

Constructors

constructor

Methods

Constructors

constructor

new SelectionEventData(): SelectionEventData

Overrides ServerEvent.constructor
- Defined in lumin/event/SelectionEventData.d.ts:11
Returns SelectionEventData

Methods

getAffectedPrismId

getAffectedPrismId(): bigint

- Defined in lumin/event/SelectionEventData.d.ts:28
Returns the ID of the prism that has been selected or deselected.

priv

none

Returns bigint

the ID of the affected prism

getPrismId

getPrismId(): bigint

Inherited from AnimationBlendSetupEvent.getPrismId
- Defined in lumin/event/ServerEvent.d.ts:16
Returns the Prism ID of the target Prism.

priv

none

Returns bigint

the Prism ID of the target Prism.

getSelectionEventType

getSelectionEventType(): SelectionEventType

- Defined in lumin/event/SelectionEventData.d.ts:20
Returns the type of event (volume selected or deselected)

priv

none

Returns SelectionEventType

the type of selection event

isInputEventType

isInputEventType(): boolean

Inherited from AnimationBlendSetupEvent.isInputEventType
- Defined in lumin/event/ServerEvent.d.ts:24
Returns true if this is an input event (a subclass of InputEventData).

priv

none

Returns boolean

true if this is an input event

toString

toString(): string

Inherited from AnimationBlendSetupEvent.toString
- Defined in lumin/event/ServerEvent.d.ts:31
Returns a string representation of this event for debug purposes.

priv

none

Returns string

Generated using TypeDoc