DzPoserJointParam Class Reference
[Object and Geometry Objects]

Base class for a poser joint binding. More...

Inheritance diagram for DzPoserJointParam:

DzElement DzBase QObject Object DzPoserBendParam DzPoserCurve DzPoserSmoothScale DzPoserTwistParam List of all members.

Enumerations



enum  ParamAxis {
  X = 0, Y = 1, Z = 2, XY = 3,
  XZ = 4, YZ = 5
}
enum  ParamType { Rotation, Scale }

Properties

Boolean applyMatrices
ParamAxis axis
DzMatrix4 dynamicMatrix
Boolean flipped
DzMatrix4 staticMatrix
ParamType type

Methods

void addWeightMap (DzWeightMap map)
void beginEdit ()
void cancelEdit ()
void finishEdit ()
DzBone getDriver ()
Number getNumWeightMaps ()
void getRiggingProperties (Array list, Boolean includeSpheres=false)
DzWeightMap getWeightMap (Number index)
DzWeightMap getWeights (DzNode node, DzVertexMesh preWeightGeom)
DzWeightMap getWeights (DzNode node)
void removeWeightMap (Number index)
void setDriver (DzBone driver)
DzError setLabel (String name)
void setMatrices (DzMatrix4 dynamicMat, DzMatrix4 staticMat, Boolean makeDefault=false)

Signals

void bindingChanged ()
 Signature: "bindingChanged()"
void removed (DzPoserJointParam param)
 Signature: "removed(DzPoserJointParam*)"

Detailed Description

Base class for a poser joint binding.


Member Enumeration Documentation

enum DzPoserJointParam::ParamAxis

The Axes that a joint parameter can operate on

Enumerator:
X  The X axis
Y  The Y axis
Z  The Z axis
XY  The X and Y axes (curve parameters only)
XZ  The X and Z axes (curve parameters only)
YZ  The Y and Z axes (curve parameters only)

enum DzPoserJointParam::ParamType

The types of Joint Parameters

Enumerator:
Rotation  A parameter that controls blending for joint rotations
Scale  A parameter that controls blending for scaling between nodes


Member Function Documentation

DzPoserJointParam::addWeightMap ( DzWeightMap  map  ) 

Parameters:
map The weight map to add to this joint parameter.

void DzPoserJointParam::beginEdit (  ) 

Begins an editing operation on the joint parameter. All changes made between the beginEdit() call and the finishEdit() or cancelEdit() call will be added to a single undo operation.

See also:
finishEdit(), cancelEdit()

Reimplemented from DzElement.

void DzPoserJointParam::bindingChanged (  )  [signal]

Signature: "bindingChanged()"

Emitted when the binding needs to be re-evaluated.

void DzPoserJointParam::cancelEdit (  ) 

Cancels an editing operation started with a beginEdit() call and rolls back any changes.

See also:
beginEdit(), finishEdit()

Reimplemented from DzElement.

void DzPoserJointParam::finishEdit (  ) 

Ends an editing operation started with a beginEdit() call and adds the undo item to the undo stack.

See also:
beginEdit(), cancelEdit()

Reimplemented from DzElement.

DzBone DzPoserJointParam::getDriver (  ) 

Returns:
The node that this joint is bound to.
See also:
setDriver()

int DzPoserJointParam::getNumWeightMaps (  ) 

Returns:
The number of vertex weight maps that exist on this joint parameter.

DzPoserJointParam::getRiggingProperties ( Array  list,
Boolean  includeSpheres = false 
)

Get the rigging properties for this joint parameter.

Parameters:
list The Array to populate with pointers to the rigging properties for this joint parameter.
includeSpheres Whether or not to include the properties for the associated spheres

DzWeightMap DzPoserJointParam::getWeightMap ( Number  index  ) 

Returns:
A pointer to the vertex weight map at the index specified, for this joint parameter.

DzWeightMap DzPoserJointParam::getWeights ( DzNode  node,
DzVertexMesh  preWeightGeom 
)

Returns:
A pointer to the current vertex weight map for this joint parameter.

DzWeightMap DzPoserJointParam::getWeights ( DzNode  node  ) 

Returns:
A pointer to the current vertex weight map for this joint parameter.

void DzPoserJointParam::removed ( DzPoserJointParam  param  )  [signal]

Signature: "removed(DzPoserJointParam*)"

Emitted when the parameter is removed from a joint.

DzPoserJointParam::removeWeightMap ( Number  index  ) 

Removes the weight map at the index specified, for this joint parameter.

void DzPoserJointParam::setDriver ( DzBone  driver  ) 

Sets the node that drives this joint.

Parameters:
driver The node that this joint is bound to.

DzError DzPoserJointParam::setLabel ( String  name  ) 

Set the user-defined label that is displayed in the interface for this object.

Parameters:
name The new label for the element.

Reimplemented from DzElement.

void DzPoserJointParam::setMatrices ( DzMatrix4  innerMat,
DzMatrix4  outerMat,
Boolean  makeDefault = false 
)

Sets the matrices (sphere zones) for the binding calculation

Parameters:
dynamicMat The dynamic (inner) matrix
staticMat The static (outer) matrix
See also:
staticMatrix, dynamicMatrix


Member Data Documentation

bool DzPoserJointParam::applyMatrices

This property determines whether or not the 'sphere zone' matrices are used when caclulating vertex weights for the joit parameter.

ParamAxis DzPoserJointParam::axis

The axis of rotation (or scale) that the parameter affects. Curve zone parameters always affect 2 axes, all other parameters can only have affect on 1 axis.

DzMatrix4 DzPoserJointParam::dynamicMatrix

This property holds the inner, or 'dynamic' matrix for the parameter.

Boolean DzPoserJointParam::flipped

Whether or not the parameter is 'flipped'.

DzMatrix4 DzPoserJointParam::staticMatrix

This property holds the outer, or 'static' matrix for the parameter.

ParamType DzPoserJointParam::type

The type (Scale/Rotation) of the parameter (Read Only)


Generated on Thu Sep 24 12:21:14 2009

Copyright © 2002 - 2009 DAZ 3D, Inc.