<NodeLink> Data Interface

Provides script language access to C++ objects of this type.

Class HierarchyType » Node » Group » NodeLink

Function Members

Function members are as follows:

Return Type Function Name Documentation
int32FlushRefreshes the entire set of references associated with this <NodeLink>.
int32GetLinkUndocumented.
<Model3D>GetModelReturns the Model object pointed at by a <NodeLink>.
<Guid>GetNodeGuidReturns a pointer to the <NodeLink> object's target <Node> GUID object.
int32IsConnectedReturns true if the <NodeLink> is connected to a <Node> of the specified type.
int32IsExternalDetermines if the <Node> object referenced by the <NodeLink> is external or not. A non-zero result specifies that the <Node> object is external.
int32IsInternalReturns true if the <Node> object reference by the <NodeLink> is not external.
int32IsTypeOfReturns true if the <NodeLink> object's <Type> specification matches the specified type.
int32LoadForces a load operation on the <Node> referenced by the <NodeLink>. If the link is external, the Wait parameter can be used to specify that the caller does not want this function to return until the <Node> has been loaded or an error occurred.
stringResolvePathToFileResolves a relative path to an absolute path.

Object Members

Object members are as follows:

Type Name Accessor Name Documentation
<DataCaptureList>DataCaptureListReturns a pointer to the <DataCaptureList> object. This object stores <DataCapture> objects that are 'nested' inside. For example: A <DataCapture> object may be stored in a <VariableNode> representing an array, such as <Float32ArrayNode>, and <DataCapture> sub-objects stored in this <DataCaptureList> may set individual array values.
TypeInformationLinkTypeReturns the type of the <NodeLink> target.
int32LoadUniqueGets or sets the Load Unique flag, which determines if the underlying .BOX file is loaded into the ModelCache as a unique object. If this flag is false, the underlying .BOX file will only be loaded into the ModelCache once.
<Node>NodeGets or sets the <Node> pointed at by a <NodeLink>
stringPathToFileReturns the file pointed at by the <NodeLink>.
stringPathToNodeReturns the document path specified in the <NodeLink>.