User Tools

Site Tools


DzNode

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

More...

Inherits :

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

Properties

Static Methods

DAZ Script
DzNodeduplicate ( DzNode node, Boolean propagate )

Constructors

DAZ Script
DzNode ()

Methods

DAZ Script
DzErroraddNodeChild ( DzNode child, Boolean inPlace=false )
voidadjustEndPoint ( DzVec3 endPnt )
voidadjustOrientation ( DzQuat orientation )
voidadjustOrientationAngles ( DzVec3 angles )
voidadjustOrigin ( DzVec3 origin )
DzQuatcalcLocalRotation ( DzVec3 anglesRadians )
BooleancastsShadow ()
voidclearAllTransformData ()
voidclearManipOverColor ()
voidclearTransformData ( DzTimeRange range )
DzNodeduplicate ( Boolean propagate )
voidfinalize ( Boolean isRender=false, Boolean allowResChange=true )
NumberfindChildIndex ( DzNode node )
DzNodefindNodeChild ( String name, Boolean recurse=false )
DzNodefindNodeChildByAssetID ( String assetID, Boolean recurse=false, Boolean checkSource=true )
DzNodefindNodeChildByLabel ( String label, Boolean recurse=false )
DzNodefindNodeChildByNameOrAlias ( String name, Boolean aliases, Boolean recurse=false )
DzPropertyfindPropertyReference ( DzUri uri )
DzBoolPropertygetDisableTransformControl ()
DzVec3getEndPoint ( Boolean defaultVal=false )
DzFloatPropertygetEndXControl ()
DzFloatPropertygetEndYControl ()
DzFloatPropertygetEndZControl ()
DzFloatPropertygetFirstAxisRotControl ()
DzBoolPropertygetIgnoreLocalTransformControl ()
DzBox3getLocalBoundingBox ()
DzOrientedBox3getLocalOrientedBox ()
DzVec3getLocalPos ()
DzVec3getLocalPos ( DzTime tm, Boolean defaultVal=false )
DzQuatgetLocalRot ()
DzQuatgetLocalRot ( DzTime tm, Boolean defaultVal=false )
DzMatrix3getLocalScale ()
DzMatrix3getLocalScale ( DzTime tm, Boolean defaultVal=false )
DzMatrix3getLocalTransform ()
DzMatrix3getLocalTransform ( DzTime tm, Boolean defaultVal=false )
ObjectgetLocalTransformAxisValues ( DzVec3 posLocal, DzQuat rotLocal, DzMatrix3 scaleLocal )
DzNodegetNodeChild ( Number i )
ArraygetNodeChildren ( Boolean recurse=false )
DzNodegetNodeParent ()
NumbergetNumNodeChildren ()
DzObjectgetObject ()
DzQuatgetOrientation ( Boolean defaultVal=false )
DzFloatPropertygetOrientXControl ()
DzFloatPropertygetOrientYControl ()
DzFloatPropertygetOrientZControl ()
DzVec3getOrigin ( Boolean defaultVal=false )
DzFloatPropertygetOriginXControl ()
DzFloatPropertygetOriginYControl ()
DzFloatPropertygetOriginZControl ()
DzNumericNodePropertygetPointAtControl ()
NumbergetPointAtStrength ()
DzNodegetPointAtTarget ()
DzPresentationgetPresentation ()
DzOrientedBox3getPreviewBox ()
DzEnumPropertygetRenderPriorityControl ()
DzBoolPropertygetRenderVisibilityControl ()
DzRotationOrdergetRotationOrder ()
DzFloatPropertygetScaleControl ()
DzFloatPropertygetSecondAxisRotControl ()
DzBoolPropertygetSelectabilityControl ()
DzSelectionMapgetSelectionMap ()
DzNodegetSelectionNode ()
DzBoolPropertygetShadowControl ()
DzBoolPropertygetSimulationVisibilityControl ()
StringgetSingletonIDString ()
DzSkeletongetSkeleton ()
DzFloatPropertygetThirdAxisRotControl ()
DzFloatPropertygetToolFirstAxisRotControl ()
DzQuatgetToolLocalRot ()
DzQuatgetToolLocalRot ( DzTime tm, Boolean defaultVal=false )
DzFloatPropertygetToolSecondAxisRotControl ()
DzFloatPropertygetToolThirdAxisRotControl ()
DzQuatgetToolWSRot ( DzTime tm, Boolean defaultVal=false )
DzQuatgetToolWSRot ()
DzMatrix3getToolWSTransform ()
DzMatrix3getToolWSTransform ( DzTime tm, Boolean defaultVal=false )
DzFloatPropertygetToolXRotControl ()
DzFloatPropertygetToolYRotControl ()
DzFloatPropertygetToolZRotControl ()
DzBoolPropertygetViewportVisibilityControl ()
DzBoolPropertygetVisibilityControl ()
DzBox3getWSBoundingBox ()
DzOrientedBox3getWSOrientedBox ()
DzVec3getWSPos ()
DzVec3getWSPos ( DzTime tm, Boolean defaultVal=false )
DzQuatgetWSRot ()
DzQuatgetWSRot ( DzTime tm, Boolean defaultVal=false )
DzMatrix3getWSScale ()
DzMatrix3getWSScale ( DzTime tm, Boolean defaultVal=false )
DzMatrix3getWSTransform ()
DzMatrix3getWSTransform ( DzTime tm, Boolean defaultVal=false )
ObjectgetWSTransformAxisValues ( DzVec3 posLocal, DzQuat rotLocal, DzMatrix3 scaleLocal )
ObjectgetWSTransformAxisValues ( DzTime tm, DzVec3 posLocal, DzQuat rotLocal, DzMatrix3 scaleLocal )
DzFloatPropertygetXPosControl ()
DzFloatPropertygetXRotControl ()
DzFloatPropertygetXScaleControl ()
DzFloatPropertygetYPosControl ()
DzFloatPropertygetYRotControl ()
DzFloatPropertygetYScaleControl ()
DzFloatPropertygetZPosControl ()
DzFloatPropertygetZRotControl ()
DzFloatPropertygetZScaleControl ()
BooleaninheritsScale ()
voidinvalidateBoundingBoxes ( Boolean checkSkeleton=true )
BooleaninvisibleByGroup ()
BooleaninvisibleInRenderByGroup ()
BooleaninvisibleInSimulationByGroup ()
BooleaninvisibleInViewportByGroup ()
BooleanisBoneSelectingNode ()
BooleanisEditorNode ()
BooleanisHidden ()
BooleanisInScene ()
BooleanisLocalTransformDisabled ()
BooleanisLocalTransformIgnored ()
BooleanisNodeAncestorOf ( DzNode node, Boolean recurse=true )
BooleanisNodeChild ( DzNode node )
BooleanisNodeDescendantOf ( DzNode node, Boolean recurse=true )
BooleanisRootNode ()
BooleanisSelectable ()
BooleanisSelected ()
BooleanisSelectionPromoted ()
BooleanisVisible ()
BooleanisVisibleInRender ()
BooleanisVisibleInSimulation ()
BooleanisVisibleInViewport ()
BooleanmodifyAsset ()
BooleanmodifyAsset ( DzUri newUri )
DzErrormoveNodeChildToIndex ( Number childIndex, Number newChildIndex )
DzErrormoveNodeChildToIndex ( DzNode child, Number index )
voidremoveAllNodeChildren ()
DzErrorremoveNodeChild ( DzNode child, Boolean inPlace=false )
voidselect ( Boolean onOff=true )
voidsetEndPoint ( DzVec3 endPnt, Boolean makeDefault=false )
voidsetHidden ( Boolean onOff )
voidsetInheritScale ( Boolean onOff )
voidsetInvisibleByGroup ( Boolean yesNo )
voidsetInvisibleInRenderByGroup ( Boolean yesNo )
voidsetInvisibleInSimulationByGroup ( Boolean yesNo )
voidsetInvisibleInViewportByGroup ( Boolean yesNo )
voidsetLocalPos ( DzVec3 posLocal )
voidsetLocalPos ( DzTime tm, DzVec3 posLocal )
voidsetLocalRot ( DzQuat rotLocal )
voidsetLocalRot ( DzTime tm, DzQuat rotLocal )
voidsetLocalScale ( DzTime tm, DzMatrix3 scaleLocal )
voidsetLocalScale ( DzMatrix3 scaleLocal, Number generalScale )
voidsetLocalScale ( DzTime tm, DzMatrix3 scaleLocal, Number generalScale )
voidsetLocalScale ( DzMatrix3 scaleLocal )
voidsetLocalTransform ( DzVec3 posLocal, DzQuat rotLocal, DzMatrix3 scaleLocal )
voidsetLocalTransform ( DzTime tm, DzVec3 posLocal, DzQuat rotLocal, DzMatrix3 scaleLocal )
voidsetLocalTransform ( DzVec3 posLocal, DzQuat rotLocal, DzMatrix3 scaleLocal, Number generalScale )
voidsetLocalTransform ( DzTime tm, DzVec3 posLocal, DzQuat rotLocal, DzMatrix3 scaleLocal, Number generalScale )
voidsetLocalTransformDisabled ( Boolean onOff )
voidsetLocalTransformIgnored ( Boolean onOff )
voidsetManipOverColor ( Color color )
voidsetObject ( DzObject object )
voidsetOrientation ( DzQuat orientation, Boolean makeDefault=false )
voidsetOrientationAngles ( DzVec3 angles, Boolean makeDefault=false )
voidsetOrigin ( DzVec3 origin, Boolean makeDefault=false )
voidsetPointAtStrength ( Number strength )
voidsetPointAtTarget ( DzNode target )
voidsetPresentation ( DzPresentation pres )
voidsetPreviewBox ( DzOrientedBox3 box )
voidsetPromoteSelection ( Boolean onOff )
voidsetRotationOrder ( DzRotationOrder order )
voidsetSelectable ( Boolean onOff )
voidsetSelectionMap ( DzSelectionMap map )
voidsetToolLocalRot ( DzTime tm, DzQuat rotLocal )
voidsetToolLocalRot ( DzQuat rotLocal )
voidsetToolLocalTransform ( DzVec3 posLocal, DzQuat rotLocal, DzMatrix3 scaleLocal, Number generalScale )
voidsetToolLocalTransform ( DzVec3 posLocal, DzQuat rotLocal, DzMatrix3 scaleLocal )
voidsetToolLocalTransform ( DzTime tm, DzVec3 posLocal, DzQuat rotLocal, DzMatrix3 scaleLocal, Number generalScale )
voidsetToolLocalTransform ( DzTime tm, DzVec3 posLocal, DzQuat rotLocal, DzMatrix3 scaleLocal )
voidsetToolWSRot ( DzQuat rotWS )
voidsetToolWSRot ( DzTime tm, DzQuat rotWS )
voidsetToolWSTransform ( DzVec3 posWS, DzQuat rotWS, DzMatrix3 scaleWS )
voidsetToolWSTransform ( DzTime tm, DzVec3 posWS, DzQuat rotWS, DzMatrix3 scaleWS )
voidsetUnselectableByGroup ( Boolean yesNo )
voidsetVisible ( Boolean onOff )
voidsetVisibleInRender ( Boolean onOff )
voidsetVisibleInSimulation ( Boolean onOff )
voidsetVisibleInViewport ( Boolean onOff )
voidsetWSPos ( DzVec3 posWS )
voidsetWSPos ( DzTime tm, DzVec3 posWS )
voidsetWSRot ( DzQuat rotWS )
voidsetWSRot ( DzTime tm, DzQuat rotWS )
voidsetWSScale ( DzTime tm, DzMatrix3 scaleWS )
voidsetWSScale ( DzMatrix3 scaleWS )
voidsetWSTransform ( DzVec3 posWS, DzQuat rotWS, DzMatrix3 scaleWS )
voidsetWSTransform ( DzTime tm, DzVec3 posWS, DzQuat rotWS, DzMatrix3 scaleWS )
BooleanunselectableByGroup ()
voidupdate ( Boolean isRender=false )
voidupdateOrientation ()

Signals

voidaboutToBeRemoved ()
voidaboutToDelete ( DzNode node )
voidadded ()
voidassetModified ()
voidassetWasSaved ()
voidboundBoxInvalidated ()
voidchildAdded ( DzNode child )
voidchildListChanged ()
voidchildListOrderChanged ()
voidchildRemoved ( DzNode child )
voiddrawnDataChanged ()
voidhiddenChanged ( Boolean hidden )
voidinheritScaleChanged ()
voidmaterialListChanged ()
voidmaterialSelectionChanged ()
voidmaterialSelectionSetsChanged ()
voidobjectChanged ( DzNode node, DzObject oldObject, DzObject newObject )
voidparentChanged ( DzNode node, DzNode oldParent, DzNode newParent )
voidparentHierarchyChanged ( DzNode node )
voidpromoteSelectionChanged ( Boolean promoteSelection )
voidremoved ()
voidriggingChanged ()
voidrotationOrderChanged ()
voidselectabilityChanged ()
voidselected ( DzNode node, Boolean onOff )
voidtopologyChanged ()
voidtransformChanged ()
voiduvsChanged ()
voidvisibilityChanged ()
voidvisibilityInRenderChanged ()
voidvisibilityInSimulationChanged ()
voidvisibilityInViewportChanged ()

Detailed Description

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 separate 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 true for rotations (which are represented to the user as Euler angle degrees for each axis channel). Euler angles are inherently inter-dependent and prone to numerical singularities (“gimbal lock”) that make them less than perfect at representing rotations. For this reason, rotations are handled as DzQuat objects (quaternions) whenever possible. When setting keys on a DzNode, it is preferable 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.

Each node defines an order that axis rotations will be applied in for the node. The order defined is important as it serves to avoid numerical singularities (“gimbal lock”). The rotation order of a node should be defined such that the first axis in the order is the primary axis - the axis that the node will twist along. The second axis in the order should be defined as the axis where rotations are least likely to reach 90?. And the third axis in the order should be defined as the axis where rotations are most likely to reach 90?.

Nodes have an origin and an orientation that define the base position and rotation of its “local space,” that is - a base from which a node's transformations can be expressed in relative terms. The origin defines the point around which a node rotates, the point around which a node is scaled, the point from which a node's translation is relative. In other words, the origin is the definition of an adjusted “center” point“ (a positional offset) for the node. The origin of a node is defined in non-transformed world space coordinates. The orientation of a node defines the base rotation (a rotational offset) that a node's rotations are expressed as being relative to. Adjusting the orientation of a node only has an effect on the rotation of a node, it does not affect translation or scale transforms.

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 node's origin added to the local position is equivalent to the world space transform.

Properties


DzAuthor : assetAuthor

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

Since:

  • 4.8.1.21

DzVersion : assetFileRevision

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

Since:

  • 4.8.1.21

String : assetId

Holds the asset id for this node.

Since:

  • 4.8.1.18

Array : assetIdAliases

Holds the asset id aliases for this node.


Date : assetModifiedDate

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

Since:

  • 4.8.1.21

Boolean : assetNeedSave

Holds whether or not the asset for this node needs to be saved. (Read Only)

Since:

  • 4.11.0.249

DzUri : assetSource

Holds 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

Holds the asset URI for this node. (Read Only)

Since:

  • 4.8.1.18

String : extendedAddonsPath

Holds the path relative to the node asset file folder to search for addons.

Since:

  • 4.12.2.44

String : extendedAssetIds

Holds additional ids that this node extends.

Since:

  • 4.12.2.44

Array : nameAliases

Holds the name aliases for this node.


DzRenderMgr::RenderPriority : renderPriority

Holds the render priority for this 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.

Static Methods


DzNode : duplicate( DzNode node, Boolean propagate )

Parameter(s):

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

Return Value:

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

Since:

  • 4.9.3.80

Constructors


DzNode()

Default Constructor.

Methods


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 this node. This is the node's end point in relation to its geometry.

void : adjustOrientation( DzQuat orientation )

Sets the orientation for this node adjusting for controllers.

Parameter(s):

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

void : adjustOrientationAngles( DzVec3 angles )

Sets the orientation for this node adjusting for controllers.

Parameter(s):

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

void : adjustOrigin( DzVec3 origin )

Sets the origin for this node adjusting for controllers.

Parameter(s):

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

DzQuat : calcLocalRotation( DzVec3 anglesRadians )

Parameter(s):

  • anglesRadians - The per axis Euler angles, in radians, to convert.

Return Value:

  • The quaternion, based on the rotation order of this node, that would rotate this node in local-space according to the Euler angles passed.

Since:

  • 4.12.1.111

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 time range 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 node )

Parameter(s):

  • node - The node to find the index of.

Return Value:

  • The index of node as a child of this node (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 aliases, 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 : getDisableTransformControl()

Return Value:

  • The property used for controlling whether or not the transform controls for this node, and the local transform, is overridden to be identity.

Since:

  • 4.11.0.300

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

DzBoolProperty : getIgnoreLocalTransformControl()

Return Value:

  • The property used for controlling whether or not the local transform for this node is ignored by any geometry associated with it.

Since:

  • 4.12.1.68

DzBox3 : getLocalBoundingBox()

Return Value:

  • A three dimensional box containing the current node (including associated geometry - if any) oriented to the cardinal axes of the world and represented in coordinates that are relative to the node origin.

See Also:


DzOrientedBox3 : getLocalOrientedBox()

Return Value:

  • A three dimensional box containing the current node (including associated geometry - if any) oriented to the cardinal axes of the node and represented in coordinates that are relative to the node origin.

See Also:


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 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 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 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 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.

Object : getLocalTransformAxisValues( DzVec3 posLocal, DzQuat rotLocal, DzMatrix3 scaleLocal )

Parameter(s):

  • posLocal - The local-space position offset for this node.
  • rotLocal - The local-space rotation offset for this node.
  • scaleLocal - The local-space scale offset for this node.

Return Value:

  • An object with properties named after the transform properties and their respective values.

Example:

(function(){
 
	var oNode = Scene.getPrimarySelection();
	if( !oNode ){
		return;
	}
 
	var vecPosLocal = oNode.getLocalPos();
	var quatRotLocal = oNode.getLocalRot();
	var mtxScaleLocal = oNode.getLocalScale();
	var oTransform = oNode.getLocalTransformAxisValues( vecPosLocal, quatRotLocal, mtxScaleLocal );
	print( JSON.stringify( oTransform, null, "\t" ) );
 
})();

Since:

  • 4.12.1.111

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.

Number : getPointAtStrength()

Return Value:

  • The value that determines how closely this node aims at its point-at target.

See Also:

Since:

  • 4.12.1.68

DzNode : getPointAtTarget()

Return Value:

  • The point at target for this node (if any), otherwise null.

See Also:

Since:

  • 4.12.1.68

DzPresentation : getPresentation()

Return Value:

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

DzOrientedBox3 : getPreviewBox()

Return Value:

  • If the preview box has been set, a three dimensional box that represents the current node (including associated geometry - if any) oriented to the cardinal axes of the node and represented in coordinates that are relative to the node origin. If a preview box has not been set, an invalid box.

Attention:

  • The preview box is typically set when assets are being loaded from file. If an asset referenced within the file cannot be found/loaded, the preview box is used to provide an indication to the user of where the node (including associated geometry - if any) would be located and oriented within the scene.

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

String : getSingletonIDString()

Return Value:

  • The singleton identifier for this node (if it is a singleton), otherwise an empty string.

Since:

  • 4.12.2.20

DzSkeleton : getSkeleton()

Traverses up the node hierarchy and attempts 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 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( DzTime tm, Boolean defaultVal=false )

Parameter(s):

  • tm - The scene time at which to get the transform.
  • defaultVal - Whether or not to 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

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

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 world-space 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 transform.
  • defaultVal - Whether or not to use the default version of the origin, end point, and orientation instead of the current position.

Return Value:

  • A matrix representing the composed world-space 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 : getViewportVisibilityControl()

Return Value:

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

Since:

  • 4.11.0.36

DzBoolProperty : getVisibilityControl()

Return Value:

  • The boolean property that controls visibility (to viewports, to renders, to simulation) of this node.

DzBox3 : getWSBoundingBox()

Return Value:

  • A three dimensional box containing the current node (including associated geometry - if any) oriented to the cardinal axes of the world and represented in coordinates that are relative to the world origin.

See Also:


DzOrientedBox3 : getWSOrientedBox()

Return Value:

  • A three dimensional box containing the current node (including associated geometry - if any) oriented to the cardinal axes of the world and represented in coordinates that are relative to the node origin.

See Also:


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 transform.
  • defaultVal - Whether or not to 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 transform.
  • defaultVal - Whether or not to 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 transform.
  • defaultVal - Whether or not to 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 world-space 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 transform.
  • defaultVal - Whether or not to use the default version of the origin, end point, and orientation instead of the current position.

Return Value:

  • A matrix representing the composed world-space transform for this node.

Object : getWSTransformAxisValues( DzVec3 posLocal, DzQuat rotLocal, DzMatrix3 scaleLocal )

Return Value:

  • An object with properties named after the transform properties and their respective values, at the current time.

Example:

(function(){
 
	var oNode = Scene.getPrimarySelection();
	if( !oNode ){
		return;
	}
 
	var vecPosLocal = oNode.getLocalPos();
	var quatRotLocal = oNode.getLocalRot();
	var mtxScaleLocal = oNode.getLocalScale();
	var oTransform = oNode.getWSTransformAxisValues( vecPosLocal, quatRotLocal, mtxScaleLocal );
	print( JSON.stringify( oTransform, null, "\t" ) );
 
})();

Since:

  • 4.12.1.111

Object : getWSTransformAxisValues( DzTime tm, DzVec3 posLocal, DzQuat rotLocal, DzMatrix3 scaleLocal )

Parameter(s):

  • tm - The scene time at which to get the transform.
  • posLocal - The local-space position offset for this node.
  • rotLocal - The local-space rotation offset for this node.
  • scaleLocal - The local-space scale offset for this node.

Return Value:

  • An object with properties named after the transform properties and their respective values, at the specified time.

Example:

(function(){
 
	var oNode = Scene.getPrimarySelection();
	if( !oNode ){
		return;
	}
 
	var vecPosLocal = oNode.getLocalPos();
	var quatRotLocal = oNode.getLocalRot();
	var mtxScaleLocal = oNode.getLocalScale();
	var oTransform = oNode.getWSTransformAxisValues( Scene.getTime(), vecPosLocal, quatRotLocal, mtxScaleLocal );
	print( JSON.stringify( oTransform, null, "\t" ) );
 
})();

Since:

  • 4.12.1.111

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 : invisibleInViewportByGroup()

Return Value:

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

Since:

  • 4.11.0.36

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 : isLocalTransformDisabled()

Return Value:

  • true if the local transform is disabled, otherwise false.

Since:

  • 4.12.1.68

Boolean : isLocalTransformIgnored()

Return Value:

  • true if the local transform is ignored, otherwise false.

Since:

  • 4.12.1.68

Boolean : isNodeAncestorOf( DzNode node, Boolean recurse=true )

Checks whether or not a given node is one of this node's ancestors in the scene hierarchy.

Parameter(s):

  • node - The node to look for.
  • recurse - Whether or not to ascend the hierarchy.

Return Value:

  • true if the node is an ancestor of this node in the scene hierarchy, otherwise false.

Since:

  • 4.15.0.18

Boolean : isNodeChild( DzNode node )

Checks to see if given node is one of this node's immediate 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.

See Also:

  • isNodeDescendant()
  • isNodeAncestor()

Boolean : isNodeDescendantOf( DzNode node, Boolean recurse=true )

Checks whether or not a given node is one of this node's descendants in the scene hierarchy.

Parameter(s):

  • node - The node to look for.
  • recurse - Whether or not to descend this node's hierarchy.

Return Value:

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

Since:

  • 4.15.0.18

Boolean : isRootNode()

Check to see if this is a root (top) level node.

Return Value:

  • true if this node 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 : isVisible()

Get the current visibility status of this node.

Return Value:

  • true if the node is visible, otherwise false.

Boolean : isVisibleInRender()

Get the current render visibility status of this node.

Return Value:

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

Since:

  • 4.11.0.300

Boolean : isVisibleInSimulation()

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.11.0.300

Boolean : isVisibleInViewport()

Get the current view visibility status of this node.

Return Value:

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

Since:

  • 4.11.0.300

Boolean : modifyAsset()

Marks the asset as being modified.

Return Value:

  • true on success, 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.

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.

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.

void : removeAllNodeChildren()

Removes all of the child nodes 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 this 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 scene hierarchy. 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 : setInvisibleInViewportByGroup( Boolean yesNo )

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

Since:

  • 4.11.0.36

void : setLocalPos( DzVec3 posLocal )

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

Parameter(s):

  • posLocal - The local-space translation for this node.

void : setLocalPos( DzTime tm, DzVec3 posLocal )

Sets local-space translation for this node.

Parameter(s):

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

void : setLocalRot( DzQuat rotLocal )

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

Parameter(s):

  • rotLocal - The local-space rotation for this node.

void : setLocalRot( DzTime tm, DzQuat rotLocal )

Sets local-space rotation for this node.

Parameter(s):

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

void : setLocalScale( DzTime tm, DzMatrix3 scaleLocal )

Sets local-space scale for this node.

Parameter(s):

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

void : setLocalScale( DzMatrix3 scaleLocal, Number generalScale )

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

Parameter(s):

  • scaleLocal - The local-space scale for this node.
  • generalScale - The general scale factor for this node.

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

Sets local-space scale for this node.

Parameter(s):

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

void : setLocalScale( DzMatrix3 scaleLocal )

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

Parameter(s):

  • scaleLocal - The local-space scale for this node.

void : setLocalTransform( DzVec3 posLocal, DzQuat rotLocal, DzMatrix3 scaleLocal )

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

Parameter(s):

  • posLocal - The local-space position offset for this node.
  • rotLocal - The local-space rotation for this node.
  • scaleLocal - The local-space scale for this node.

void : setLocalTransform( DzTime tm, DzVec3 posLocal, DzQuat rotLocal, DzMatrix3 scaleLocal )

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 this node.
  • posLocal - The local-space position offset for this node.
  • rotLocal - The local-space rotation for this node.
  • scaleLocal - The local-space scale for this node.

void : setLocalTransform( DzVec3 posLocal, DzQuat rotLocal, DzMatrix3 scaleLocal, Number generalScale )

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

Parameter(s):

  • posLocal - The local-space position offset for this node.
  • rotLocal - The local-space rotation for this node.
  • scaleLocal - The local-space scale for this node.
  • generalScale - The general scale for the transform.

void : setLocalTransform( DzTime tm, DzVec3 posLocal, DzQuat rotLocal, DzMatrix3 scaleLocal, 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 this node.
  • posLocal - The local-space position offset for this node.
  • rotLocal - The local-space rotation for this node.
  • scaleLocal - The local-space scale for this node.
  • generalScale - The general scale for the transform.

void : setLocalTransformDisabled( Boolean onOff )

Sets whether or not the local transform for this node is disabled.

Parameter(s):

  • onOff - If true, the transform controls are disabled and the local transform for this node is overridden to be identity.

Since:

  • 4.12.1.68

void : setLocalTransformIgnored( Boolean onOff )

Sets whether or not the local transform of this node is ignored.

Parameter(s):

  • onOff - If true, the local transform for this node is not applied to any associated geometry.

Since:

  • 4.12.1.68

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 this node.

Parameter(s):

  • orientation - The orientation for this 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 this node.

Parameter(s):

  • angles - The orientation for this 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 this node.

Parameter(s):

  • origin - The origin for this 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 origin 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 this 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 rotLocal )

Sets the local-space rotation for this 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 this node.
  • rotLocal - The local-space rotation for this node.

void : setToolLocalRot( DzQuat rotLocal )

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

Parameter(s):

  • rotLocal - The local-space rotation for this node.

void : setToolLocalTransform( DzVec3 posLocal, DzQuat rotLocal, DzMatrix3 scaleLocal, Number generalScale )

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

Parameter(s):

  • posLocal - The local-space position offset for this node.
  • rotLocal - The local-space rotation for this node.
  • scaleLocal - The local-space scale for this node.
  • generalScale - The general scale for the transform.

Since:

  • 4.9.3.16

void : setToolLocalTransform( DzVec3 posLocal, DzQuat rotLocal, DzMatrix3 scaleLocal )

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

Parameter(s):

  • posLocal - The local-space position offset for this node.
  • rotLocal - The local-space rotation for this node.
  • scaleLocal - The local-space scale for this node.

Since:

  • 4.9.3.16

void : setToolLocalTransform( DzTime tm, DzVec3 posLocal, DzQuat rotLocal, DzMatrix3 scaleLocal, 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 this node.
  • posLocal - The local-space position offset for this node.
  • rotLocal - The local-space rotation for this node.
  • scaleLocal - The local-space scale for this node.
  • generalScale - The general scale for the transform.

Since:

  • 4.8.1.13

void : setToolLocalTransform( DzTime tm, DzVec3 posLocal, DzQuat rotLocal, DzMatrix3 scaleLocal )

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 this node.
  • posLocal - The local-space position offset for this node.
  • rotLocal - The local-space rotation for this node.
  • scaleLocal - The local-space scale for this node.

Since:

  • 4.8.1.13

void : setToolWSRot( DzQuat rotWS )

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

Parameter(s):

  • rotWS - The world-space rotation for this node.

Since:

  • 4.9.3.16

void : setToolWSRot( DzTime tm, DzQuat rotWS )

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

Parameter(s):

  • tm - The scene time at which to set the rotation for this node.
  • rotWS - The world-space rotation for this node.

Since:

  • 4.9.3.16

void : setToolWSTransform( DzVec3 posWS, DzQuat rotWS, DzMatrix3 scaleWS )

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

Parameter(s):

  • posWS - The world-space position offset for this node.
  • rotWS - The world-space rotation for this node.
  • scaleWS - The world-space scale for this node.

Since:

  • 4.9.3.16

void : setToolWSTransform( DzTime tm, DzVec3 posWS, DzQuat rotWS, DzMatrix3 scaleWS )

Sets the 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 this node.
  • posWS - The world-space position offset for this node.
  • rotWS - The world-space rotation for this node.
  • scaleWS - 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 viewport, in renders and in simulations.

Parameter(s):

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

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 : setVisibleInViewport( 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.

Since:

  • 4.11.0.36

void : setWSPos( DzVec3 posWS )

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

Parameter(s):

  • vec - The world-space translation for this node.

void : setWSPos( DzTime tm, DzVec3 posWS )

Sets the world-space translation for this node.

Parameter(s):

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

void : setWSRot( DzQuat rotWS )

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

Parameter(s):

  • rotWS - The world-space rotation for this node.

void : setWSRot( DzTime tm, DzQuat rotWS )

Sets the world-space rotation for this node.

Parameter(s):

  • tm - The scene time at which to set the transform for this node.
  • rotWS - The world-space rotation for this node.

void : setWSScale( DzTime tm, DzMatrix3 scaleWS )

Sets the world-space scale for this node.

Parameter(s):

  • tm - The scene time at which to set the transform for this node.
  • scaleWS - The world-space scale for this node.

void : setWSScale( DzMatrix3 scaleWS )

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

Parameter(s):

  • scaleWS - The world-space scale for this node.

void : setWSTransform( DzVec3 posWS, DzQuat rotWS, DzMatrix3 scaleWS )

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

Parameter(s):

  • posWS - The world-space position offset for this node.
  • rotWS - The world-space rotation for this node.
  • scaleWS - The world-space scale for this node.

void : setWSTransform( DzTime tm, DzVec3 posWS, DzQuat rotWS, DzMatrix3 scaleWS )

Sets the world-space transform values for this node.

Parameter(s):

  • tm - The scene time at which to set the transform for this node.
  • posWS - The world-space position offset for this node.
  • rotWS - The world-space rotation for this node.
  • scaleWS - 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.

Signals


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 - The 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 inheritance 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 )

Signature:“promoteSelectionChanged(bool)”

Emitted when this node's selection promotion has changed.

Parameter(s):

  • promoteSelection - true if selection is promoted, false if selection is not promoted.

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()

Signature:“visibilityInRenderChanged()”

Emitted when the visibility of the node in renders has changed.

Since:

  • 4.9.4.73

void : visibilityInSimulationChanged()

Signature:“visibilityInSimulationChanged()”

Emitted when the visibility of the node in simulations has changed.

Since:

  • 4.9.4.73

void : visibilityInViewportChanged()

Signature:“visibilityInViewportChanged()”

Emitted when the visibility of the node in viewports has changed.

Since:

  • 4.11.0.36