Provides script language access to C++ objects of this type.
| Class Hierarchy | Type » Node |
Function members are as follows:
| Return Type | Function Name | Documentation |
|---|---|---|
| int32 | AddEventHandler | Adds an event handler to an existing script event handler entry. |
| int32 | AddNodeLinkSink | Adds a <NodeSink> to this <Node> object's <NodeSink> array. |
| int32 | AddScript | Adds a script event handler entry to this <Node> object's NodeFunction set object. This is the top-level event handling element, and will later contain events and event handling functions that will be executed in order of appearance. |
| int32 | AttachObserver | Attaches an observer to the <Node>. |
| int32 | ChildIndex | Returns the child index of this <Node> if it has a parent. |
| int32 | ClearDependencies | Clears any pointer-based dependencies stored in a <Node>. |
| <Node> | Clone | Creates a deep copy of the <Node>. This expression allocates memory, so ownership of the <Node> must be transferred to the Model ( or deleted ) in order to avoid memory leaks. |
| <Node> | CloneLinkReferences | Clones a <Node> hierarchy for use in an external file. <NodeLink> nodes will be created for any dependencies which are not present in the cloned hierarchy, and the dependencies on those <Node> objects will be mapped to the newly created <NodeLink> nodes. |
| int32 | DetachObserver | Detaches an observer from the <Node>. |
| uint64 | GetAddress | Returns string containing this <Node> object's graph address. For example: /Root/GroupA/GroupB/NodeA |
| int32 | GetConnectedNodes | Populates a <NodeBuffer> object with all <Node> objects that this <Node> is connected to via NodeSinks. |
| <List> | GetDependencies | This member returns a <List> object containing the <Node> object's outgoing dependencies. |
| int32 | GetDistanceFromRoot | Returns the graph index of the specified <Node> relative to the specified <Group>. |
| int32 | GetEventHandlerCount | Returns the number of event handlers implemented for a specific event handling script. |
| int32 | GetEventHandlerDirection | Returns the direction of an event. This refers to the SPA_eNodeEventDirection enumeration. Please see TYPE_SERVICE_ENUMERATION_UTIL.SSL in the application scripts folder for more information. |
| string | GetEventHandlerEvent | Returns a string containing the registered event handler type such as SPA.OnNotify. |
| string | GetEventHandlerName | Returns a string containing the script function that implements the event handling behavior. |
| int32 | GetExtent | Returns the geometric extent of a <Node> along X, Y, and Z. |
| <Guid> | GetGuid | Returns a pointer to the <Node> object's GUID object. |
| <Model3D> | GetModel | Returns a pointer to the Model that the <Node> is attached to, or null if the <Node> is not attached to a Model. |
| <Str> | GetNameString | Returns a Str object that stores this <Node> object's name. |
| int32 | GetNodeLinkSinkCount | Returns the count of NodeSinks stored in this <Node> object's <NodeSink> array. |
| string | GetNodeLinkSinkNameByIndex | Returns a string containing the name of the <NodeSink> at the specified index. |
| <Node> | GetNodeLinkSinkNodeByIndex | Returns a pointer to the <Node> at the specified index, or a nullptr. |
| <Node> | GetNodeLinkSinkNodeByName | Returns a pointer to the <Node> associated with the specified <NodeSink> name. |
| TypeInformation | GetNodeLinkSinkTypeByIndex | Returns a <TypeInformation> pointer for the <NodeSink> at the specified index. |
| TypeInformation | GetNodeLinkSinkTypeByName | Returns a <TypeInformation> pointer for the <NodeSink> with the specified name, or nullptr. |
| int32 | GetNodeSelectors | Populates a <TypeBuffer> with pointers to any <NodeSelector> data members of this <Node>. Not all <Node> objects have <NodeSelector> object data members. The <List> object will remain empty in this case. |
| <Node> | GetParameters | Returns a pointer to the <Node> object's parameters <Group>. This feature can be used to connect a <Node> object to any other <Node> object in the document, the purpose of which is largely subject to each particular document, function, or command. |
| <Group> | GetParent | Returns a <Node> object's parent. |
| string | GetPathToNode | Returns a string containing the path of the <Node> in the scene graph. This is referred to as the graph address. The graph address can then be used to look up the <Node>, or to specify the PathToNode for a <NodeLink> that refers to this <Node>. |
| int32 | GetRefCount | Returns the ref count for the node. |
| <Node> | GetReference | Returns a pointer to this <Node>. |
| <Node> | GetReferenceType | Returns a <TypeInformation> pointer representing the type of this <Node>. |
| <List> | GetReferences | Returns a <List> object containing pointers to the <Node> object's references. Note that this <List> is allocated with 'new' and it is your responsibility to allocate it into an automatic destruction context ( such as auto List a_lNodes ) or to manually destroy the new <List> with delete. |
| int32 | GetScriptCount | Returns the count of top-level script event groups. |
| int32 | GetScriptFolder | Returns the value of the script folder used to resolve the file path of a scripted event handler. This refers to the ScriptFolderResolution enumeration. Please see TYPE_SERVICE_TYPE_SERVICE_ENUMERATION_UTIL.SSL for more information. |
| string | GetScriptPath | Returns the path of the top-level script that contains individual event handling functions. |
| int32 | IsInScopeOf | Returns true if the <Node> is in the same scope as the <Node> queried. |
| int32 | IsLastChild | Returns true if the <Node> is the last child in its parent object's child list, and false if it is not. |
| int32 | IsNodeObserver | Returns true if this <Node> object is observing the <Node> object submitted to this function. |
| int32 | IsParentTypeBinary | Returns true if the parent type matches either type submitted to this function. Subclasses constitute valid matches. |
| int32 | IsParentTypeUnary | Returns true if the parent type matches the type submitted to this function. Subclasses constitute valid matches. |
| int32 | ModelChanged | This option is undocumented at present. |
| int32 | OnNotify | This option is undocumented at present. |
| <Group> | Parent | Returns a pointer to a <Node> object's parent, or rarely, a nullptr. |
| int32 | Read | This option is undocumented at present. |
| int32 | RemoveEventHandler | Removes the individual event handler at the specified index. |
| int32 | RemoveNodeLinkSinkByIndex | Removes the <NodeLink> sink at the specified index. |
| int32 | RemoveNodeLinkSinkByName | Removes the <NodeLink> sink with the specified name. |
| int32 | RemoveScript | Removes a top-level event handling script, which may contain a set of registered event handler types and event handler functions. |
| int32 | Render | Renders a <Node> and its children to a rendering device, using rendering state information in the rendering context defined by a <<RenderInfo>> object. |
| int32 | RenderNode | Renders a single <Node> to a rendering device, using rendering state information in the rendering context defined by a <<RenderInfo>> object. Note that this function only renders the specified <Node> it does not render child nodes. |
| int32 | SetEventHandlerDirection | Sets the event handler direction. For example: Enum.NED_SendReceive(). This refers to the SPA_eNodeEventDirection enumeration. Please see TYPE_SERVICE_ENUMERATION_UTIL.SSL in the application scripts folder for more information. |
| int32 | SetEventHandlerEvent | Sets the event handler registered event name at the specified script index and at the specified event index. Must be a registered event type such as SPA.OnNotify. |
| int32 | SetEventHandlerName | Sets the name of the script function that executes the event handling job. |
| int32 | SetModel | Sets this <Node> object's Model pointer to the Model passed in to this function. |
| int32 | SetNodeLinkSinkNameByIndex | Sets the name of the <NodeLink> at the specified index. |
| int32 | SetNodeLinkSinkNameByName | Sets the name of the <NodeLink> at the index of the <NodeSink> with the specified name. |
| int32 | SetNodeLinkSinkNodeByIndex | Sets the <NodeLink> at the specified index to refer to the specified <Node>. |
| int32 | SetNodeLinkSinkNodeByName | Sets the <NodeLink> with the specified name to refer to the specified <Node>. |
| int32 | SetNodeLinkSinkTypeByIndex | Sets the <NodeSink> type at the specified index to the specified type. |
| int32 | SetNodeLinkSinkTypeByName | Sets the <NodeSink> with the specified name to the specified type. |
| int32 | SetParent | Sets a <Node> object's parent. |
| int32 | SetScriptFolder | Internal use only. Legacy feature provided for compatibility purposes only. |
| int32 | SetScriptPath | Sets the top level script path at the specified index. |
| int32 | Traverse | This option is undocumented at present. |
| string | UpdateName | Updates the <Node> object's name by calling the <Node> object's Node::UpdateName() method. Note that not all Node-derived types implement this method. |
| int32 | Write | This option is undocumented at present. |
Object members are as follows:
| Type Name | Accessor Name | Documentation |
|---|---|---|
| <NodeChangeSubject> | NodeChangeSubject | This option is undocumented at present. |
| <NodeList> | Temporaries | Returns a pointer to the <Node> object's temporary object <List>. This purpose of this <List> is generally implementation-defined. For example, while rendering a document, or during command execution, one may wish to temporarily store pointers to other nodes in the document, or use the <List> object's owning pointer facility to store nodes associated with a particular computation directly in this <List>. |
| string | Class | Gets or sets the <Node> object's CLASS parameter. |
| int32 | ExportDisabled | Gets or sets a value specifying whether or not the <Node> should be exported by terrain generation code or export code. This value is only a recommendation, export code is not required to honor it. |
| string | ID | Gets or sets the <Node> object's ID string value. |
| string | Name | Gets or sets the name of a <Node>. |
| int32 | ScriptFolder | Deprecated. Prefer the array version. GetScriptFolder and SetScriptFolder. |
| string | ScriptPath | Deprecated. Prefer the array version. GetScriptPath and SetScriptPath. |