DzSkeleton Class Reference
[Scene Items]

The base class which owns a group of connected bones. More...

Inheritance diagram for DzSkeleton:

DzNode DzElement DzBase QObject Object List of all members.

Methods

void addWeld (DzWeld weld)
DzBone findBone (String name)
DzBone findBoneByLabel (String label)
Array getAllBones ()
DzSkeletonProperty getFollowControl ()
DzSkeleton getFollowTarget ()
Number getNumWelds ()
DzWeld getWeld (Number which)
void removeWeld (DzWeld weld)
void setFollowTarget (DzSkeleton skeleton)

Constructors

 DzSkeleton ()

Signals

void followTargetChanged (DzSkeleton skeleton)
 Signature: "followTargetChanged(DzSkeleton*)"
void weldListChanged ()
 Signature: "weldListChanged()"

Detailed Description

The base class which owns a group of connected bones.

Constructor & Destructor Documentation

DzSkeleton::DzSkeleton (  ) 

Default Constructor.

Member Function Documentation

void DzSkeleton::addWeld ( DzWeld  weld  ) 

Adds a welding operation to this figure.

Parameters:
weld A pointer to the new welding operation to add for the figure. DzSkeleton takes ownership of this pointer and deletes it when it is no longer used.

DzBone DzSkeleton::findBone ( String  name  ) 

Returns:
A bone in this skeleton's hierarchy with a matching name, or NULL if none was found.

DzBone DzSkeleton::findBoneByLabel ( String  name  ) 

Parameters:
label The label of the bone to look for.
Returns:
A bone in this skeleton's hierarchy with a matching label, or NULL if none was found.

void DzSkeleton::followTargetChanged ( DzSkeleton  skeleton  )  [signal]

Signature: "followTargetChanged(DzSkeleton*)"

Emitted when the follow target for this skeleton has changed.

Array DzSkeleton::getAllBones (  ) 

Provided for DAZ Script access. Plugin developers should use the more efficient getAllBones( DzBoneList& ) overload of this method.

Returns:
A QObjectList containing all bones that are part of this skeleton.

DzSkeletonProperty DzSkeleton::getFollowControl (  ) 

Returns:
The following control property.
See also:
getFollowTarget(), setFollowTarget()

DzSkeleton DzSkeleton::getFollowTarget (  ) 

Returns:
The figure that we are currently following, NULL if none.
See also:
setFollowTarget(), getFollowControl()

Number DzSkeleton::getNumWelds (  ) 

Returns:
The number of welding operations for this figure.

DzWeld DzSkeleton::getWeld ( Number  which  ) 

Parameters:
which The index of the weld item to return from the list.
Returns:
The welding operation for this figure at the given index.

void DzSkeleton::removeWeld ( DzWeld  weld  ) 

Removes a welding operation from this figure.

Parameters:
weld A pointer to the welding operation to remove.

void DzSkeleton::setFollowTarget ( DzSkeleton  skeleton  ) 

Sets the figure that we are currently following.

Parameters:
skeleton A pointer to the new follow target for the skeleton. If NULL, clears the figure that thsi skeleton is following.
See also:
getFollowTarget(), getFollowControl()

void DzSkeleton::weldListChanged (  )  [signal]

Signature: "weldListChanged()"

Emitted when the list of weld operations for this skeleton has changed.

Generated on Thu Sep 24 12:21:15 2009

Copyright © 2002 - 2009 DAZ 3D, Inc.