Class InteractionChain

Hierarchy (View Summary)

AbstractInteraction
- InteractionChain

Index

Constructors

Methods

addInteraction destroy modifierChanged pipe removeInteraction setActive setModification setPointer

Properties

active chain id modificationKey pointerKey

Constructors

constructor

new InteractionChain(chain?: AbstractInteraction[]): InteractionChain
Parameters
- Optionalchain: AbstractInteraction[]
Returns InteractionChain
Overrides AbstractInteraction.constructor
- Defined in src/interaction/interactionChain.ts:19

Methods

addInteraction

addInteraction(interaction: AbstractInteraction, index?: number): void
Add an interaction to the chain. Optionally passing an index where to add the interaction to.
Parameters
- interaction: AbstractInteraction
- Optionalindex: number
Returns void
- Defined in src/interaction/interactionChain.ts:29

destroy

destroy(): void
destroys the implementation, removing any created resources

Returns void
Overrides AbstractInteraction.destroy
- Defined in src/interaction/interactionChain.ts:93

modifierChanged

modifierChanged(modifier: ModificationKeyType): void
Called when the modifier keys have changed.
Parameters
- modifier: ModificationKeyType
Returns void
Overrides AbstractInteraction.modifierChanged
- Defined in src/interaction/interactionChain.ts:71

pipe

pipe(event: InteractionEvent): Promise<InteractionEvent>
Main function, called when an event is raised for this interaction
Parameters
- event: InteractionEvent
Returns Promise<InteractionEvent>
Overrides AbstractInteraction.pipe
- Defined in src/interaction/interactionChain.ts:50

removeInteraction

removeInteraction(interaction: AbstractInteraction): number
Removes an interaction from the chain, returning the index from which it was removed
Parameters
- interaction: AbstractInteraction
Returns number
- Defined in src/interaction/interactionChain.ts:40

setActive

setActive(active?: number | boolean): void
Sets the interaction active. Use boolean (true|false) to toggle default behavior. Pass it a bitmask of EventType to change the active state. Call without arguments to reset the default active, modification key and pointer Key behavior
Parameters
- Optionalactive: number | boolean
Returns void
Inherited from AbstractInteraction.setActive
- Defined in src/interaction/abstractInteraction.ts:156

setModification

setModification(): void
You cannot set the modification of an interaction chain, only of its containing interactions

Returns void
Overrides AbstractInteraction.setModification
- Defined in src/interaction/interactionChain.ts:82

setPointer

setPointer(): void
You cannot set the pointer of an interaction chain, only of its containing interactions

Returns void
Overrides AbstractInteraction.setPointer
- Defined in src/interaction/interactionChain.ts:89

Properties

active

active: EventType

The current active bitmask for EventType

chain

chain: AbstractInteraction[]

The interactions to handle one after the other

id

id: string

A unique identifier for this interaction

modificationKey

modificationKey: ModificationKeyType

The current active ModificationKeyType

pointerKey

pointerKey: PointerKeyType

The currently active PointerKeyType