Base class for objects that can participate in a transform hierarchy.

More...

Inherits :

• QObject
  • DzBase
    • DzElement

Inherited By : DzBone, DzCamera, DzDForm, DzDFormBase, DzDFormZone, DzGeometryShellNode, DzGroupNode, DzInstanceNode, measuremetricsnode_dz and DzSkeleton

DzNode objects all contain animatable position, rotation, and scale channels that can be set and accessed via the properties list in the DzElement class or through specialized calls in this class.

The transform order is Translate/Rotate/Scale. Non-uniform scaling is supported by implementing seperate X, Y, and Z scale channels. All channels are independent internally and can have keys set on them independent of any other channel.

Note that channel independence holds exactly true for translations and scales, but does not hold for rotations (which are represented as Euler angle degrees in each channel). Euler angles are inherently inter-dependent and prone to numerical singularities (gimbals) that make them less than perfect at representing rotations. For this reason, rotations are handled as DzQuat objects whenever possible. When setting keys on a DzNode, it is prefferable to use the set*Rot() methods or set*Transform() methods that take DzQuat arguments. Setting rotations as a DzQuat will create keys on all three rotation channels but will assure that the values are reasonable.

Nodes have an origin and an orientation that define their default state. The origin is the center point of the node and is given in untransformed world space. In other words, the origin is the center point of the node in relation to its untransformed and undeformed geometry. The orientation of the node defines the space in which this node's rotations occur. Orientation only has an effect on the rotation of the node, it does not affect translation or scale transforms.

Each node defines a local axis that is determined by evaluating the transforms of all nodes in the parent tree for this node in order.

Several functions are provided for accessing the transformation data of a node. Below are descriptions of the groups of functions, and the transform space that they return data for.

• World Space Transforms:getWSTransform(), getWSPos(), getWSRot(), getWSScale() WS (world space) transforms are just that - the transformation of the node into world space, including keyed transformation data. These functions essentially traverse up the hierarchy evaluating the local transforms for each parent node, resulting in the final World Space transform of the node.

• Local Transforms:getLocalTransform(), getLocalPos(), getLocalRot(), getLocalScale() Local transforms are the full transformation of the node in the space of its immediate parent - for root nodes, the nodes origin added to the local pos is equivalent to the worldspace transform.

Classes derived from DzNode may also be drawn in the interactive 3D views (via the draw() method) or/and may be rendered using a RenderMan- compliant renderer (via the render() method).

---

DzAuthor : assetAuthor

The author of the file for this node. (Read Only)

Since:

• 4.8.1.21

---

DzVersion : assetFileRevision

The revision version of the asset file for this node. (Read Only)

Since:

• 4.8.1.21

---

String : assetId

The asset id for this node.

Since:

• 4.8.1.18

---

Array : assetIdAliases

The asset id aliases for this node.

---

Date : assetModifiedDate

The modified date of the asset file for this node. (Read Only)

Since:

• 4.8.1.21

---

DzUri : assetSource

The URI of the asset source for this node; only valid when the asset is in an embedded state - i.e. modified. (Read Only)

Since:

• 4.8.1.21

---

DzUri : assetUri

The asset URI for this node. (Read Only)

Since:

• 4.8.1.18

---

Array : nameAliases

The name aliases for this node.

---

DzRenderMgr::RenderPriority : renderPriority

The render priority for the node. Render priority controls the order in which nodes are rendered. The higher the priority, the earlier the node will be rendered. If several nodes have the same render priority, those nodes will be rendered in an arbitrary order.

The default render priority is RENDER_PRIORITY_NORMAL.

---

DzNode : duplicate( DzNode node, Boolean propagate )

---

DzNode()

Default Constructor.

---

DzError : addNodeChild( DzNode child, Boolean inPlace=false )

Adds a child to this node.

Parameter(s):

• child - The node to add to this node's list of children. A child must be removed from one parent before it can be attached to another.
• inPlace - If true, the necessary transforms to parent 'In Place' will be calculated and applied to the child.

---

void : adjustEndPoint( DzVec3 endPnt )

Sets the end point for this node adjusting for controllers.

Parameter(s):

• endPnt - The end point for the node. This is the node's end point in relation to its geometry.

---

void : adjustOrientation( DzQuat orientation )

Sets the orientation for the node adjusting for controllers.

Parameter(s):

• orientation - The orientation for the node. This defines the space in which node rotations occur.

---

void : adjustOrientationAngles( DzVec3 angles )

Sets the orientation for the node adjusting for controllers.

Parameter(s):

• angles - The orientation for the node in degrees. This defines the space in which node rotations occur.

---

void : adjustOrigin( DzVec3 origin )

Sets the origin for the node adjusting for controllers.

Parameter(s):

• origin - The origin for the node. This is the node's center point in relation to its geometry.

---

Boolean : castsShadow()

Get the current shadow-casting status of this node.

Return Value:

• true if the node is casting shadows or the active mode of the active renderer does not allow disabling shadows (and thus dynamically hides the property providing control to the user), otherwise false.

---

void : clearAllTransformData()

Removes all local transform data.

---

void : clearManipOverColor()

Clears the override color to be used to draw the node while using manipulation draw styles.

---

void : clearTransformData( DzTimeRange range )

Removes local transform data.

Parameter(s):

• range - The timerange to clear transform data across.

---

DzNode : duplicate( Boolean propagate )

Parameter(s):

• propagate - If true, the hierarchy of nodes that are children of this node will also be duplicated.

Return Value:

• The (root) node (if any) that results from duplicating this node, otherwise null.

Since:

• 4.9.3.80

---

void : finalize( Boolean isRender=false, Boolean allowResChange=true )

Finalizes the node's geometry cache.

Parameter(s):

• isRender - If true, the geometry cache will be finalized for a render operation, otherwise, the geometry will be prepared for a drawing operation.
• allowResChange - If true, the geometry is allowed to change resolution in the finalize. otherwise, the geometry will stay at it's current resolution.

---

Number : findChildIndex( DzNode curNode )

Parameter(s):

• curNode - The node to find the index of.

Return Value:

• The index of curNode (if any), otherwise -1.

---

DzNode : findNodeChild( String name, Boolean recurse=false )

Get a child from this node by name.

Parameter(s):

• name - The name of the child to find.
• recurse - If true, this will be called recursively until a child with a matching name is found.

Return Value:

• A child node having a matching name (if any), otherwise NULL.

---

DzNode : findNodeChildByAssetID( String assetID, Boolean recurse=false, Boolean checkSource=true )

Get a child from this node by asset id.

Parameter(s):

• assetID - The asset ID of the child to find.
• recurse - If true, this will be called recursively until a child with a matching asset ID is found.
• checkSource - If true, the asset's source will be checked for a match.

Return Value:

• A child node having a matching asset ID (if any), otherwise NULL.

---

DzNode : findNodeChildByLabel( String label, Boolean recurse=false )

Get a child from this node by label.

Parameter(s):

• label - The label of the child to find.
• recurse - If true, this will be called recursively until a child with a matching label is found.

Return Value:

• A child node having a matching label (if any), otherwise NULL.

Since:

• 4.10.0.68

---

DzNode : findNodeChildByNameOrAlias( String name, Boolean alaises, Boolean recurse=false )

Get a child from this node by name (or alias).

Parameter(s):

• name - The name (or alias) of the child to find.
• aliases - If true, consider name aliases.
• recurse - If true, this will be called recursively until a child with a matching name (or alias) is found.

Return Value:

• A child node having a matching name or alias (if any), otherwise NULL.

---

DzProperty : findPropertyReference( DzUri uri )

Parameter(s):

• uri - The URI path to the property.

Return Value:

• The property referred to by the uri or null if the property cannot be found.

Since:

• 4.9.2.20

---

DzBoolProperty : getDisableTransfromControl()

Return Value:

• The property used for controlling if the node's transfrom is disabled.

Since:

• 4.9.2.11

---

DzVec3 : getEndPoint( Boolean defaultVal=false )

Parameter(s):

• defaultVal - If true, the default value for the end point is returned, otherwise the current value is.

Return Value:

• The endpoint for this node.

---

DzFloatProperty : getEndXControl()

Return Value:

• The float property that controls the x position of the node's end point.

---

DzFloatProperty : getEndYControl()

Return Value:

• The float property that controls the y position of the node's end point.

---

DzFloatProperty : getEndZControl()

Return Value:

• The float property that controls the z position of the node's end point.

---

DzFloatProperty : getFirstAxisRotControl()

Return Value:

• The float property that controls local rotation of the node around the first axis of the rotation order.

Since:

• 4.9.3.17

---

DzBox3 : getLocalBoundingBox()

Calculate the local space bounding box for this node.

Return Value:

• A box containing the current node (including an attached object) in the local space of the node.

---

DzOrientedBox3 : getLocalOrientedBox()

Calculate the local space bounding box for this node.

Return Value:

• A box containing the current node (including an attached object) in the local space of the node.

---

DzVec3 : getLocalPos()

Return Value:

• The local-space position of the node at the current time.

---

DzVec3 : getLocalPos( DzTime tm, Boolean defaultVal=false )

Parameter(s):

• tm - The scene time at which to get the the transform.
• defaultVal - Use the default version of the origin, end point, and orientation instead of the current position.

Return Value:

• The local-space position of the node.

---

DzQuat : getLocalRot()

Return Value:

• The local-space rotation of the node at the current time.

---

DzQuat : getLocalRot( DzTime tm, Boolean defaultVal=false )

Parameter(s):

• tm - The scene time at which to get the the transform.
• defaultVal - Use the default version of the origin, end point, and orientation instead of the current position.

Return Value:

• The local-space rotation of the node.

---

DzMatrix3 : getLocalScale()

Return Value:

• The local-space scale of the node at the time.

---

DzMatrix3 : getLocalScale( DzTime tm, Boolean defaultVal=false )

Parameter(s):

• tm - The scene time at which to get the the transform.
• defaultVal - Use the default version of the origin, end point, and orientation instead of the current position.

Return Value:

• The local-space scale of the node.

---

DzMatrix3 : getLocalTransform()

Get the composed local transform info for this node at the current time.

Return Value:

• A matrix representing the composed local transform for this node.

---

DzMatrix3 : getLocalTransform( DzTime tm, Boolean defaultVal=false )

Get the composed local transform info for this node.

Parameter(s):

• tm - The scene time at which to get the the transform.
• defaultVal - Use the default version of the origin, end point, and orientation instead of the current position.

Return Value:

• A matrix representing the composed local transform for this node.

---

DzNode : getNodeChild( Number i )

Get the child at the given index.

Return Value:

• The i'th node attached to this node as a child. NULL if the index is invalid.

---

Array : getNodeChildren( Boolean recurse=false )

Parameter(s):

• recurse - If true, recursively collect all this node's children, scanning the hierarchy from this node down. If false (default), collect only this node's immediate children.

Return Value:

• A list containing the children of this node.

---

DzNode : getNodeParent()

Get the parent of this node.

Return Value:

• The parent of this node in the scene hierarchy, NULL if this node is at root level.

---

Number : getNumNodeChildren()

Get the number of children attached to this node.

Return Value:

• The number of nodes attached to this node as children in the scene hierarchy.

---

DzObject : getObject()

Get the object currently associated with this node.

Return Value:

• The object that is associated with this node. NULL if node has no object.

---

DzQuat : getOrientation( Boolean defaultVal=false )

Parameter(s):

• defaultVal - Get the default or current values of the orientation. defaultVal defaults to false or current position.

Return Value:

• The orientation of the node.

---

DzFloatProperty : getOrientXControl()

Return Value:

• The float property that controls the x rotation of the node's orientation.

---

DzFloatProperty : getOrientYControl()

Return Value:

• The float property that controls the y rotation of the node's orientation.

---

DzFloatProperty : getOrientZControl()

Return Value:

• The float property that controls the z rotation of the node's orientation.

---

DzVec3 : getOrigin( Boolean defaultVal=false )

Parameter(s):

• defaultVal - Get the default or current values of the origin. Default is false for current.

Return Value:

• The origin of the node.

---

DzFloatProperty : getOriginXControl()

Return Value:

• The float property that controls the x position of the node's origin.

---

DzFloatProperty : getOriginYControl()

Return Value:

• The float property that controls the y position of the node's origin.

---

DzFloatProperty : getOriginZControl()

Return Value:

• The float property that controls the z position of the node's origin.

---

DzNumericNodeProperty : getPointAtControl()

Return Value:

• The property used for tracking the point-at target.

---

DzPresentation : getPresentation()

Return Value:

• The presentation for this property or NULL if there is none.

---

DzOrientedBox3 : getPreviewBox()

Get the local-space preview box for this node, if any.

Return Value:

• The preview box for this node, or an invalid box if none has been set.

---

DzEnumProperty : getRenderPriorityControl()

Return Value:

• The enum property that controls the render priority of this node.

---

DzBoolProperty : getRenderVisibilityControl()

Return Value:

• The boolean property that controls render visibility of this node.

---

DzRotationOrder : getRotationOrder()

Get the node rotation order.

Return Value:

• The order that the axis rotations are applied to this node.

---

DzFloatProperty : getScaleControl()

Return Value:

• The float property that controls general scale of the node.

---

DzFloatProperty : getSecondAxisRotControl()

Return Value:

• The float property that controls local rotation of the node around the second axis of the rotation order.

Since:

• 4.9.3.17

---

DzBoolProperty : getSelectabilityControl()

Return Value:

• The boolean property that controls selectability of this node.

---

DzSelectionMap : getSelectionMap()

Return Value:

• The selection map for this node.

---

DzNode : getSelectionNode()

Return Value:

• The node to be selected if selection is promoted, otherwise this node.

---

DzBoolProperty : getShadowControl()

Return Value:

• The boolean property that controls whether this light is casting shadows.

---

DzBoolProperty : getSimulationVisibilityControl()

Return Value:

• The boolean property that controls simulation visibility of this node.

Since:

• 4.9.4.25

---

DzSkeleton : getSkeleton()

Traverse up the hierarchy and attempt to find a DzSkeleton.

Return Value:

• The first DzSkeleton node encountered. NULL if this node is not in the hierarchy of a skeleton.

---

DzFloatProperty : getThirdAxisRotControl()

Return Value:

• The float property that controls local rotation of the node around the third axis of the rotation order.

Since:

• 4.9.3.17

---

DzFloatProperty : getToolFirstAxisRotControl()

Return Value:

• The float property that tools should use to control local rotation of the node around the first axis of the rotation order.

Since:

• 4.9.3.17

---

DzQuat : getToolLocalRot()

Return Value:

• The local-space rotation of the node at the current time, in the context of the current tool.

Since:

• 4.9.3.16

---

DzQuat : getToolLocalRot( DzTime tm, Boolean defaultVal=false )

Parameter(s):

• tm - The scene time at which to get the the transform.
• defaultVal - Use the default version of the origin, end point, and orientation instead of the current position.

Return Value:

• The local-space rotation of the node, in the context of the current tool.

Since:

• 4.8.1.13

---

DzFloatProperty : getToolSecondAxisRotControl()

Return Value:

• The float property that tools should use to control local rotation of the node around the second axis of the rotation order.

Since:

• 4.9.3.17

---

DzFloatProperty : getToolThirdAxisRotControl()

Return Value:

• The float property that tools should use to control local rotation of the node around the third axis of the rotation order.

Since:

• 4.9.3.17

---

DzQuat : getToolWSRot()

Return Value:

• The world-space rotation of the node at the current time, in the context of the current tool.

Since:

• 4.9.3.16

---

DzQuat : getToolWSRot( DzTime tm, Boolean defaultVal=false )

Parameter(s):

• tm - The scene time at which to get the the transform.
• defaultVal - Use the default version of the origin, end point, and orientation instead of the current position.

Return Value:

• The world-space rotation of the node, in the context of the current tool.

Since:

• 4.8.1.13

---

DzMatrix3 : getToolWSTransform()

Get the world-space transformation data for this node at the current time, in the context of the current tool.

Return Value:

• A matrix representing the composed WS transform for this node.

Since:

• 4.9.3.16

---

DzMatrix3 : getToolWSTransform( DzTime tm, Boolean defaultVal=false )

Get the world-space transformation data for this node, in the context of the current tool.

Parameter(s):

• tm - The scene time at which to get the the transform.
• defaultVal - Use the default version of the origin, end point, and orientation instead of the current position.

Return Value:

• A matrix representing the composed WS transform for this node.

Since:

• 4.8.1.13

---

DzFloatProperty : getToolXRotControl()

Return Value:

• The float property that tools should use to control local rotation of the node around the x axis.

---

DzFloatProperty : getToolYRotControl()

Return Value:

• The float property that tools should use to control local rotation of the node around the y axis.

---

DzFloatProperty : getToolZRotControl()

Return Value:

• The float property that tools should use to control local rotation of the node around the z axis.

---

DzBoolProperty : getVisibilityControl()

Return Value:

• The boolean property that controls visibility of this node.

---

DzBox3 : getWSBoundingBox()

Calculate a world space oriented bounding box for this node.

Return Value:

• A box containing the current node (including an attached object) in the world-space coordinates.

---

DzOrientedBox3 : getWSOrientedBox()

Calculate a world-space oriented bounding box for this node.

Return Value:

• An oriented box derived from a local-space bounding box containing the current node (including an attached object) in the world-space coordinates.

---

DzVec3 : getWSPos()

Return Value:

• The world-space position of the node at the current time.

---

DzVec3 : getWSPos( DzTime tm, Boolean defaultVal=false )

Parameter(s):

• tm - The scene time at which to get the the transform.
• defaultVal - Use the default version of the origin, end point, and orientation instead of the current position.

Return Value:

• The world-space position of the node.

---

DzQuat : getWSRot()

Return Value:

• The world-space rotation of the node at the current time.

---

DzQuat : getWSRot( DzTime tm, Boolean defaultVal=false )

Parameter(s):

• tm - The scene time at which to get the the transform.
• defaultVal - Use the default version of the origin, end point, and orientation instead of the current position.

Return Value:

• The world-space rotation of the node.

---

DzMatrix3 : getWSScale()

Return Value:

• The world-space scale of the node at the current time.

---

DzMatrix3 : getWSScale( DzTime tm, Boolean defaultVal=false )

Parameter(s):

• tm - The scene time at which to get the the transform.
• defaultVal - Use the default version of the origin, end point, and orientation instead of the current position.

Return Value:

• The world-space scale of the node.

---

DzMatrix3 : getWSTransform()

Get the world-space transformation data for this node at the current time.

Return Value:

• A matrix representing the composed WS transform for this node.

---

DzMatrix3 : getWSTransform( DzTime tm, Boolean defaultVal=false )

Get the world-space transformation data for this node.

Parameter(s):

• tm - The scene time at which to get the the transform.
• defaultVal - Use the default version of the origin, end point, and orientation instead of the current position.

Return Value:

• A matrix representing the composed WS transform for this node.

---

DzFloatProperty : getXPosControl()

Return Value:

• The float property that controls the local x position of the node.

---

DzFloatProperty : getXRotControl()

Return Value:

• The float property that controls local rotation of the node around the x axis.

---

DzFloatProperty : getXScaleControl()

Return Value:

• The float property that controls scaling of the node along the x axis.

---

DzFloatProperty : getYPosControl()

Return Value:

• The float property that controls the local y position of the node.

---

DzFloatProperty : getYRotControl()

Return Value:

• The float property that controls local rotation of the node around the y axis.

---

DzFloatProperty : getYScaleControl()

Return Value:

• The float property that controls scaling of the node along the y axis.

---

DzFloatProperty : getZPosControl()

Return Value:

• The float property that controls the local z position of the node.

---

DzFloatProperty : getZRotControl()

Return Value:

• The float property that controls local rotation of the node around the z axis.

---

DzFloatProperty : getZScaleControl()

Return Value:

• The float property that controls scaling of the node along the z axis.

---

Boolean : inheritsScale()

Return Value:

• true if this node inherits scale from its parent, otherwise false.

---

void : invalidateBoundingBoxes( Boolean checkSkeleton=true )

Invalidates the bounding boxes for this node, causing them to be recalculated.

Parameter(s):

• checkSkeleton - Whether or not to invalidate the bounding box for this node's skeleton, if it has one.

---

Boolean : invisibleByGroup()

Return Value:

• true if this node is set invisible by a group node, otherwise false.

---

Boolean : invisibleInRenderByGroup()

Return Value:

• true if this node is set invisible in render by a group node, otherwise false.

Since:

• 4.9.4.73

---

Boolean : invisibleInSimulationByGroup()

Return Value:

• true if this node is set invisible in simulation by a group node, otherwise false.

Since:

• 4.9.4.73

---

Boolean : isBoneSelectingNode()

Return Value:

• true if the parent of this node, or any of its ancestors, is a DzBone and this node or any of its ancestors should redirect their viewport selection to their ancestors.

---

Boolean : isEditorNode()

Return Value:

• true if this node is considered an editor node, otherwise false.

---

Boolean : isHidden()

Return Value:

• true if this node should not be shown in the interface, otherwise false.

---

Boolean : isInScene()

Return Value:

• true if the node is in the scene, otherwise false.

Since:

• 4.6.4.67

---

Boolean : isNodeChild( DzNode node )

Checks to see if given node is one of this node's children.

Parameter(s):

• node - The node to look for in this node's hierarchy.

Return Value:

• true if the node is a child of this node in the scene hierarchy, otherwise false.

---

Boolean : isRootNode()

Check to see if this is a root level node.

Return Value:

• true if this object has no parent in the scene hierarchy, otherwise false.

---

Boolean : isSelectable()

Return Value:

• true if this node is selectable via the 3D viewport, otherwise false.

---

Boolean : isSelected()

Get the current selection state of this node.

Return Value:

• true if the node is selected, otherwise false.

---

Boolean : isSelectionPromoted()

Return Value:

• true if this node should redirect its viewport selection to its parent, otherwise false.

---

Boolean : isVisibileInRender()

Get the current render visibility status of this node.

Return Value:

• true if the node set to be visible in the render, otherwise false.

---

Boolean : isVisibileInSimulation()

Get the current simulation visibility status of this node.

Return Value:

• true if the node set to be visible in the simulation, otherwise false.

Since:

• 4.9.4.25

---

Boolean : isVisible()

Get the current visibility status of this node.

Return Value:

• true if the node is visible, otherwise false.

---

Boolean : modifyAsset( DzUri newUri )

Marks the asset as being modified.

Parameter(s):

• newUri - The new file URI for the asset.

Return Value:

• true on success, otherwise false.

---

Boolean : modifyAsset()

Marks the asset as being modified.

Return Value:

• true on success, otherwise false.

---

DzError : moveNodeChildToIndex( DzNode child, Number index )

Parameter(s):

• child - The node child to move.
• index - The index to put the node at, -1 for end of list, 0 for beginning.

Return Value:

• DZ_NO_ERROR on success, otherwise an appropriate error code.

---

DzError : moveNodeChildToIndex( Number childIndex, Number newChildIndex )

Parameter(s):

• childIndex - The index for the child to move.
• newChildIndex - The index to put the node at, -1 for end of list, 0 for beginning.

Return Value:

• DZ_NO_ERROR on success, otherwise an appropriate error code.

---

void : removeAllNodeChildren()

Removes all the children of this node.

---

DzError : removeNodeChild( DzNode child, Boolean inPlace=false )

Removes a child from this node.

Parameter(s):

• child - The node to remove from this node's list of children. A child must be removed from one parent before it can be attached to another.
• inPlace - If true, the necessary transforms to unparent 'In Place' will be calculated and applied to the child.

---

void : select( Boolean onOff=true )

Sets the selection state of this node.

Parameter(s):

• onOff - If true, sets selection on for this node. If false, sets selection off.

---

void : setEndPoint( DzVec3 endPnt, Boolean makeDefault=false )

Sets the end point for this node.

Parameter(s):

• endPnt - The end point for the node. This is the node's end point in relation to its geometry.
• makeDefault - Whether or not to set the default value as well as the current value.

---

void : setHidden( Boolean onOff )

Hide or show this node in the interface.

Parameter(s):

• onOff - If true, the node will not appear in the hierarchy list. If false, the node will be displayed in the scene hierarchy.

---

void : setInheritScale( Boolean onOff )

Sets whether or not this node inherits the scale of its parent.

Parameter(s):

• onOff - If true, scaling the parent of this node will scale this node also.

---

void : setInvisibleByGroup( Boolean yesNo )

Sets whether this nodes visibility is controlled by a DzGroupNode.

---

void : setInvisibleInRenderByGroup( Boolean yesNo )

Sets whether or not this node's visibility to rendering is controlled by a group node.

Since:

• 4.9.4.73

---

void : setInvisibleInSimulationByGroup( Boolean yesNo )

Sets whether or not this node's visibility to simulation is controlled by a group node.

Since:

• 4.9.4.73

---

void : setLocalPos( DzVec3 pos )

Sets local-space translation for the node at the current time.

Parameter(s):

• vec - The local space translation for the node.

---

void : setLocalPos( DzTime tm, DzVec3 pos )

Sets local-space translation for the node.

Parameter(s):

• tm - The scene time at which to set the transform for the node.
• vec - The local space translation for the node.

---

void : setLocalRot( DzTime tm, DzQuat rot )

Sets local-space rotation for the node.

Parameter(s):

• tm - The scene time at which to set the transform for the node.
• val - The local space rotation for the node.

---

void : setLocalRot( DzQuat rot )

Sets local-space rotation for the node at the current time.

Parameter(s):

• val - The local space rotation for the node.

---

void : setLocalScale( DzMatrix3 scale )

Sets local-space scale for the node at the current time.

Parameter(s):

• val - The local space scale for the node

---

void : setLocalScale( DzTime tm, DzMatrix3 scale, Number generalScale )

Sets local-space scale for the node.

Parameter(s):

• tm - The scene time at which to set the transform for the node.
• val - The local space scale for the node
• generalScale - The general scale factor for the node.

---

void : setLocalScale( DzTime tm, DzMatrix3 scale )

Sets local-space scale for the node.

Parameter(s):

• tm - The scene time at which to set the transform for the node.
• val - The local space scale for the node.

---

void : setLocalScale( DzMatrix3 scale, Number generalScale )

Sets local-space scale for the node at the current time.

Parameter(s):

• val - The local space scale for the node.
• generalScale - The general scale factor for the node.

---

void : setLocalTransform( DzTime tm, DzVec3 pos, DzQuat rot, DzMatrix3 scale )

Calculates the local transform matrix for this node at the given time.

Parameter(s):

• tm - The scene time at which to set the transform for the node.
• pos - The local-space position offset for this node.
• rot - The local-space rotation for this node.
• scale - The local-space scale for this node.

---

void : setLocalTransform( DzVec3 pos, DzQuat rot, DzMatrix3 scale, Number generalScale )

Calculates the local transform matrix for this node at the current time.

Parameter(s):

• pos - The local-space position offset for this node.
• rot - The local-space rotation for this node.
• scale - The local-space scale for this node.
• generalScale - The general scale for the transform.

---

void : setLocalTransform( DzVec3 pos, DzQuat rot, DzMatrix3 scale )

Calculates the local transform matrix for this node at the current time.

Parameter(s):

• pos - The local-space position offset for this node.
• rot - The local-space rotation for this node.
• scale - The local-space scale for this node.

---

void : setLocalTransform( DzTime tm, DzVec3 pos, DzQuat rot, DzMatrix3 scale, Number generalScale )

Calculates the local transform matrix for this node at the given time.

Parameter(s):

• tm - The scene time at which to set the transform for the node.
• pos - The local-space position offset for this node.
• rot - The local-space rotation for this node.
• scale - The local-space scale for this node.
• generalScale - The general scale for the transform.

---

void : setManipOverColor( Color color )

Sets the override color to be used to draw the node while using manipulation draw styles.

Parameter(s):

• color - The value for the override color.

---

void : setObject( DzObject object )

Sets the object for this node.

Parameter(s):

• object - The object that will be drawn by this node. The node takes ownership of this object and deletes it when it is no longer used.

---

void : setOrientation( DzQuat orientation, Boolean makeDefault=false )

Sets the orientation for the node.

Parameter(s):

• orientation - The orientation for the node. This defines the space in which node rotations occur.
• makeDefault - Whether or not to set the default value as well as the current value.

---

void : setOrientationAngles( DzVec3 angles, Boolean makeDefault=false )

Sets the orientation for the node.

Parameter(s):

• angles - The orientation for the node in degrees. This defines the space in which node rotations occur.
• makeDefault - Whether or not to set the default value as well as the current value.

---

void : setOrigin( DzVec3 origin, Boolean makeDefault=false )

Sets the origin for the node.

Parameter(s):

• origin - The origin for the node. This is the node's center point in relation to its geometry.
• makeDefault - Whether or not to set the default value as well as the current value.

---

void : setPointAtStrength( Number strength )

Set the strength of the point at parameter.

Parameter(s):

• strength - A value in the range [0.0, 1.0] that determines how closely this node aims at its point-at target.

---

void : setPointAtTarget( DzNode target )

Set the target for this node to be pointed toward.

Parameter(s):

• target - The node whose centerpoint will serve as the target of point-at functionality.

---

void : setPresentation( DzPresentation pres )

Sets the presentation for this node.

Parameter(s):

• pres - The new presentation for this node.

---

void : setPreviewBox( DzOrientedBox3 box )

Sets the preview box for the node.

Parameter(s):

• box - The oriented box to set.

---

void : setPromoteSelection( Boolean onOff )

Sets whether or not to redirect selection.

Parameter(s):

• onOff - If true, the node will redirect its selection to its parent.

---

void : setRotationOrder( DzRotationOrder order )

Sets the node rotation order.

Parameter(s):

• order - The order that the axis rotations will be applied in for this node.

---

void : setSelectable( Boolean onOff )

Sets whether or not this node is selectable via the 3D viewport.

Parameter(s):

• onOff - If true, the node will be selectable (the default). If false, the node will not participate in the pick image.

---

void : setSelectionMap( DzSelectionMap map )

Sets the selection map to use for this node.

Parameter(s):

• map - The selection map to use for this node.

---

void : setToolLocalRot( DzTime tm, DzQuat rot )

Sets the local-space rotation for the node, in the context of the current tool, at the current time.

Parameter(s):

• tm - The scene time at which to set the transform for the node.
• val - The local space rotation for the node.

---

void : setToolLocalRot( DzQuat rot )

Sets the local-space rotation for the node, in the context of the current tool.

Parameter(s):

• val - The local space rotation for the node.

---

void : setToolLocalTransform( DzVec3 pos, DzQuat rot, DzMatrix3 scale )

Calculates the local transform matrix for this node at the current time, in the context of the current tool.

Parameter(s):

• pos - The local-space position offset for this node.
• rot - The local-space rotation for this node.
• scale - The local-space scale for this node.

Since:

• 4.9.3.16

---

void : setToolLocalTransform( DzTime tm, DzVec3 pos, DzQuat rot, DzMatrix3 scale, Number generalScale )

Calculates the local transform matrix for this node at the given time, in the context of the current tool.

Parameter(s):

• tm - The scene time at which to set the transform for the node.
• pos - The local-space position offset for this node.
• rot - The local-space rotation for this node.
• scale - The local-space scale for this node.
• generalScale - The general scale for the transform.

Since:

• 4.8.1.13

---

void : setToolLocalTransform( DzVec3 pos, DzQuat rot, DzMatrix3 scale, Number generalScale )

Calculates the local transform matrix for this node at the current time, in the context of the current tool.

Parameter(s):

• pos - The local-space position offset for this node.
• rot - The local-space rotation for this node.
• scale - The local-space scale for this node.
• generalScale - The general scale for the transform.

Since:

• 4.9.3.16

---

void : setToolLocalTransform( DzTime tm, DzVec3 pos, DzQuat rot, DzMatrix3 scale )

Calculates the local transform matrix for this node, in the context of the current tool, at the given time.

Parameter(s):

• tm - The scene time at which to set the transform for the node.
• pos - The local-space position offset for this node.
• rot - The local-space rotation for this node.
• scale - The local-space scale for this node.

Since:

• 4.8.1.13

---

void : setToolWSRot( DzTime tm, DzQuat val )

Sets world-space rotation for the node, in the context of the current tool.

Parameter(s):

• tm - The scene time at which to set the rotation for the node.
• val - The World-Space rotation for the node.

Since:

• 4.9.3.16

---

void : setToolWSRot( DzQuat val )

Sets world-space rotation for the node at the current time, in the context of the current tool.

Parameter(s):

• val - The World-Space rotation for the node.

Since:

• 4.9.3.16

---

void : setToolWSTransform( DzVec3 pos, DzQuat rot, DzMatrix3 scale )

Set world-space transform values for this node at the current time, in the context of the current tool.

Parameter(s):

• pos - The world-space position offset for this node.
• rot - The world-space rotation for this node.
• scale - The world-space scale for this node.

Since:

• 4.9.3.16

---

void : setToolWSTransform( DzTime tm, DzVec3 pos, DzQuat rot, DzMatrix3 scale )

Set world-space transform values for this node, in the context of the current tool.

Parameter(s):

• tm - The scene time at which to set the transform for the node.
• pos - The world-space position offset for this node.
• rot - The world-space rotation for this node.
• scale - The world-space scale for this node.

Since:

• 4.9.3.16

---

void : setUnselectableByGroup( Boolean yesNo )

Sets whether or not this node's selectability is controlled by a group node.

---

void : setVisible( Boolean onOff )

Sets whether or not this node is visible in the 3D viewport.

Parameter(s):

• onOff - If true, the node will be visible (the default). If false, the node will not be drawn in the 3D viewport.

---

void : setVisibleInRender( Boolean onOff )

Sets whether or not this node is visible during a render.

Parameter(s):

• onOff - If true, the node is visible during a render, otherwise it is not.

---

void : setVisibleInSimulation( Boolean onOff )

Sets whether or not this node is visible during a simulation.

Parameter(s):

• onOff - If true, the node is visible during a simulation, otherwise it is not.

Since:

• 4.9.4.25

---

void : setWSPos( DzVec3 pos )

Sets world-space translation for the node at the current time.

Parameter(s):

• vec - The World-Space translation for the node.

---

void : setWSPos( DzTime tm, DzVec3 pos )

Sets world-space translation for the node.

Parameter(s):

• tm - The scene time at which to set the transform for the node.
• vec - The World-Space translation for the node.

---

void : setWSRot( DzQuat val )

Sets world-space rotation for the node at the current time.

Parameter(s):

• val - The World-Space rotation for the node.

---

void : setWSRot( DzTime tm, DzQuat val )

Sets world-space rotation for the node.

Parameter(s):

• tm - The scene time at which to set the transform for the node.
• val - The World-Space rotation for the node.

---

void : setWSScale( DzMatrix3 scale )

Sets world-space scale for the node at the current time.

Parameter(s):

• val - The World-Space sacle for the node.

---

void : setWSScale( DzTime tm, DzMatrix3 scale )

Sets world-space scale for the node.

Parameter(s):

• tm - The scene time at which to set the transform for the node.
• val - The World-Space scale for the node.

---

void : setWSTransform( DzVec3 pos, DzQuat rot, DzMatrix3 scale )

Set world-space transform values for this node at the current time.

Parameter(s):

• pos - The world-space position offset for this node.
• rot - The world-space rotation for this node.
• scale - The world-space scale for this node.

---

void : setWSTransform( DzTime tm, DzVec3 pos, DzQuat rot, DzMatrix3 scale )

Set world-space transform values for this node.

Parameter(s):

• tm - The scene time at which to set the transform for the node.
• pos - The world-space position offset for this node.
• rot - The world-space rotation for this node.
• scale - The world-space scale for this node.

---

Boolean : unselectableByGroup()

Return Value:

• true if this node is set unselectable by a group node, otherwise false.

---

void : update( Boolean isRender=false )

Called to update any cached or display data for this object.

Parameter(s):

• isRender - If true, the node should prepare itself for a render quality presentation.

---

void : updateOrientation()

Update the orientation of the node.

---

void : aboutToBeRemoved()

Signature:“aboutToBeRemoved()”

Emitted immediately before the node is removed from the scene.

---

void : aboutToDelete( DzNode node )

Signature:“aboutToDelete(DzNode*)”

Emitted when the node is about to be deleted.

Parameter(s):

• node - Thes node being deleted.

---

void : added()

Signature:“added()”

Emitted when the node is added to the scene.

---

void : assetModified()

Signature:“assetModified()”

Emitted when the node has been modified.

---

void : assetWasSaved()

Signature:“assetWasSaved()”

Emitted after the node has been saved.

---

void : boundBoxInvalidated()

Signature:“boundBoxInvalidated()”

Emitted after the bounding box for this node has been invalidated.

---

void : childAdded( DzNode child )

Signature:“childAdded(DzNode*)”

Emitted when a child is added to the node.

Parameter(s):

• node - The child added to the node.

---

void : childListChanged()

Signature:“childListChanged()”

Emitted when a child is added to or removed from the node.

---

void : childListOrderChanged()

Signature:“childListOrderChanged()”

Emitted after the order of this node's children has changed.

---

void : childRemoved( DzNode child )

Signature:“childRemoved(DzNode*)”

Emitted when a child is removed from the node.

Parameter(s):

• node - The child removed from the node.

---

void : drawnDataChanged()

Signature:“drawnDataChanged()”

Emitted when the visual representation of this node needs to be redrawn.

---

void : hiddenChanged( Boolean hidden )

Signature:“hiddenChanged(bool)”

Emitted when the hidden state of this node is changed.

Parameter(s):

• hidden - true if the node is currently hidden in the interface, otherwise false.

---

void : inheritScaleChanged()

Signature:“inheritScaleChanged()”

Emitted when the state of this node's scale inherience has changed.

---

void : materialListChanged()

Signature:“materialListChanged()”

Emitted when the list of materials for this node has changed.

---

void : materialSelectionChanged()

Signature:“materialSelectionChanged()”

Emitted when the list of selected materials for this node has changed.

---

void : materialSelectionSetsChanged()

Signature:“materialSelectionSetsChanged()”

Emitted when the material selection sets for this node has changed.

---

void : objectChanged( DzNode node, DzObject oldObject, DzObject newObject )

Signature:“objectSwitched(DzNode*,DzObject*,DzObject*)”

Emitted when a different object becomes associated with this node.

Parameter(s):

• node - This node.
• oldObject - The prior object, or NULL if none.
• newObject - The new object, or NULL if none.

---

void : parentChanged( DzNode node, DzNode oldParent, DzNode newParent )

Signature:“parentChanged(DzNode*,DzNode*,DzNode*)”

Emitted when the parent of this node changes.

Parameter(s):

• node - This node.
• oldParent - The previous parent of the node.
• newParent - The new parent of the node.

---

void : parentHierarchyChanged( DzNode node )

Signature:“parentHierarchyChanged(DzNode*)”

Emitted when the parent hierarchy for this node has changed.

Parameter(s):

• node - This node.

---

void : promoteSelectionChanged( Boolean promoteSelection )

---

void : removed()

Signature:“removed()”

Emitted when the node is removed from the scene.

---

void : riggingChanged()

Signature:“riggingChanged()”

Emitted when the rotation order, orientation, center point, or end point for this node have changed.

---

void : rotationOrderChanged()

Signature:“rotationOrderChanged()”

Emitted when the rotation order of this node changes.

---

void : selectabilityChanged()

Signature:“selectabilityChanged()”

Emitted when the selectability of the node has changed.

---

void : selected( DzNode node, Boolean onOff )

Signature:“selected(DzNode*,bool)”

Eitted when the selection state of this node changes.

Parameter(s):

• node - This node.
• onOff - true if the node was selected, false if it was deselected.

---

void : topologyChanged()

Signature:“topologyChanged()”

Emitted when the topology for this node has changed.

---

void : transformChanged()

Signature:“transformChanged()”

Emitted when transformation properties of this node change.

---

void : uvsChanged()

Signature:“uvsChanged()”

Emitted when the current uv set for this node has changed.

---

void : visibilityChanged()

Signature:“visibilityChanged()”

Emitted when the visibility of the node has changed.

---

void : visibilityInRenderChanged()

---

void : visibilityInSimulationChanged()