NodePathAPI¶
Interface NodePathAPI
Hierarchy
- NodePathAPI
Methods
create Node Path Handles
- create
Node Path Handles(targets: number[]): Promise<NodePathHandle[]> -
createNodePathHandles Creates and returns handles for the target node ids or topology selectors.
Parameters
-
targets: number[]
{Array
} Array of target node ids to create the handles for
Returns Promise<NodePathHandle[]>
The array of handles
-
request Node Path Handle Map
- request
Node Path Handle Map(paths: string[], scope?: number): Promise<NodePathHandleMap> -
requestNodePathHandleMap Returns an object mapping from input paths to the respective handles.
Parameters
-
paths: string[]
{Array<string | NodePathHandle>} The array of node path strings or handles.
-
Optional
scope: number{number} [scope=0] nodeID specifying the scope as starting point for the paths
Returns Promise<NodePathHandleMap>
The resulting object mapping paths to handles
-
request Node Path Strings
- request
Node Path Strings(handles: NodePathHandle[], scope?: number, typePriorities?: NodePathFragmentType[]): Promise<string[]> -
requestNodePathStrings Returns string representations for the respective node path handles.
Parameters
-
handles: NodePathHandle[]
{Array
} -
Optional
scope: number{number} nodeID specifying the scope as starting point for the path resolution
-
Optional
typePriorities: NodePathFragmentType[]{Array
} Array of priorities to control the fragments for the path string assembly.
Returns Promise<string[]>
String representation of the node path for the respective scope.
-
NodeIDs are generated during runtime. There is no guarantee, that the nodeIDs of a loaded model are the same, if the 3D Space was reloaded in the browser.
The NodePathAPI allows the user to handle nodes with static identifiers, which are not changed during runtime. This holds, if the model resource is not changed.
Example