Class AbstractInteraction

constructor

• new AbstractInteraction(defaultActive?, defaultModificationKey?, defaultPointerKey?): AbstractInteraction

• Parameters

  • Optional defaultActive: EventType = EventType.NONE

    A bitmask representing the default to listen to

  • Optional defaultModificationKey: ModificationKeyType = ModificationKeyType.NONE

    A bitmask representing the default keys to listen to

  • Optional defaultPointerKey: PointerKeyType = PointerKeyType.LEFT

    A bitmask representing the pointer key to listen to

  Returns AbstractInteraction

destroy

• destroy(): void

• destroys the implementation, removing any created resources

  Returns void

modifierChanged

• modifierChanged(_modifier): void

• Called when the modifier keys have changed.

  Parameters

  • _modifier: ModificationKeyType

  Returns void

pipe

• pipe(event): Promise<InteractionEvent>

• Main function, called when an event is raised for this interaction

  Parameters

  • event: InteractionEvent

  Returns Promise<InteractionEvent>

setActive

• setActive(active?): 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

  • Optional active: number | boolean

  Returns void

setModification

• setModification(mod?): void

• Sets the modification key to listen to or the default modification key if none is provided.

  Parameters

  • Optional mod: ModificationKeyType

  Returns void

setPointer

• setPointer(pointer?): void

• Sets the pointer key for this interaction or the default pointer if none is provided.

  Parameters

  • Optional pointer: PointerKeyType

  Returns void

active

id

modificationKey

pointerKey