DzNode Class Reference
[Scene Items]

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

Inheritance diagram for DzNode:

DzElement DzBase QObject Object DzBone DzCamera DzDForm DzDFormBase DzDFormZone DzSkeleton DzBasicCamera DzLight DzShaderCamera DzDistantLight DzShaderLight DzPointLight DzSpotLight List of all members.

Properties

DzRenderMgr::RenderPriority renderPriority

Methods

DzError addNodeChild (DzNode child, Boolean inPlace=false)
void beginEdit ()
void cancelEdit ()
Boolean castsShadow ()
void clearAllTransformData ()
void clearManipOverColor ()
void clearTransformData (DzTimeRange range)
void finalize (Boolean isRender=false)
DzNode findNodeChild (String name, Boolean scanHierarchy=false)
void finishEdit ()
DzVec3 getEndPoint ()
DzFloatProperty getEndXControl ()
DzFloatProperty getEndYControl ()
DzFloatProperty getEndZControl ()
DzBox3 getLocalBoundingBox ()
DzOrientedBox3 getLocalOrientedBox ()
DzVec3 getLocalPos (DzTime tm)
DzVec3 getLocalPos ()
DzQuat getLocalRot (DzTime tm)
DzQuat getLocalRot ()
DzMatrix3 getLocalScale (DzTime tm)
DzMatrix3 getLocalScale ()
DzMatrix3 getLocalTransform (DzTime tm)
DzMatrix3 getLocalTransform ()
DzNode getNodeChild (Number i)
Array getNodeChildren (Boolean scanHierarchy=false)
DzNode getNodeParent ()
Number getNumNodeChildren ()
DzObject getObject ()
DzVec3 getOffsetA ()
DzVec3 getOffsetB ()
DzQuat getOrientation ()
DzFloatProperty getOrientXControl ()
DzFloatProperty getOrientYControl ()
DzFloatProperty getOrientZControl ()
DzVec3 getOrigin ()
DzFloatProperty getOriginXControl ()
DzFloatProperty getOriginYControl ()
DzFloatProperty getOriginZControl ()
DzNumericNodeProperty getPointAtControl ()
DzEnumProperty getRenderPriorityControl ()
DzBoolProperty getRenderVisibilityControl ()
DzRotationOrder getRotationOrder ()
DzFloatProperty getScaleControl ()
DzBoolProperty getSelectabilityControl ()
DzBoolProperty getShadowControl ()
DzSkeleton getSkeleton ()
DzBoolProperty getVisibilityControl ()
DzBox3 getWSBoundingBox ()
DzOrientedBox3 getWSOrientedBox ()
DzVec3 getWSPos (DzTime tm)
DzVec3 getWSPos ()
DzQuat getWSRot (DzTime tm)
DzQuat getWSRot ()
DzMatrix3 getWSScale (DzTime tm)
DzMatrix3 getWSScale ()
DzMatrix3 getWSTransform (DzTime tm)
DzMatrix3 getWSTransform ()
DzFloatProperty getXOffsetAControl ()
DzFloatProperty getXOffsetBControl ()
DzFloatProperty getXPosControl ()
DzFloatProperty getXRotControl ()
DzFloatProperty getXScaleControl ()
DzFloatProperty getYOffsetAControl ()
DzFloatProperty getYOffsetBControl ()
DzFloatProperty getYPosControl ()
DzFloatProperty getYRotControl ()
DzFloatProperty getYScaleControl ()
DzFloatProperty getZOffsetAControl ()
DzFloatProperty getZOffsetBControl ()
DzFloatProperty getZPosControl ()
DzFloatProperty getZRotControl ()
DzFloatProperty getZScaleControl ()
Boolean inheritsScale ()
Boolean isHidden ()
Boolean isNodeChild (DzNode node)
Boolean isRootNode ()
Boolean isSelectable ()
Boolean isSelected ()
Boolean isVisible ()
void removeAllNodeChildren ()
DzError removeNodeChild (DzNode child, Boolean inPlace=false)
void select (Boolean onOff=true)
void setEndPoint (DzVec3 endPnt, Boolean makeDefault=false)
void setHidden (Boolean onOff)
void setInheritScale (Boolean onOff)
void setLocalPos (DzTime tm, DzVec3 pos)
void setLocalPos (DzVec3 pos)
void setLocalRot (DzTime tm, DzQuat rot)
void setLocalRot (DzQuat rot)
void setLocalScale (DzTime tm, DzMatrix3 scale, Number generalScale=1.0)
void setLocalScale (DzMatrix3 scale, Number generalScale=1.0)
void setLocalTransform (DzTime tm, DzVec3 pos, DzQuat rot, DzMatrix3 scale, Number generalScale=1.0)
void setLocalTransform (DzVec3 pos, DzQuat rot, DzMatrix3 scale, Number generalScale=1.0)
void setManipOverColor (Color color)
void setObject (DzObject object)
void setOffsetA (DzVec3 offsetA, Boolean makeDefault=false)
void setOffsetB (DzVec3 offsetB, Boolean makeDefault=false)
void setOrientation (DzQuat orientation, Boolean makeDefault=false)
void setOrigin (DzVec3 origin, Boolean makeDefault=false)
void setPointAtStrength (Number strength)
void setPointAtTarget (DzNode target)
void setRotationOrder (DzRotationOrder order)
void setSelectable (Boolean onOff)
void setVisible (Boolean onOff)
void setWSPos (DzTime tm, DzVec3 pos)
void setWSPos (DzVec3 pos)
void setWSRot (DzTime tm, DzQuat rot)
void setWSRot (DzQuat rot)
void setWSScale (DzTime tm, DzMatrix3 scale)
void setWSScale (DzMatrix3 scale)
void setWSTransform (DzTime tm, DzVec3 pos, DzQuat rot, DzMatrix3 scale)
void setWSTransform (DzVec3 pos, DzQuat rot, DzMatrix3 scale)
void update (Boolean isRender=false)
void updateOrientation ()

Constructors

 DzNode ()

Signals

void aboutToBeRemoved ()
 Signature: "aboutToBeRemoved()"
void added ()
 Signature: "added()"
void childAdded (DzNode child)
 Signature: "childAdded(DzNode*)"
void childListChanged ()
 Signature: "childListChanged()"
void childRemoved (DzNode child)
 Signature: "childRemoved(DzNode*)"
void drawnDataChanged ()
 Signature: "drawnDataChanged()"
void hiddenChanged (Boolean hidden)
 Signature: "hiddenChanged(bool)"
void materialListChanged ()
 Signature: "materialListChanged()"
void materialSelectionChanged ()
 Signature: "materialSelectionChanged()"
void objectChanged (DzNode node, DzObject oldObject, DzObject newObject)
 Signature: "objectSwitched(DzNode*,DzObject*,DzObject*)"
void parentChanged (DzNode node, DzNode oldParent, DzNode newParent)
 Signature: "parentChanged(DzNode*,DzNode*,DzNode*)"
void removed ()
 Signature: "removed()"
void riggingChanged ()
 Signature: "riggingChanged()"
void rotationOrderChanged ()
 Signature: "rotationOrderChanged()"
void selectabilityChanged ()
 Signature: "selectabilityChanged()"
void selected (DzNode node, Boolean onOff)
 Signature: "selected(DzNode*,bool)"
void transformChanged ()
 Signature: "transformChanged()"
void uvsChanged ()
 Signature: "uvsChanged()"
void visibilityChanged ()
 Signature: "visibilityChanged()"

Detailed Description

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

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

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

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

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

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

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

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


Constructor & Destructor Documentation

DzNode::DzNode (  ) 

Default Constructor.


Member Function Documentation

void DzNode::aboutToBeRemoved (  )  [signal]

Signature: "aboutToBeRemoved()"

Emitted immediately before the node is removed from the scene.

void DzNode::added (  )  [signal]

Signature: "added()"

Emitted when the node is added to the scene.

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

Adds a child to this node.

Parameters:
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 DzNode::beginEdit (  ) 

Begin an edit on this node's transformation data. When called, the node will notify its transformation properties with beginEdit calls so that they can create undo items. Also calls beginEdit() on this node's object.

Reimplemented from DzElement.

void DzNode::cancelEdit (  ) 

Cancel an edit on this node's transformation data. When called, the node's transform properties are set back to their original state and the undo items are destroyed. Also calls cancelEdit() on this node's object.

Reimplemented from DzElement.

Boolean DzNode::castsShadow (  ) 

Get the current shadow-casting status of this node.

Returns:
true if the node is casting shadows, otherwise false.

DzNode::childAdded ( DzNode  node  )  [signal]

Signature: "childAdded(DzNode*)"

Emitted when a child is added to the node.

Parameters:
node The child added to the node.

void DzNode::childListChanged (  )  [signal]

Signature: "childListChanged()"

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

DzNode::childRemoved ( DzNode  node  )  [signal]

Signature: "childRemoved(DzNode*)"

Emitted when a child is removed from the node.

Parameters:
node The child removed from the node.

void DzNode::clearAllTransformData (  ) 

Removes all local transform data.

void DzNode::clearManipOverColor (  ) 

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

void DzNode::clearTransformData ( DzTimeRange  range  ) 

Removes local transform data.

Parameters:
range The timerange to clear transform data across

void DzNode::drawnDataChanged (  )  [signal]

Signature: "drawnDataChanged()"

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

void DzNode::finalize ( Boolean  isRender = false  ) 

Finalizes the node's geometry cache.

Parameters:
isRender If true, the geometry cache will be finalized for a render operation, otherwise, the geometry will be prepared for a drawing operation.

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

Get a child from this node by name.

Parameters:
name Name of the child to return.
scanHierarchy If true, this will call findChild recursively on all this node's children, scanning the hierarchy from this node down, until a child with a matching name is found.
Returns:
A child node having a matching name, NULL if no match is found.

void DzNode::finishEdit (  ) 

Finish the current edit on this node's transformation data. When called, the undo items created after the beginEdit call will be finalized and pushed on to the undo stack. Also calls finishEdit() on this node's object.

Reimplemented from DzElement.

DzVec3 DzNode::getEndPoint (  ) 

Returns:
The endpoint for this node.

DzFloatProperty DzNode::getEndXControl (  ) 

Returns:
The float property that controls the x position of the node's end point. This function will always return a valid pointer.

DzFloatProperty DzNode::getEndYControl (  ) 

Returns:
The float property that controls the y position of the node's end point. This function will always return a valid pointer.

DzFloatProperty DzNode::getEndZControl (  ) 

Returns:
The float property that controls the z position of the node's end point. This function will always return a valid pointer.

DzBox3 DzNode::getLocalBoundingBox (  ) 

Calculate the local space bounding box for this node.

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

DzOrientedBox3 DzNode::getLocalOrientedBox (  ) 

Calculate the local space bounding box for this node.

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

DzVec3 DzNode::getLocalPos ( DzTime  tm  ) 

This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.

Parameters:
tm The scene time at which to get the the transform.
Returns:
The local-space position of the node.

DzVec3 DzNode::getLocalPos (  ) 

This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.

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

DzQuat DzNode::getLocalRot ( DzTime  tm  ) 

This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.

Parameters:
tm The scene time at which to get the the transform.
Returns:
The local-space rotation of the node.

DzQuat DzNode::getLocalRot (  ) 

This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.

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

DzMatrix3 DzNode::getLocalScale ( DzTime  tm  ) 

This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.

Parameters:
tm The scene time at which to get the the transform.
Returns:
The local-space scale of the node.

DzMatrix3 DzNode::getLocalScale (  ) 

This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.

Returns:
The local-space scale of the node at the time.

DzMatrix3 DzNode::getLocalTransform ( DzTime  tm  ) 

Get the composed local transform info for this node.

Parameters:
tm The scene time at which to get the the transform.
Returns:
A Matrix representing the composed local transform for this node.

DzMatrix3 DzNode::getLocalTransform (  ) 

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

Returns:
A Matrix representing the composed local transform for this node.

DzNode DzNode::getNodeChild ( Number  i  ) 

Get the child at the given index.

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

Array DzNode::getNodeChildren ( Boolean  scanHierarchy = false  ) 

Get a list of the children of this node, with the option for immediate children only, or all children, grandchildren, etc. Provided for DAZ Script access, plugin developers should use the more efficient getNodeChildren( DzNodeList&, bool ) overload of this method.

Parameters:
scanHierarchy If true, recursively collect all this node's children, scanning the hierarchy from this node down. If false, collect only this node's immediate children. Default is false.
Returns:
A QObjectList containing the children of this node.

DzNode DzNode::getNodeParent (  ) 

Get the parent of this node.

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

Number DzNode::getNumNodeChildren (  ) 

Get the number of children attached to this node.

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

DzObject DzNode::getObject (  ) 

Get the object currently associated with this node.

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

DzVec3 DzNode::getOffsetA (  ) 

Returns:
OffsetA for this node, this is used to translate a node into position for modifiers to be applied.

DzVec3 DzNode::getOffsetB (  ) 

Returns:
OffsetB for this node, this is used to translate a node back into position after modifiers are applied.

DzQuat DzNode::getOrientation (  ) 

Returns:
The orientation of the node.

DzFloatProperty DzNode::getOrientXControl (  ) 

Returns:
The float property that controls the x rotation of the node's orientation. This function will always return a valid pointer.

DzFloatProperty DzNode::getOrientYControl (  ) 

Returns:
The float property that controls the y rotation of the node's orientation. This function will always return a valid pointer.

DzFloatProperty DzNode::getOrientZControl (  ) 

Returns:
The float property that controls the z rotation of the node's orientation. This function will always return a valid pointer.

DzVec3 DzNode::getOrigin (  ) 

Returns:
The origin of the node.

DzFloatProperty DzNode::getOriginXControl (  ) 

Returns:
The float property that controls the x position of the node's origin. This function will always return a valid pointer.

DzFloatProperty DzNode::getOriginYControl (  ) 

Returns:
The float property that controls the y position of the node's origin. This function will always return a valid pointer.

DzFloatProperty DzNode::getOriginZControl (  ) 

Returns:
The float property that controls the z position of the node's origin. This function will always return a valid pointer.

DzNumericNodeProperty DzNode::getPointAtControl (  ) 

Returns:
A pointer to the property used for tracking the point-at target. This function will always return a valid pointer.

DzEnumProperty DzNode::getRenderPriorityControl (  ) 

Returns:
A pointer to the enum property that controls the render priority of this node.

DzBoolProperty DzNode::getRenderVisibilityControl (  ) 

Returns:
The boolean property that controls render visibility of this node. This function will always return a valid pointer.

DzRotationOrder DzNode::getRotationOrder (  ) 

Get the node rotation order.

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

DzFloatProperty DzNode::getScaleControl (  ) 

Returns:
The float property that controls general scale of the node. This function will always return a valid pointer.

DzBoolProperty DzNode::getSelectabilityControl (  ) 

Returns:
The boolean property that controls selectability of this node. This function will always return a valid pointer.

DzBoolProperty DzNode::getShadowControl (  ) 

Returns:
A pointer to the boolean property that controls whether this light is casting shadows. This function will always return a valid pointer.

void DzNode::getSkeleton (  ) 

Traverse up the hierarchy and attempt to find a DzSkeleton.

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

DzBoolProperty DzNode::getVisibilityControl (  ) 

Returns:
The boolean property that controls visibility of this node. This function will always return a valid pointer.

DzBox3 DzNode::getWSBoundingBox (  ) 

Calculate a world space oriented bounding box for this node.

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

DzOrientedBox3 DzNode::getWSOrientedBox (  ) 

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

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

DzVec3 DzNode::getWSPos ( DzTime  tm  ) 

This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.

Parameters:
tm The scene time at which to get the the transform.
Returns:
The world-space position of the node.

DzVec3 DzNode::getWSPos (  ) 

This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.

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

DzQuat DzNode::getWSRot ( DzTime  tm  ) 

This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.

Parameters:
tm The scene time at which to get the the transform.
Returns:
The world-space rotation of the node.

DzQuat DzNode::getWSRot (  ) 

This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.

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

DzMatrix3 DzNode::getWSScale ( DzTime  tm  ) 

This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.

Parameters:
tm The scene time at which to get the the transform.
Returns:
The world-space scale of the node.

DzMatrix3 DzNode::getWSScale (  ) 

This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.

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

DzMatrix3 DzNode::getWSTransform ( DzTime  tm  ) 

Get the world-space transformation data for this node.

Parameters:
tm The scene time at which to get the the transform.
Returns:
A Matrix representing the composed WS transform for this node.

DzMatrix3 DzNode::getWSTransform (  ) 

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

Returns:
A Matrix representing the composed WS transform for this node.

DzFloatProperty DzNode::getXOffsetAControl (  ) 

Returns:
The float property that controls the x Offset A of the node. This function will always return a valid pointer.

DzFloatProperty DzNode::getXOffsetBControl (  ) 

Returns:
The float property that controls the x Offset B of the node. This function will always return a valid pointer.

DzFloatProperty DzNode::getXPosControl (  ) 

Returns:
The float property that controls the local x position of the node. This function will always return a valid pointer.

DzFloatProperty DzNode::getXRotControl (  ) 

Returns:
The float property that controls local rotation of the node around the x axis. This function will always return a valid pointer.

DzFloatProperty DzNode::getXScaleControl (  ) 

Returns:
The float property that controls scaling of the node along the x axis. This function will always return a valid pointer.

DzFloatProperty DzNode::getYOffsetAControl (  ) 

Returns:
The float property that controls the y Offset A of the node. This function will always return a valid pointer.

DzFloatProperty DzNode::getYOffsetBControl (  ) 

Returns:
The float property that controls the y Offset B of the node. This function will always return a valid pointer.

DzFloatProperty DzNode::getYPosControl (  ) 

Returns:
The float property that controls the local y position of the node. This function will always return a valid pointer.

DzFloatProperty DzNode::getYRotControl (  ) 

Returns:
The float property that controls local rotation of the node around the y axis. This function will always return a valid pointer.

DzFloatProperty DzNode::getYScaleControl (  ) 

Returns:
The float property that controls scaling of the node along the y axis. This function will always return a valid pointer.

DzFloatProperty DzNode::getZOffsetAControl (  ) 

Returns:
The float property that controls the z Offset A of the node. This function will always return a valid pointer.

DzFloatProperty DzNode::getZOffsetBControl (  ) 

Returns:
The float property that controls the z Offset B of the node. This function will always return a valid pointer.

DzFloatProperty DzNode::getZPosControl (  ) 

Returns:
The float property that controls the local z position of the node. This function will always return a valid pointer.

DzFloatProperty DzNode::getZRotControl (  ) 

Returns:
The float property that controls local rotation of the node around the z axis. This function will always return a valid pointer.

DzFloatProperty DzNode::getZScaleControl (  ) 

Returns:
The float property that controls scaling of the node along the z axis. This function will always return a valid pointer.

DzNode::hiddenChanged ( Boolean  hidden  )  [signal]

Signature: "hiddenChanged(bool)"

Emitted when the hidden state of this node is changed.

Parameters:
hidden true if the node is currently hidden in the interface.

bool DzNode::inheritsScale (  ) 

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

Boolean DzNode::isHidden (  ) 

Returns:
true if this node should not be shown in the interface.

Boolean DzNode::isNodeChild ( DzNode  node  ) 

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

Parameters:
node A pointer to the node to look for in this node's hierarchy.
Returns:
true if the node is a child of this node in the scene hierarchy, otherwise false.

Boolean DzNode::isRootNode (  ) 

Check to see if this is a root level node.

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

Boolean DzNode::isSelectable (  ) 

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

Boolean DzNode::isSelected (  ) 

Get the current selection state of this node

Returns:
true if the node is selected, otherwise false.

Boolean DzNode::isVisible (  ) 

Get the current visibility status of this node.

Returns:
true if the node is visible, otherwise false.

void DzNode::materialListChanged (  )  [signal]

Signature: "materialListChanged()"

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

void DzNode::materialSelectionChanged (  )  [signal]

Signature: "materialSelectionChanged()"

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

DzNode::objectChanged ( DzNode  node,
DzObject  oldObject,
DzObject  newObject 
) [signal]

Signature: "objectSwitched(DzNode*,DzObject*,DzObject*)"

Emitted when a different object becomes associated with this node.

Parameters:
node A pointer to this node.
oldObject A pointer to the prior object, or NULL if none.
newObject A pointer to the new object, or NULL if none.

DzNode::parentChanged ( DzNode  node,
DzNode  oldParent,
DzNode  newParent 
) [signal]

Signature: "parentChanged(DzNode*,DzNode*,DzNode*)"

Emitted when the parent of this node changes.

Parameters:
node A pointer to this node.
oldParent The previous parent of the node.
newParent The new parent of the node.

void DzNode::removeAllNodeChildren (  ) 

Removes all the children of this node.

void DzNode::removed (  )  [signal]

Signature: "removed()"

Emitted when the node is removed from the scene.

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

Removes a child from this node.

Parameters:
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 DzNode::riggingChanged (  )  [signal]

Signature: "riggingChanged()"

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

void DzNode::rotationOrderChanged (  )  [signal]

Signature: "rotationOrderChanged()"

Emitted when the rotation order of this node changes.

void DzNode::select ( Boolean  selected = true  ) 

Sets the selection state of this node.

Parameters:
onOff true to set selection on for this node, false to set selection off.

void DzNode::selectabilityChanged (  )  [signal]

Signature: "selectabilityChanged()"

Emitted when the selectability of the node has changed.

DzNode::selected ( DzNode  node,
Boolean  onOff 
) [signal]

Signature: "selected(DzNode*,bool)"

Eitted when the selection state of this node changes.

Parameters:
node A pointer to this node.
onOff true if the node was selected, false if it was deselected.

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

Sets the end point for this node

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

void DzNode::setHidden ( Boolean  onOff  ) 

Hide or show this node in the interface.

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

void DzNode::setInheritScale ( Boolean  onOff  ) 

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

Parameters:
onOff If true, scaling the parent of this node will scale this node also.

void DzNode::setLocalPos ( DzTime  tm,
DzVec3  pos 
)

This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts. Sets local-space translation for the node

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

void DzNode::setLocalPos ( DzVec3  pos  ) 

This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts. Sets local-space translation for the node at the current time

Parameters:
vec The local space translation for the node

void DzNode::setLocalRot ( DzTime  tm,
DzQuat  rot 
)

This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts. Sets local-space rotation for the node

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

void DzNode::setLocalRot ( DzQuat  rot  ) 

This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts. Sets local-space rotation for the node at the current time

Parameters:
val The local space rotation for the node

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

This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts. Sets local-space scale for the node

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

void DzNode::setLocalScale ( DzMatrix3  scale,
Number  generalScale = 1.0 
)

This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts. Sets local-space scale for the node at the current time

Parameters:
val The local space scale for the node
generalScale The general scale factor for the node.

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

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

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

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

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

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

void DzNode::setManipOverColor ( Color  color  ) 

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

Parameters:
color The value for the override color.

void DzNode::setObject ( DzObject  object  ) 

Sets the object for this node

Parameters:
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 DzNode::setOffsetA ( DzVec3  offsetA,
Boolean  makeDefault = false 
)

Sets the offsetA value for the node

Parameters:
offsetA The offsetA value for the node.
makeDefault Whether or not to set the default value as well as the current value.

void DzNode::setOffsetB ( DzVec3  offsetB,
Boolean  makeDefault = false 
)

Sets the offsetB value for the node

Parameters:
offsetB The offsetB value for the node.
makeDefault Whether or not to set the default value as well as the current value.

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

Sets the orientation for the node

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

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

Sets the origin for the node

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

void DzNode::setPointAtStrength ( Number  strength  ) 

Set the strength of the point at parameter

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

void DzNode::setPointAtTarget ( DzNode  target  ) 

Set the target for this node to be pointed toward

Parameters:
target The node whose centerpoint will serve as the target of point-at functionality

void DzNode::setRotationOrder ( DzRotationOrder  order  ) 

Set the node rotation order

Parameters:
order The order that the axis rotations will be applied in for this node.

void DzNode::setSelectable ( Boolean  onOff  ) 

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

Parameters:
onOff If true, the node will be selectable (the default), if false, the node will not participate in the pick image.

void DzNode::setVisible ( Boolean  onOff  ) 

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

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

void DzNode::setWSPos ( DzTime  tm,
DzVec3  pos 
)

This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts. Sets world-space translation for the node

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

void DzNode::setWSPos ( DzVec3  pos  ) 

This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts. Sets world-space translation for the node at the current time

Parameters:
vec The World-Space translation for the node

void DzNode::setWSRot ( DzTime  tm,
DzQuat  rot 
)

This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts. Sets world-space rotation for the node

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

void DzNode::setWSRot ( DzQuat  rot  ) 

This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts. Sets world-space rotation for the node at the current time

Parameters:
val The World-Space rotation for the node

void DzNode::setWSScale ( DzTime  tm,
DzMatrix3  scale 
)

This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts. Sets world-space scale for the node

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

void DzNode::setWSScale ( DzMatrix3  scale  ) 

This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts. Sets world-space scale for the node at the current time

Parameters:
val The World-Space sacle for the node

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

Set world-space transform values for this node.

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

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

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

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

void DzNode::transformChanged (  )  [signal]

Signature: "transformChanged()"

Emitted when transformation properties of this node change

void DzNode::update ( Boolean  isRender = false  ) 

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

Parameters:
isRender If true, the node should prepare itself for a render quality presentation.

void DzNode::updateOrientation (  ) 

Update the orientation of the node.

void DzNode::uvsChanged (  )  [signal]

Signature: "uvsChanged()"

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

void DzNode::visibilityChanged (  )  [signal]

Signature: "visibilityChanged()"

Emitted when the visibility of the node has changed.


Member Data Documentation

DzRenderMgr::RenderPriority DzNode::renderPriority

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

The default render priority is RENDER_PRIORITY_NORMAL.


Generated on Thu Sep 24 12:21:14 2009

Copyright © 2002 - 2009 DAZ 3D, Inc.