User Tools

Site Tools


DzWeightMap

A map of vertex indices and the weights (values) associated to them.

More...

Inherits :

Constructors

DAZ Script
DzWeightMap ()

Methods

Signals

Detailed Description

TODO: Add detailed description.

Constructors


DzWeightMap()

Constrictor. Creates a new weight map.

See Also:

Methods


void : clearAffectedWeights()

Clears the values of affected weights in this map.


void : detach()

After making a shallow copy with the copy() method, this method can be used to “detach” the shallow copy, making it a deep copy that no longer shares its weight map values.


void : empty()

Empties this weight map and frees the data for the vertex weight array.


Number : getFloatWeight( Number idx )

Parameter(s):

  • idx - The index of the vertex to get the weight for.

Return Value:

  • The floating point equivalent (0.0 - 1.0) of the weight at the given index in the map.

Number : getNumAffected()

Return Value:

  • The number of vertices in this weight map that are affected.

Number : getNumWeights()

Return Value:

  • The number of weights for this map.

DzFloatProperty : getStrengthControl()

Return Value:

  • The (private) property that controls the strength at which to apply this weight map.

Since:

  • 4.15.1.76

Boolean : hasNonZeroWeight()

Return Value:

  • true if this weight map contains any non-zero weights, otherwise false.

Boolean : isEmpty()

Return Value:

  • true if this weight map has no data, otherwise false.

Boolean : isLocked()

Return Value:

  • true if the weight values in this map should be considered non-editable when normalization examines this map.

Boolean : isPersistent()

Return Value:

  • true if the weight values need to be stored in the file, otherwise false.

void : merge( DzWeightMap map )

Merges the given weight map with this weight map.

Parameter(s):

  • map - The weight map to merge.

Merges the given weight map with this weight map.

Parameter(s):

  • map - The weight map to merge.
  • mergVertMap - A map of the vertex indices to merge.

void : setFloatWeight( Number idx, Number weight )

Parameter(s):

  • idx - The index of the vertex to set the weight for.
  • weight - The floating point equivalent (0.0 - 1.0) of the weight at the given index in the map.

See Also:

Since:

  • 4.15.0.4

void : setLocked( Boolean onOff )

Sets whether or not the weight values should be considered locked when normalization examines this map.

Parameter(s):

  • onOff - If true, the weight values should be considered non-editable when normalization examines this map.

void : setNumWeights( Number nWeights, Boolean keepExisting=false )

Sets the number of weights for the map, and resizes the data array.

Parameter(s):

  • nWeights - The new number of weights (vertices) for the map.
  • keepExisting - Whether or not to keep existing weights within the specified range.

void : setPersistent( Boolean onOff )

Sets whether or not the weight values need to be stored in the file.

Parameter(s):

  • onOff - If true, the weight values need to be stored in the file.

DzFloatProperty : getStrengthController()

Deprecated

Exists only to keep old code working. Do not use in new code. Use getStrengthControl() instead.

Signals


void : weightValuesChanged()

Signature:“weightValuesChanged()”

Emitted when the weights in this map have changed.