Class EventDispatcher

Dispatches an event in 3 phases:

Trickle-down: the event descends the hierarchy, from the first interactable ancestor of the target to its parent
Target: the event is sent to the target
Bubble-up: the event ascends the hierarchy, from the target's parent to its first interactable ancestor

Index

Constructors

Properties

Methods

bubbleUp dispatch getInteractableAncestors invokeEvent stopPropagation target trickleDown

Constructors

constructor

new EventDispatcher(sceneObjectMap: SceneObjectMap): EventDispatcher
Parameters
- sceneObjectMap: SceneObjectMap
Returns EventDispatcher

Properties

`Private`sceneObjectMap

sceneObjectMap: SceneObjectMap

Methods

`Private`bubbleUp

bubbleUp(ancestors: Interactable[], eventArgs: StoppableEventArgs): void
Parameters
- ancestors: Interactable[]
- eventArgs: StoppableEventArgs
Returns void

dispatch

dispatch(eventArgs: DispatchableEventArgs): void
Triggers the event propagation
Parameters
- eventArgs: DispatchableEventArgs
  provides the interactor, the target and the callback name
Returns void

`Private`getInteractableAncestors

getInteractableAncestors(
    node: SceneObject,
    ancestors: Interactable[],
    excludedNode?: SceneObject,
): void
Parameters
- node: SceneObject
- ancestors: Interactable[]
- excludedNode: SceneObject = undefined
Returns void

`Private`invokeEvent

invokeEvent(event: InteractorEvent, eventName: InteractableEventName): void
Parameters
- event: InteractorEvent
- eventName: InteractableEventName
Returns void

`Private`stopPropagation

stopPropagation(eventArgs: StoppableEventArgs): void
Parameters
- eventArgs: StoppableEventArgs
Returns void

`Private`target

target(eventArgs: StoppableEventArgs): void
Parameters
- eventArgs: StoppableEventArgs
Returns void

`Private`trickleDown

trickleDown(ancestors: Interactable[], eventArgs: StoppableEventArgs): void
Parameters
- ancestors: Interactable[]
- eventArgs: StoppableEventArgs
Returns void