Class TreeNodeAbstract

Basic TreeNode interface for engine's graph.

Hierarchy (view full)

Constructors

constructor

Properties

_engine _id _isLoaded _parent

Accessors

engine id parent

Methods

add fixedStep load onCreate onFixedStep onLoad onStep onUnload remove step unload

Constructors

constructor

Properties

Protected_engine

_engine: Engine

Engine instance of the node's graph.

Protected_id

_id: string

Node's ID, generate it with nanoid if applicable.

Protected_isLoaded

_isLoaded: boolean

Get wether the node is loaded.

Protected_parent

_parent: Engine | TreeNode

Node's parent node, if root node, the parent node is replaced by the engine instance.

Accessors

engine

id

parent

Methods

Abstractadd

  • add(node): number

  • Adds a child node to the node children.

    This method needs to be implemented to throw an error if the node cannot have children (outer nodes).

    Parameters

    Returns number

    New children array length.

AbstractfixedStep

  • fixedStep(): void

  • Called at each fixed step of the loop by the parent node load method or the engine's step method directly.

    It calls the node's onFixedStep method. In the case of an inner node, this method will call the children's fixedStep methods too.

    Returns void

Abstractload

  • load(): void

  • Called at node loading in the scene graph.

    It calls the node's onLoad method. In the case of an inner node, this method will call the children's load methods too.

    Returns void

Protected AbstractonCreate

  • onCreate(): void

  • To execute on instance creation (in the node's constructor).

    This method is not called in the abstract TreeNode class constructor because it needs to be called after all members are initialized.

    We do not need a create method as this is an internal behavior of nodes.

    Returns void

Protected AbstractonFixedStep

Protected AbstractonLoad

Protected AbstractonStep

  • onStep(delta): void

  • To execute at each step of the loop.

    Parameters

    • delta: number

    Returns void

Protected AbstractonUnload

Abstractremove

  • remove(node): TreeNode

  • Removes a child node from the node children.

    This method needs to be implemented to throw an error if the node cannot have children (outer nodes).

    Parameters

    • node: TreeNode

      Node to remove of children.

    Returns TreeNode

    Removed node instance.

Abstractstep

  • step(delta): void

  • Called at each step of the loop by the parent node load method or the engine's step method directly.

    It calls the node's onStep method. In the case of an inner node, this method will call the children's step methods too.

    Parameters

    • delta: number

    Returns void

Abstractunload

  • unload(): void

  • Called at node unloading in the scene graph.

    It calls the node's onUnload method. In the case of an inner node, this method will call the children's unload methods too.

    Returns void

Settings

Member Visibility

On This Page

Constructors
Properties
Accessors
Methods