sales@scenomics.com +1 650 396 9674

<RelationshipNode>

Implements storage related to node dependencies and references. For example, if a node refers to another node, or is referred to by another node, the <RelationshipNode> can store information about the nature of this relationship. Found in .DEP and .REF documents.

Registration

Class registration and implementation information is as follows:

Category Documentation
ImplementationC++
ModuleCore-App-Geometry
Class HierarchyNode » Group » RelationshipNode
Data Interface NameRelationshipNode
Type StatusActive
Is Final TypeYes

<RelationshipNode> Properties

Properties are as follows:

Property Documentation
Origination Type: NodeSinkSpecifies that the dependency is created by a <NodeSink>. This occurs when a node directly stores a link to another node in the same document.
Origination Type: NodeLinkSpecifies that the dependency is created by a <NodeLink>. This occurs when a node directly stores a link to a <NodeLink> in the same document. This <NodeLink> may refer to a node in the same document or to a node in an external document.
Origination Type: NodeSelectorSpecifies that the dependency is created by a <NodeSelector>. This occurs when a node stores a link to a node in another document via a <NodeSelector>. A <NodeSelector> stores a <NodeLink> internally.
Origination Type: File PathSpecifies that the dependency is created by a file path. This occurs when a node stores a link to a file on the disk.
Origination Type: SelfSpecifies that the dependency is inherent to some property of the node.
Source Folder Resolution: NoneDo not resolve the file path set by this node.
Source Folder Resolution: Application Binaries PathResolve the file path set by this node relative to the application binaries directory.
Source Folder Resolution: Application Data PathResolve the file path set by this node relative to the application data directory.
Source Folder Resolution: Application Documents PathResolve the file path set by this node relative to the application documents directory.
Source Folder Resolution: Current Document PathResolve the file path set by this node relative to the document that contains this node.
Source Folder Resolution: Application Scripts PathResolve the file path set by this node relative to the application scripts path.
Source Folder Resolution: User Scripts PathResolve the file path set by this node relative to the user scripts path.
Source File PathThe absolute or relative file path to the file in which the dependency originates.
Source Node PathThe absolute or relative document path to the node in which the dependency originates.
Source Node GuidThe GUID of the node in which the dependency originates.
Source Node TypeA string representing the type of node in which the dependency originates.
Source Node PositionAn int32 that represents the absolute graph position of the node, as if the graph were not nested at all. This would be the index of the node if every node in the document were stored in an array.
Destination Folder Resolution: NoneDo not resolve the file path set by this node.
Destination Folder Resolution: Application Binaries PathResolve the file path set by this node relative to the application binaries directory.
Destination Folder Resolution: Application Data PathResolve the file path set by this node relative to the application data directory.
Destination Folder Resolution: Application Documents PathResolve the file path set by this node relative to the application documents directory.
Destination Folder Resolution: Current Document PathResolve the file path set by this node relative to the document that contains this node.
Destination Folder Resolution: Application Scripts PathResolve the file path set by this node relative to the application scripts path.
Destination Folder Resolution: User Scripts PathResolve the file path set by this node relative to the user scripts path.
Destination File PathThe absolute or relative file path to the file in which the dependency originates.
Destination Node PathThe absolute or relative document path to the node in which the dependency originates.
Destination Node GuidThe GUID of the node in which the dependency originates.
Destination Node TypeA string representing the type of node in which the dependency originates.
Destination Node PositionAn int32 that represents the absolute graph position of the node, as if the graph were not nested at all. This would be the index of the node if every node in the document were stored in an array.

<Group> Properties

Properties are as follows:

Property Documentation
VisibleToggles the <Group>'s visible/invisible". Child nodes are not visible when their parent <Group>'s is invisible.
CollisionsToggles collision detection on the <Group> node and its children". This is used for runtime export and has no effect in Scenome applications.
CullToggles view volume culling on/off". modifying this parameter may cause incorrect culling and other unexpected consequences.
Preserve CameraThis option is undocumented at present.
Generic Data SourceThis option provides the capability to connect a <Group>'s to a node that serves as a generic data source.
Bounding Box FrozenFreezes the bounding box at its current size. This is often used as a runtime flag, and modifying this parameter may cause incorrect culling.
Minimum XDisplays the minimum bounding box coordinate on the X axis.
Minimum YDisplays the minimum bounding box coordinate on the Y axis.
Minimum ZDisplays the minimum bounding box coordinate on the Z axis.
Maximum XDisplays the maximum bounding box coordinate on the X axis.
Maximum YDisplays the maximum bounding box coordinate on the Y axis.
Maximum ZDisplays the maximum bounding box coordinate on the Z axis.
Transform LockedLocks the node and prevents transformation of the node and its children. This is a runtime flag and has no effect in Scenome applications.
Position XDisplays the node's position on the X axis.
Position YDisplays the node's position on the Y axis.
Position ZDisplays the node's position on the Z axis.
Orientation XDisplays the node's orientation on the X axis.
Orientation YDisplays the node's orientation on the Y axis.
Orientation ZDisplays the node's orientation on the Z axis.
Scale XDisplays the node's scale on the X axis.
Scale YDisplays the node's scale on the Y axis.
Scale ZDisplays the node's scale on the Z axis.
BillboardSets the node as a billboard. Billboards rotate to face the camera. This feature has been preserved for compatibility purposes, but this functionality should be implemented with geometry shaders.

<Node> Properties

Properties are as follows:

Property Documentation
NameSets the name of the node. Do not use / or \ [forward slash and backslash] in the node name as this produces conflicts with resolving link nodes that reference external files.
ClassSets the class of the node.
IDSets the ID of the node. This must be unique for each document, but different documents can use the same ID.
Export DisabledDetermines whether or not the node is exported during an export process, or possibly other purposes.
GuidEnumerates the Node's GUID.