Base class for objects that can participate in a transform hierarchy.
Inherits :
Inherited By : DzBone, DzCamera, DzDForm, DzDFormBase, DzDFormZone, DzGeometryShellNode, DzGroupNode, DzInstanceNode, measuremetricsnode_dz and DzSkeleton
DAZ Script |
---|
DzNode () |
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 has an effect on the rotation and the scale of a node, it does not affect the translation of a node.
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.
Holds the author of the file for this node. (Read Only)
Since:
Holds the revision version of the asset file for this node. (Read Only)
Since:
Holds the asset id for this node.
Since:
Holds the asset id aliases for this node.
Holds the modified date of the asset file for this node. (Read Only)
Since:
Holds whether or not the asset for this node needs to be saved. (Read Only)
Since:
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:
Holds the asset URI for this node. (Read Only)
Since:
Holds the path relative to the node asset file folder to search for addons.
Since:
Holds additional ids that this node extends.
Since:
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.
DzNode : duplicate( DzNode node, Boolean propagate )
Parameter(s):
true
, the hierarchy of nodes that are children of node
will also be duplicated.Return Value:
node
, otherwise null.Since:
DzError : addNodeChild( DzNode child, Boolean inPlace=false )
Adds a child to this node.
Parameter(s):
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):
void : adjustOrientation( DzQuat orientation )
Sets the orientation for this node adjusting for controllers.
Parameter(s):
void : adjustOrientationAngles( DzVec3 angles )
Sets the orientation for this node adjusting for controllers.
Parameter(s):
void : adjustOrigin( DzVec3 origin )
Sets the origin for this node adjusting for controllers.
Parameter(s):
DzQuat : calcLocalRotation( DzVec3 anglesRadians )
Parameter(s):
Return Value:
Since:
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):
DzNode : duplicate( Boolean propagate )
Parameter(s):
true
, the hierarchy of nodes that are children of this node will also be duplicated.Return Value:
Since:
void : finalize( Boolean isRender=false, Boolean allowResChange=true )
Finalizes the node's geometry cache.
Parameter(s):
true
, the node should prepare itself for a render quality presentation. This is typically only set true
when performing an “offline” render, otherwise it should be set false
(default) to prevent thrashing of the geometry cache.true
, the geometry is allowed to change resolution in the finalize, otherwise the geometry will stay at its current resolution.Number : findChildIndex( DzNode node )
Parameter(s):
Return Value:
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):
true
, this will be called recursively until a child with a matching name is found.Return Value:
DzNode : findNodeChildByAssetID( String assetID, Boolean recurse=false, Boolean checkSource=true )
Get a child from this node by asset id.
Parameter(s):
true
, this will be called recursively until a child with a matching asset ID is found.true
, the asset's source will be checked for a match.Return Value:
DzNode : findNodeChildByLabel( String label, Boolean recurse=false )
Get a child from this node by label.
Parameter(s):
true
, this will be called recursively until a child with a matching label is found.Return Value:
Since:
DzNode : findNodeChildByNameOrAlias( String name, Boolean aliases, Boolean recurse=false )
Get a child from this node by name (or alias).
Parameter(s):
true
, consider name aliases.true
, this will be called recursively until a child with a matching name (or alias) is found.Return Value:
DzProperty : findPropertyReference( DzUri uri )
Parameter(s):
Return Value:
null
if the property cannot be found.Since:
DzBoolProperty : getDisableTransformControl()
Return Value:
Since:
DzVec3 : getEndPoint( Boolean defaultVal=false )
Parameter(s):
true
, the default value for the end point is returned, otherwise the current value is.Return Value:
DzFloatProperty : getEndXControl()
Return Value:
DzFloatProperty : getEndYControl()
Return Value:
DzFloatProperty : getEndZControl()
Return Value:
DzFloatProperty : getFirstAxisRotControl()
Return Value:
Since:
DzBoolProperty : getIgnoreLocalTransformControl()
Return Value:
Since:
DzBox3 : getLocalBoundingBox()
Return Value:
See Also:
DzOrientedBox3 : getLocalOrientedBox()
Return Value:
See Also:
DzVec3 : getLocalPos()
Return Value:
DzVec3 : getLocalPos( DzTime tm, Boolean defaultVal=false )
Parameter(s):
Return Value:
DzQuat : getLocalRot()
Return Value:
DzQuat : getLocalRot( DzTime tm, Boolean defaultVal=false )
Parameter(s):
Return Value:
Return Value:
DzMatrix3 : getLocalScale( DzTime tm, Boolean defaultVal=false )
Parameter(s):
Return Value:
DzMatrix3 : getLocalTransform()
Get the composed local transform info for this node at the current time.
Return Value:
DzMatrix3 : getLocalTransform( DzTime tm, Boolean defaultVal=false )
Get the composed local transform info for this node.
Parameter(s):
Return Value:
Object : getLocalTransformAxisValues( DzVec3 posLocal, DzQuat rotLocal, DzMatrix3 scaleLocal )
Parameter(s):
Return Value:
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:
DzNode : getNodeChild( Number i )
Get the child at the given index.
Return Value:
Array : getNodeChildren( Boolean recurse=false )
Parameter(s):
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:
DzNode : getNodeParent()
Get the parent of this node.
Return Value:
Get the number of children attached to this node.
Return Value:
Get the object currently associated with this node.
Return Value:
DzQuat : getOrientation( Boolean defaultVal=false )
Parameter(s):
Return Value:
DzFloatProperty : getOrientXControl()
Return Value:
DzFloatProperty : getOrientYControl()
Return Value:
DzFloatProperty : getOrientZControl()
Return Value:
DzVec3 : getOrigin( Boolean defaultVal=false )
Parameter(s):
Return Value:
DzFloatProperty : getOriginXControl()
Return Value:
DzFloatProperty : getOriginYControl()
Return Value:
DzFloatProperty : getOriginZControl()
Return Value:
DzNumericNodeProperty : getPointAtControl()
Return Value:
Return Value:
See Also:
Since:
DzNode : getPointAtTarget()
Return Value:
See Also:
Since:
DzPresentation : getPresentation()
Return Value:
DzOrientedBox3 : getPreviewBox()
Return Value:
Attention:
DzEnumProperty : getRenderPriorityControl()
Return Value:
DzBoolProperty : getRenderVisibilityControl()
Return Value:
DzRotationOrder : getRotationOrder()
Get the node rotation order.
Return Value:
DzFloatProperty : getScaleControl()
Return Value:
DzFloatProperty : getSecondAxisRotControl()
Return Value:
Since:
DzBoolProperty : getSelectabilityControl()
Return Value:
DzSelectionMap : getSelectionMap()
Return Value:
DzNode : getSelectionNode()
Return Value:
DzBoolProperty : getShadowControl()
Return Value:
DzBoolProperty : getSimulationVisibilityControl()
Return Value:
Since:
String : getSingletonIDString()
Return Value:
Since:
Traverses up the node hierarchy and attempts to find a DzSkeleton.
Return Value:
DzFloatProperty : getThirdAxisRotControl()
Return Value:
Since:
DzFloatProperty : getToolFirstAxisRotControl()
Return Value:
Since:
Return Value:
Since:
DzQuat : getToolLocalRot( DzTime tm, Boolean defaultVal=false )
Parameter(s):
Return Value:
Since:
DzFloatProperty : getToolSecondAxisRotControl()
Return Value:
Since:
DzFloatProperty : getToolThirdAxisRotControl()
Return Value:
Since:
DzQuat : getToolWSRot( DzTime tm, Boolean defaultVal=false )
Parameter(s):
Return Value:
Since:
DzQuat : getToolWSRot()
Return Value:
Since:
DzMatrix3 : getToolWSTransform()
Get the world-space transformation data for this node at the current time, in the context of the current tool.
Return Value:
Since:
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):
Return Value:
Since:
DzFloatProperty : getToolXRotControl()
Return Value:
DzFloatProperty : getToolYRotControl()
Return Value:
DzFloatProperty : getToolZRotControl()
Return Value:
DzBoolProperty : getViewportVisibilityControl()
Return Value:
Since:
DzBoolProperty : getVisibilityControl()
Return Value:
Return Value:
See Also:
DzOrientedBox3 : getWSOrientedBox()
Return Value:
See Also:
Return Value:
DzVec3 : getWSPos( DzTime tm, Boolean defaultVal=false )
Parameter(s):
Return Value:
Return Value:
DzQuat : getWSRot( DzTime tm, Boolean defaultVal=false )
Parameter(s):
Return Value:
DzMatrix3 : getWSScale()
Return Value:
DzMatrix3 : getWSScale( DzTime tm, Boolean defaultVal=false )
Parameter(s):
Return Value:
Get the world-space transformation data for this node at the current time.
Return Value:
DzMatrix3 : getWSTransform( DzTime tm, Boolean defaultVal=false )
Get the world-space transformation data for this node.
Parameter(s):
Return Value:
Object : getWSTransformAxisValues( DzVec3 posLocal, DzQuat rotLocal, DzMatrix3 scaleLocal )
Return Value:
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:
Object : getWSTransformAxisValues( DzTime tm, DzVec3 posLocal, DzQuat rotLocal, DzMatrix3 scaleLocal )
Parameter(s):
Return Value:
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:
DzFloatProperty : getXPosControl()
Return Value:
DzFloatProperty : getXRotControl()
Return Value:
DzFloatProperty : getXScaleControl()
Return Value:
DzFloatProperty : getYPosControl()
Return Value:
DzFloatProperty : getYRotControl()
Return Value:
DzFloatProperty : getYScaleControl()
Return Value:
DzFloatProperty : getZPosControl()
Return Value:
DzFloatProperty : getZRotControl()
Return Value:
DzFloatProperty : getZScaleControl()
Return Value:
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):
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:
Boolean : invisibleInSimulationByGroup()
Return Value:
true
if this node is set invisible in simulation by a group node, otherwise false
.Since:
Boolean : invisibleInViewportByGroup()
Return Value:
true
if this node is set invisible in view by a group node, otherwise false
.Since:
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
.Return Value:
true
if this node should not be shown in the interface, otherwise false
.Return Value:
true
if the node is in the scene, otherwise false
.Since:
Boolean : isLocalTransformDisabled()
Return Value:
true
if the local transform is disabled, otherwise false
.Since:
Boolean : isLocalTransformIgnored()
Return Value:
true
if the local transform is ignored, otherwise false
.Since:
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):
Return Value:
true
if the node is an ancestor of this node in the scene hierarchy, otherwise false
.Since:
Boolean : isNodeChild( DzNode node )
Checks to see if given node is one of this node's immediate children.
Parameter(s):
Return Value:
true
if the node is a child of this node in the scene hierarchy, otherwise false
.See Also:
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):
Return Value:
true
if the node is a descendant of this node in the scene hierarchy, otherwise false
.Since:
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
.Get the current visibility status of this node.
Return Value:
true
if the node is visible, otherwise false
.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:
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:
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:
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):
Return Value:
true
on success, otherwise false
.DzError : moveNodeChildToIndex( Number childIndex, Number newChildIndex )
Parameter(s):
Return Value:
DzError : moveNodeChildToIndex( DzNode child, Number index )
Parameter(s):
Return Value:
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):
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):
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):
void : setHidden( Boolean onOff )
Hide or show this node in the interface.
Parameter(s):
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):
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:
void : setInvisibleInSimulationByGroup( Boolean yesNo )
Sets whether or not this node's visibility to simulation is controlled by a group node.
Since:
void : setInvisibleInViewportByGroup( Boolean yesNo )
Sets whether or not this node's visibility to viewport drawing is controlled by a group node.
Since:
void : setLocalPos( DzVec3 posLocal )
Sets local-space translation for this node at the current time.
Parameter(s):
void : setLocalPos( DzTime tm, DzVec3 posLocal )
Sets local-space translation for this node.
Parameter(s):
void : setLocalRot( DzQuat rotLocal )
Sets local-space rotation for this node at the current time.
Parameter(s):
void : setLocalRot( DzTime tm, DzQuat rotLocal )
Sets local-space rotation for this node.
Parameter(s):
void : setLocalScale( DzTime tm, DzMatrix3 scaleLocal )
Sets local-space scale for this node.
Parameter(s):
void : setLocalScale( DzMatrix3 scaleLocal, Number generalScale )
Sets local-space scale for this node at the current time.
Parameter(s):
void : setLocalScale( DzTime tm, DzMatrix3 scaleLocal, Number generalScale )
Sets local-space scale for this node.
Parameter(s):
void : setLocalScale( DzMatrix3 scaleLocal )
Sets local-space scale for this node at the current time.
Parameter(s):
void : setLocalTransform( DzVec3 posLocal, DzQuat rotLocal, DzMatrix3 scaleLocal )
Calculates the local transform matrix for this node at the current time.
Parameter(s):
void : setLocalTransform( DzTime tm, DzVec3 posLocal, DzQuat rotLocal, DzMatrix3 scaleLocal )
Calculates the local transform matrix for this node at the given time.
Parameter(s):
void : setLocalTransform( DzVec3 posLocal, DzQuat rotLocal, DzMatrix3 scaleLocal, Number generalScale )
Calculates the local transform matrix for this node at the current time.
Parameter(s):
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):
void : setLocalTransformDisabled( Boolean onOff )
Sets whether or not the local transform for this node is disabled.
Parameter(s):
true
, the transform controls are disabled and the local transform for this node is overridden to be identity.Since:
void : setLocalTransformIgnored( Boolean onOff )
Sets whether or not the local transform of this node is ignored.
Parameter(s):
true
, the local transform for this node is not applied to any associated geometry.Since:
void : setManipOverColor( Color color )
Sets the override color to be used to draw the node while using manipulation draw styles.
Parameter(s):
void : setObject( DzObject object )
Sets the object for this node.
Parameter(s):
void : setOrientation( DzQuat orientation, Boolean makeDefault=false )
Sets the orientation for this node.
Parameter(s):
void : setOrientationAngles( DzVec3 angles, Boolean makeDefault=false )
Sets the orientation for this node.
Parameter(s):
void : setOrigin( DzVec3 origin, Boolean makeDefault=false )
Sets the origin for this node.
Parameter(s):
void : setPointAtStrength( Number strength )
Set the strength of the point at parameter.
Parameter(s):
void : setPointAtTarget( DzNode target )
Set the target for this node to be pointed toward.
Parameter(s):
void : setPresentation( DzPresentation pres )
Sets the presentation for this node.
Parameter(s):
void : setPreviewBox( DzOrientedBox3 box )
Sets the preview box for this node.
Parameter(s):
void : setPromoteSelection( Boolean onOff )
Sets whether or not to redirect selection.
Parameter(s):
true
, the node will redirect its selection to its parent.void : setRotationOrder( DzRotationOrder order )
Sets the node rotation order.
Parameter(s):
void : setSelectable( Boolean onOff )
Sets whether or not this node is selectable via the 3D viewport.
Parameter(s):
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):
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):
void : setToolLocalRot( DzQuat rotLocal )
Sets the local-space rotation for this node, in the context of the current tool.
Parameter(s):
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):
Since:
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):
Since:
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):
Since:
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):
Since:
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):
Since:
void : setToolWSRot( DzTime tm, DzQuat rotWS )
Sets the world-space rotation for this node, in the context of the current tool.
Parameter(s):
Since:
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):
Since:
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):
Since:
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):
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):
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):
true
, the node is visible during a simulation, otherwise it is not.Since:
void : setVisibleInViewport( Boolean onOff )
Sets whether or not this node is visible in the 3D viewport.
Parameter(s):
true
, the node will be visible (the default). If false
, the node will not be drawn in the 3D viewport.Since:
void : setWSPos( DzVec3 posWS )
Sets the world-space translation for this node at the current time.
Parameter(s):
void : setWSPos( DzTime tm, DzVec3 posWS )
Sets the world-space translation for this node.
Parameter(s):
void : setWSRot( DzQuat rotWS )
Sets the world-space rotation for this node at the current time.
Parameter(s):
void : setWSRot( DzTime tm, DzQuat rotWS )
Sets the world-space rotation for this node.
Parameter(s):
void : setWSScale( DzTime tm, DzMatrix3 scaleWS )
Sets the world-space scale for this node.
Parameter(s):
void : setWSScale( DzMatrix3 scaleWS )
Sets the world-space scale for this node at the current time.
Parameter(s):
void : setWSTransform( DzVec3 posWS, DzQuat rotWS, DzMatrix3 scaleWS )
Sets the world-space transform values for this node at the current time.
Parameter(s):
void : setWSTransform( DzTime tm, DzVec3 posWS, DzQuat rotWS, DzMatrix3 scaleWS )
Sets the world-space transform values for this node.
Parameter(s):
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):
true
, the node should prepare itself for a render quality presentation. This is typically only set true
when performing an “offline” render, otherwise it should be set false
(default) to prevent thrashing of the geometry cache.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):
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):
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):
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):
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):
void : parentChanged( DzNode node, DzNode oldParent, DzNode newParent )
Signature:“parentChanged(DzNode*,DzNode*,DzNode*)”
Emitted when the parent of this node changes.
Parameter(s):
void : parentHierarchyChanged( DzNode node )
Signature:“parentHierarchyChanged(DzNode*)”
Emitted when the parent hierarchy for this node has changed.
Parameter(s):
void : promoteSelectionChanged( Boolean promoteSelection )
Signature:“promoteSelectionChanged(bool)”
Emitted when this node's selection promotion has changed.
Parameter(s):
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)”
Emitted when the selection state of this node changes.
Parameter(s):
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:
void : visibilityInSimulationChanged()
Signature:“visibilityInSimulationChanged()”
Emitted when the visibility of the node in simulations has changed.
Since:
void : visibilityInViewportChanged()
Signature:“visibilityInViewportChanged()”
Emitted when the visibility of the node in viewports has changed.
Since: