Methods
(async) create()
Called when the node is created.
- Source:
(async, generator) getAllDescendants() → {AsyncIterable.<NodeRef>}
Iterate through all children, grandchildren, and so forth of this node, recursively.
- Source:
Returns:
- Type
- AsyncIterable.<NodeRef>
(async) getCenter() → {Vector3}
Get the "center" property of this node.
- Source:
Returns:
- Type
- Vector3
(async, generator) getChildren() → {AsyncIterable.<NodeRef>}
Get all children of this node.
- Source:
Returns:
- Type
- AsyncIterable.<NodeRef>
(async, generator) getEdges() → {AsyncIterable.<DirEdgeRef>}
Get all edges connected to this node.
- Source:
Returns:
all the edges, with direction information from this node.
- Type
- AsyncIterable.<DirEdgeRef>
(async) getEffectiveCenter() → {Vector3}
Get the effective center property of this node --- where it is actually displayed.
- Source:
Returns:
- Type
- Vector3
(async) getLayer() → {Layer}
Get the layer of this node from the map backend layer registry.
Returns the default layer if no layer is specified.
- Source:
Returns:
- Type
- Layer
(async, generator) getNeighbors() → {AsyncIterable.<NodeRef>}
Get all neighbors of this node --- those nodes connected by edges to this node.
- Source:
Returns:
- Type
- AsyncIterable.<NodeRef>
(async) getNodeType() → {string}
Get the base type of this node. See backend getNodeType().
- Source:
Returns:
- Type
- string
(async) getParent() → {NodeRef|null}
Get the parent node of this node, if it exists.
- Source:
Returns:
The parent node, or null if there is no parent.
- Type
- NodeRef | null
(async) getRadius()
Get the radius of the node
- Source:
(async, generator) getSelfAndAllDescendants() → {AsyncIterable.<NodeRef>}
Iterate through all children, grandchildren, and so forth of this node, recursively. Includes this node itself.
- Source:
Returns:
- Type
- AsyncIterable.<NodeRef>
(async, generator) getSelfAndNeighbors() → {AsyncIterable.<NodeRef>}
Get all neighbors of this node --- those nodes connected by edges to this node. Includes this node.
- Source:
Returns:
- Type
- AsyncIterable.<NodeRef>
(async) getType() → {NodeType}
Get the type of this node from the map backend node type registry.
- Source:
Returns:
- Type
- NodeType
(async) hasChildren() → {boolean}
Check if this node has any children.
- Source:
Returns:
does this node have children?
- Type
- boolean
(async) setCenter(v)
Set the "center" property of this node.
Parameters:
| Name | Type | Description |
|---|---|---|
v |
Vector3 |
- Source:
(async) setEffectiveCenter(v)
Set the effective center property of this node --- where it is actually displayed.
Parameters:
| Name | Type | Description |
|---|---|---|
v |
Vector3 |
- Source:
(async) setLayer(layer)
Set the layer of this node.
Parameters:
| Name | Type | Description |
|---|---|---|
layer |
Layer |
- Source:
(async) setRadius()
Set the radius of the node.
- Source:
(async) setType(type)
Set the type of this node.
Parameters:
| Name | Type | Description |
|---|---|---|
type |
NodeType |
- Source: