Class Graph

Readonly appendChild

Readonly mtxWorld

nNodesInBranch

name

radius

timestampUpdate

cmpTransform

• get cmpTransform(): ComponentTransform

• Shortcut to retrieve this nodes ComponentTransform

  Returns ComponentTransform

isActive

• get isActive(): boolean

• Returns boolean

mtxLocal

• get mtxLocal(): Matrix4x4

• Shortcut to retrieve the local Matrix4x4 attached to this nodes ComponentTransform
  Fails if no ComponentTransform is attached

  Returns Matrix4x4

mtxWorldInverse

• get mtxWorldInverse(): Matrix4x4

• Returns Matrix4x4

nChildren

• get nChildren(): number

• Returns the number of children attached to this

  Returns number

[iterator]

• [iterator](): IterableIterator<Node>

• Returns an iterator over this node and all its descendants in the graph below

  Returns IterableIterator<Node>

activate

• activate(_on): void

• De- / Activate this node. Inactive nodes will not be processed by the renderer.

  Parameters

  • _on: boolean

  Returns void

addChild

• addChild(_child): void

• Adds the given reference to a node to the list of children, if not already in

  Parameters

  • _child: Node

  Returns void

  Throws

  Error when trying to add an ancestor of this

• addChild(_child, _index): void

• Adds the given reference to a node to the list of children at the given index. If it is already a child, it is moved to the new position.

  Parameters

  • _child: Node
  • _index: number

  Returns void

addComponent

• addComponent(_component): void

• Attach the given component to this node

  Parameters

  • _component: Component

  Returns void

addEventListener

• addEventListener(_type, _handler, _capture?): void

• Adds an event listener to the node. The given handler will be called when a matching event is passed to the node. Deviating from the standard EventTarget, here the _handler must be a function and _capture is the only option.

  Parameters

  • _type: string
  • _handler: EventListenerUnified
  • _capture: boolean = false

  Returns void

applyAnimation

• applyAnimation(_mutator): void

• Applies a Mutator from Animation to all its components and transfers it to its children.

  Parameters

  • _mutator: Mutator

  Returns void

attach

• attach(_component): void

• Attach the given component to this node. Identical to addComponent

  Parameters

  • _component: Component

  Returns void

broadcastEvent

• broadcastEvent(_event): void

• Broadcasts a synthetic event to this node and from there to all nodes deeper in the hierarchy, invoking matching handlers of the nodes listening to the capture phase. Watch performance when there are many nodes involved

  Parameters

  • _event: Event

  Returns void

detach

• detach(_component): void

• Detach the given component from this node. Identical to removeComponent

  Parameters

  • _component: Component

  Returns void

dispatchEvent

• dispatchEvent(_event): boolean

• Dispatches a synthetic event to target. This implementation always returns true (standard: return true only if either event's cancelable attribute value is false or its preventDefault() method was not invoked) The event travels into the hierarchy to this node dispatching the event, invoking matching handlers of the nodes ancestors listening to the capture phase, than the matching handler of the target node in the target phase, and back out of the hierarchy in the bubbling phase, invoking appropriate handlers of the anvestors

  Parameters

  • _event: Event

  Returns boolean

dispatchEventToTargetOnly

• dispatchEventToTargetOnly(_event): boolean

• Dispatches a synthetic event to target without travelling through the graph hierarchy neither during capture nor bubbling phase

  Parameters

  • _event: Event

  Returns boolean

findChild

• findChild(_search): number

• Returns the position of the node in the list of children or -1 if not found

  Parameters

  • _search: Node

  Returns number

getAllComponents

• getAllComponents(): Component[]

• Returns a list of all components attached to this node, independent of type.

  Returns Component[]

getAncestor

• getAncestor(): Node

• Traces back the ancestors of this node and returns the first

  Returns Node

getChild

• getChild(_index): Node

• Returns child at the given index in the list of children

  Parameters

  • _index: number

  Returns Node

getChildren

• getChildren(): Node[]

• Returns a clone of the list of children

  Returns Node[]

getChildrenByName

• getChildrenByName(_name): Node[]

• Returns an array of references to childnodes with the supplied name.

  Parameters

  • _name: string

  Returns Node[]

getComponent

• getComponent<T>(_class): T

• Returns the first compontent found of the given class attached this node or null, if list is empty or doesn't exist

  Type Parameters

  • T extends Component

  Parameters

  • _class: (new () => T)
    • • new (): T

      • Returns T

  Returns T

getComponents

• getComponents<T>(_class): T[]

• Returns a clone of the list of components of the given class attached to this node.

  Type Parameters

  • T extends Component

  Parameters

  • _class: (new () => T)
    • • new (): T

      • Returns T

  Returns T[]

getIterator

• getIterator(_active?): IterableIterator<Node>

• Generator yielding the node and all decendants in the graph below for iteration Inactive nodes and their descendants can be filtered

  Parameters

  • _active: boolean = false

  Returns IterableIterator<Node>

getParent

• getParent(): Node

• Returns a reference to this nodes parent node

  Returns Node

getPath

• getPath(): Node[]

• Traces the hierarchy upwards to the first ancestor and returns the path through the graph to this node

  Returns Node[]

isDescendantOf

• isDescendantOf(_ancestor): boolean

• Returns true if this node is a descendant of the given node, directly or indirectly, else false

  Parameters

  • _ancestor: Node

  Returns boolean

isUpdated

• isUpdated(_timestampUpdate): boolean

• Returns true if the given timestamp matches the last update timestamp this node underwent, else false

  Parameters

  • _timestampUpdate: number

  Returns boolean

removeAllChildren

• removeAllChildren(): void

• Removes all references in the list of children

  Returns void

removeChild

• removeChild(_child): void

• Removes the reference to the give node from the list of children

  Parameters

  • _child: Node

  Returns void

removeComponent

• removeComponent(_component): void

• Removes the given component from the node, if it was attached, and sets its parent to null.

  Parameters

  • _component: Component

  Returns void

removeComponents

• removeComponents(_class): void

• Removes all components of the given class attached to this node.

  Parameters

  • _class: (new () => Component)
    • • new (): Component

      • Returns Component

  Returns void

removeEventListener

• removeEventListener(_type, _handler, _capture?): void

• Removes an event listener from the node. The signature must match the one used with addEventListener

  Parameters

  • _type: string
  • _handler: EventListenerUnified
  • _capture: boolean = false

  Returns void

replaceChild

• replaceChild(_replace, _with): boolean

• Replaces a child node with another, preserving the position in the list of children

  Parameters

  • _replace: Node
  • _with: Node

  Returns boolean

toHierarchyString

• toHierarchyString(_node?, _level?): string

• Creates a string as representation of this node and its descendants

  Parameters

  • _node: Node = null
  • _level: number = 0

  Returns string

toString

• toString(): string

• Returns string

Static FIND

• FIND<T>(_from, _path): T

• Return the Node or Component found at the given path starting from the given node or undefined if not found

  Type Parameters

  • T = Node | Component

  Parameters

  • _from: Node | Component
  • _path: string

  Returns T

Static PATH_FROM_TO

• PATH_FROM_TO(_from, _to): string

• Return the mutator-like path string to get from one node to another or null if no path is found e.g.:

  "node/parent/children/1/components/ComponentSkeleton/0"
  Copy

  Parameters

  • _from: Node | Component
  • _to: Node | Component

  Returns string