User Tools

Site Tools


DzLegacyFigure

Implements a parametrically defined (“legacy”) figure.

More...

Inherits :

Static Methods

DAZ Script
DzLegacyFigureconvertPropToFigure ( DzNode srcNode, String rootBoneName, Boolean inheritSkeleton=true )

Constructors

DAZ Script
DzLegacyFigure ()

Methods

Signals

Detailed Description

Used to implement all figure content from the pre-Genesis era. Its API is as similar to DzFigure as possible.

When loading legacy content, the application takes all geometry that would have previously been assigned to the individual bone instances for the figure and internally represents it as a “single skin” object owned by this class, in order to simplify/streamline the geometry pipeline. As such, the DzBone instances belonging to this figure no longer have a DzObject of their own.

Attention:

  • As of version 4.0.1.34, DzMorph instances are only found on this node's DzObject, as opposed to the individual DzBone instances. All morph properties previously associated with the individual bones are now aliases to the morph properties rather than morph properties themselves.

See Also:

Static Methods


DzLegacyFigure : convertPropToFigure( DzNode srcNode, String rootBoneName, Boolean inheritSkeleton=true )

Attempts to convert a simple node with geometry into a figure.

Parameter(s):

  • srcNode - The source node to convert.
  • rootBoneName - The name to assign to the root bone of the figure.
  • inheritSkeleton - If true (default), …

Return Value:

  • The figure produced by the conversion (if any), otherwise NULL.

Constructors


DzLegacyFigure()

Default Constructor.

Methods


DzLegacyAlternateGeometry : addAlternateGeometry( DzBone bone, Boolean createAlais=true )

Adds an alternate geometry to this figure for the specified bone - if one does not already exist.

Parameter(s):

  • bone - The bone to add an alternate geometry for.
  • createAlias - If true, an alias for the property that controls the shape of the object is created on the specified bone.

Return Value:

  • The alternate geometry associated with the specified bone.

See Also:


void : addWeld( DzWeld weld )

Adds a welding operation to this figure.

Parameter(s):

  • weld - The welding operation to add to the figure. This figure takes ownership of the object and deletes it when it is no longer used.

Boolean : boneUsedByWeld( DzBone bone )

Parameter(s):

  • bone - The bone to check.

Return Value:

  • true if the specified bone is used by a weld operation, otherwise false.

void : clearVertexMaps()

Clears vertex maps - causes vertex weights to be recalculated.


DzLegacyAlternateGeometry : findAlternateGeometry( DzBone bone )

Attempts to find an alternate geometry on this figure for a specified bone.

Parameter(s):

  • bone - The bone to find an alternate geometry for.

Return Value:

  • The alternate geometry associated with the specified bone (if any), otherwise null.

DzLegacyAlternateGeometry : findAlternateGeometry( String boneName )

Attempts to find an alternate geometry on this figure for a bone with the specified name.

Parameter(s):

  • boneName - The name of the bone to find an alternate geometry for.

Return Value:

  • The alternate geometry associated with the specified bone (if any), otherwise null.

DzWeld : findWeldByTargetBone( DzBone target )

Parameter(s):

  • target - The bone whose geometry is not modified to find the weld operation for.

Return Value:

  • The weld operation for the specified bone (if any), otherwise null.

DzWeld : findWeldByWeldBone( DzBone weldBone )

Parameter(s):

  • weldBone - The bone whose geometry is modified to find the weld operation for.

Return Value:

  • The weld operation for the specified bone (if any), otherwise null.

DzLegacyAlternateGeometry : getAlternateGeometry( Number index )

Parameter(s):

  • index - The index of the alternate geometry to retrieve.

Return Value:

  • The alternate geometry at the specified index (if valid), otherwise null.

Number : getNumAlternateGeometries()

Return Value:

  • The number of alternate geometries fro this figure.

Number : getNumWelds()

Return Value:

  • The number of welding operations for this figure.

DzWeld : getWeld( Number which )

Parameter(s):

  • which - The index of the welding operation to retrieve.

Return Value:

  • The welding operation at the specified index (if valid), otherwise null.

void : invalidateVertexMaps()

Invalidates vertex maps - causes vertex weights to be recalculated.


void : removeAllWelds()

Removes all welding operations from this figure.


bool : removeAlternateGeometry( DzLegacyAlternateGeometry alt )

Parameter(s):

  • alt - The alternate geometry to remove.

Return Value:

  • true if the alternate geometry is removed, otherwise false.

void : removeWeld( DzWeld weld )

Removes a welding operation from this figure.

Parameter(s):

  • weld - The welding operation to remove.

Signals


void : weldListChanged()

Signature:“weldListChanged()”

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