SceneNodeList

Represents the children of a scenenode. Typically accessed via the SceneNode.children property.

This is not an Array, so you must use at(i) instead of [i] to access children by index. It has a number of Array-like methods such as forEach for convenience, however.

Ordered from lowest z order to highest.

Kind: class

Example

let node = ...;
console.log("Node has " + node.children.length + " children");
console.log("First child: " + node.children.at(0));  // do not use `[0]` - it will not work!
node.children.forEach(function (childNode, i) {
    ...
});

See: SceneNode.children


sceneNodeList.length : number

Number of children in the list.

Kind: instance property of SceneNodeList
Read only: true


sceneNodeList.forEach(callback, thisArg) ⇒ void

Iterate all children in the list.

Kind: instance method of SceneNodeList

Param Type Description
callback !function(!SceneNode, number) Callback, passed each child node and its index.
thisArg ?Object Optional value for this when executing the callback.

sceneNodeList.forEachRight(callback, thisArg) ⇒ void

Iterate all children in the list, in reverse order (highest z order to lowest).

Kind: instance method of SceneNodeList

Param Type Description
callback !function(!SceneNode, number) Callback, passed each child node and its index.
thisArg ?Object Optional value for this when executing the callback.

sceneNodeList.filter(callback, thisArg) ⇒ Array.<!SceneNode>

Iterates all children and returns an array of just the children that passed the filter function's test.

Kind: instance method of SceneNodeList

Param Type Description
callback !function(!SceneNode, number): boolean Filter function, passed each child node and its index.
thisArg ?Object Optional value for this when executing the callback.

sceneNodeList.map(callback, thisArg) ⇒ Array.<*>

Iterates all children and returns an array of the map function's result value for each child node.

Kind: instance method of SceneNodeList

Param Type Description
callback !function(!SceneNode, number): * Map function, passed each child node and its index.
thisArg ?Object Optional value for this when executing the callback.

sceneNodeList.some(callback, thisArg) ⇒ boolean

Iterates children until the test returns true for at least one child.

Kind: instance method of SceneNodeList
Returns: boolean - True if the test function returned true for at least one child.

Param Type Description
callback !function(!SceneNode, number): boolean Test function, passed each child node and its index.
thisArg ?Object Optional value for this when executing the callback.

sceneNodeList.at() ⇒ SceneNode

Kind: instance method of SceneNodeList
Returns: ?SceneNode - Child node at the specified index in the list, or null if index is out of bounds.

Param Type
index number

results matching ""

    No results matching ""