Base class for nodes that own and manage a group of connected nodes (“bones”).

More...

Inherits :

• QObject
  • DzBase
    • DzElement
      • DzNode

Inherited By : DzFigure and DzLegacyFigure

A specialization of DzNode that owns and manages a hierarchical collection of DzBone instances that form the framework, or skeletal frame, of an object that can be articulated.

A skeleton can be autonomous, can be the target of other skeletons that mimic/follow it (i.e., a “follow target”), or can be configured to mimic/follow another skeleton (i.e., a “follower”).

See Also:

• DzBone

: FollowMode

Enumerated options for the manner in which following operations are preformed.

See Also:

• getFollowMode()

• fmRedirect - Temporarily redirects ERC links established between properties associated with this skeleton to the same named properties in the follow target (if any), while this skeleton is following said target.
  • See Also:
    • DzProperty::getNumControllers()
    • DzProperty::getController()
    • DzERCLink
• fmAutoFollow - Matches the names of properties associated with this skeleton (that are configured to allow auto-follow) to the same named properties in the follow target (if any), in order to replicate their respective values, while this skeleton is following said target.
  • See Also:
    • DzProperty::canAutoFollow()

DzNode : convertFigureToProp( DzSkeleton skeleton, String nodeName )

Converts an articulate figure to a static prop.

Parameter(s):

• srcSkeleton - The skeleton to convert.
• nodeName - The name to assign to the new prop.

DzSkeleton()

Default Constructor.

void : clearGeneratedMorphs()

Clears the generated morphs.

DzBone : findBone( String name )

Parameter(s):

• name - The name of the bone to look for.

Return Value:

• The bone in this skeleton's hierarchy with a matching name (if any), otherwise NULL.

DzBone : findBoneByLabel( String label )

Parameter(s):

• label - The label of the bone to look for.

Return Value:

• The bone in this skeleton's hierarchy with a matching label (if any), otherwise NULL.

Array : getAllBones()

Return Value:

• A list containing all bones that are part of this skeleton.

Boolean : getDrawGLBones()

Return Value:

• true if OpenGL bones will draw in the viewport, otherwise false.

DzBoolProperty : getDrawGLBonesControl()

Return Value:

• The boolean property that controls bone drawing in the viewport.

DzFloatProperty : getFigureIDControl()

Return Value:

• The float property that controls the figure identifier.

Since:

• 4.6.2.42

DzSkeletonProperty : getFollowControl()

Return Value:

• The property that controls which skeleton this skeleton will follow.

See Also:

• getFollowTarget()
• setFollowTarget()

DzFollowingProjectionOptions : getFollowingProjectionOptions()

Return Value:

• The following projection options for this skeleton.

FollowMode : getFollowMode()

Return Value:

• The current follow mode of this skeleton.

Since:

• 4.8.0.23

DzEnumProperty : getFollowModeControl()

Return Value:

• The enum property that controls the follow mode of this skeleton.

Since:

• 4.8.0.23

DzSkeleton : getFollowSkeleton( Number which )

Return Value:

• The i'th skeleton following this one.

DzSkeleton : getFollowTarget()

Return Value:

• The skeleton that this skeleton is currently following (if any), otherwise NULL.

See Also:

• setFollowTarget()
• getFollowControl()

DzColorProperty : getGLBonesColorControl()

Return Value:

• The color property that controls bone color in the viewport.

DzFloatProperty : getGLBonesEdgeOpacityControl()

Return Value:

• The float property that controls bone edge opacity in the viewport.

DzEnumProperty : getGLBonesEdgeStyleControl()

Return Value:

• The enum property that controls bone edge style in the viewport.

DzFloatProperty : getGLBonesFillOpacityControl()

Return Value:

• The float property that controls bone fill opacity in the viewport.

Number : getNumFollowSkeletons()

Return Value:

• The number of skeletons following this one.

String : getUniqueBoneLabel( String label, DzBone bone=null )

Parameter(s):

• label - The bone label to make unique; any trailing space/digits will automatically be stripped.
• bone - The bone that the label is intended for; may be null; this bone will be ignored when validating uniqueness.

Return Value:

• label if the value provided is already unique, otherwise label with a suffix that causes it to be unique.

Since:

• 4.12.0.66

String : getUniqueBoneName( String name, DzBone bone=null )

Parameter(s):

• name - The bone name to make unique; any trailing space/digits will automatically be stripped.
• bone - The bone that the name is intended for; may be null; this bone will be ignored when validating uniqueness.

Return Value:

• name if the value provided is already unique, otherwise name with a suffix that causes it to be unique.

Since:

• 4.12.0.66

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.

void : setDrawGLBones( Boolean onOff )

Sets whether or not OpenGL bones will draw in the viewport.

Parameter(s):

• onOff - If true, bones will be drawn in the viewport.

void : setFollowTarget( DzSkeleton skeleton )

Sets the figure that we are currently following.

Parameter(s):

• skeleton - The new follow target for this skeleton. If NULL, clears the figure that this skeleton is following.

See Also:

• getFollowTarget()
• getFollowControl()

void : followTargetChanged( DzSkeleton skeleton )

Signature:“followTargetChanged(DzSkeleton*)”

Emitted when the follow target for this skeleton has changed.