DzDForm Class Reference
[Scene Items]

Base class for dforms. More...

Inheritance diagram for DzDForm:

DzNode DzElement DzBase QObject Object List of all members.

Methods

void applyToNode (DzNode node)
Number getAvatarScale ()
DzDFormBase getBase ()
Color getGradientMax ()
Color getGradientMin ()
DzDFormModifier getModifier (Number index)
Number getNumModifiers ()
Number getOpacity ()
DzDFormZone getZone ()
void setAvatarScale (Number val)
void setBase (DzDFormBase base)
void setGradientMax (Color color)
void setGradientMin (Color color)
void setOpacity (Number val)
void setZone (DzDFormZone zone)

Constructors

 DzDForm ()

Detailed Description

Base class for dforms.

The DForm is the primary component of a DForm deformer. The others are the DzDFormBase, DzDFormZone and DzDFormModifier.

Constructor & Destructor Documentation

DzDForm::DzDForm (  ) 

Default Constructor.

Member Function Documentation

void DzDForm::applyToNode ( DzNode  node  ) 

Adds the effect of this DForm to the given node

Parameters:
node A pointer to the node to apply this D-Form's affect to.

Number DzDForm::getAvatarScale (  ) 

Returns:
The avatar scale factor for the representation of the DFormer

DzDFormBase DzDForm::getBase (  ) 

Returns:
The DForm Base.

Color DzDForm::getGradientMax (  ) 

Returns:
The color used in the gradient for weights at the maximum end of the scale.

Color DzDForm::getGradientMin (  ) 

Returns:
The color used in the gradient for weights at the minimum end of the scale.

DzDFormModifier DzDForm::getModifier ( Number  index  ) 

Gets the ith Modifier of the DForm. The index is zero based. Can be used with getNumTargets to iterate over all the DForm Modifiers.

Parameters:
i The index of the modifier to return.
Returns:
The target Modifier at the requested index

Number DzDForm::getNumModifiers (  ) 

Returns:
The number of DForm modifiers that are driven by this DForm.

Number DzDForm::getOpacity (  ) 

Returns:
The opacity for the representation of the DFormer

DzDFormZone DzDForm::getZone (  ) 

Returns:
The DForm Zone.

void DzDForm::setAvatarScale ( Number  val  ) 

Sets the avatar scale factor of the DForm representation

Parameters:
val The new avatar scale factor for the DForm - 1.0 maintains 100% scale.

void DzDForm::setBase ( DzDFormBase  base  ) 

Sets the Base for this DForm.

Parameters:
base The DForm Base.

void DzDForm::setGradientMax ( Color  color  ) 

Sets the Color used in the gradient for weights at the maximum end of the scale

Parameters:
color The color to use for representing maximum weights

void DzDForm::setGradientMin ( Color  color  ) 

Sets the Color used in the gradient for weights at the minimum end of the scale

Parameters:
color The color to use for representing minimum weights

void DzDForm::setOpacity ( Number  val  ) 

Sets the opacity of the DForm representation

Parameters:
val The new opacity for the DForm - 0.0 is completely transparent, 1.0 is completely opaque.

void DzDForm::setZone ( DzDFormZone  zone  ) 

Sets the Zone for this DForm.

Parameters:
zone The DForm Zone.

Generated on Thu Sep 24 12:21:11 2009

Copyright © 2002 - 2009 DAZ 3D, Inc.