User Tools

Site Tools


DzMorph

A three dimensional displacement map for a mesh.

More...

Inherits :

Properties

Constructors

DAZ Script
DzMorph ()
DzMorph ( DzMorphDeltas deltas )

Methods

Signals

Detailed Description

Sometimes referred to as a “morph target”, a “blendshape”, or a “shape key”, a morph is a specialization of DzModifier that moves the position of vertices in the geometry of an object in discrete directions in order to produce a pre-defined shape.

The pre-defined shape is defined relative to the base shape of the object, in local space, and is applied according to a weight that is supplied by a value control. This weight defines the amplitude by which a given vertex in the morph is linearly moved along the vector created between its position in the base shape of the object and its position in the pre-defined shape.

See Also:

Properties


DzAuthor : assetAuthor

Holds the author of the file for this modifier. (Read Only)

Since:

  • 4.8.1.21

DzVersion : assetFileRevision

Holds the revision version of the asset file for this modifier. (Read Only)

Since:

  • 4.8.1.21

String : assetId

Holds the asset id for this modifier.

Since:

  • 4.8.1.18

Date : assetModifiedDate

Holds the modified date of the asset file for this modifier. (Read Only)

Since:

  • 4.8.1.21

Boolean : assetNeedSave

Holds whether or not the asset for this modifier needs to be saved. (Read Only)

Since:

  • 4.11.0.249

DzUri : assetSource

Holds the URI of the asset source for this modifier; only valid when the asset is in an embedded state - i.e. modified. (Read Only)

Since:

  • 4.8.1.21

DzUri : assetUri

Holds the asset URI for this modifier. (Read Only)

Since:

  • 4.8.1.18

Constructors


DzMorph()

Default Constructor. Creates a new morph. The morph will create its own empty deltas.


DzMorph( DzMorphDeltas deltas )

Creates a new morph with the given set of deltas.

Parameter(s):

  • deltas - The deltas to create the morph with.

Methods


DzError : clearDeltasOnVertexSelection( DzVertexMesh mesh, Boolean selected=true, Boolean writeToStatusLine=true )

Clears the deltas of the selected vertices on mesh.

Parameter(s):

  • mesh - The mesh to clear deltas on.
  • selected - If true, the selected vertices are cleared. If false, the non-selected vertices are cleared.
  • writeToStatusLine - If , writes processing data to status line.

Return Value:

  • DZ_NO_ERROR on success; DZ_ILLEGAL_ARGUMENT_ERROR if mesh is null; DZ_NO_MATCH_ERROR if no deltas were cleared; DZ_DOES_NOT_EXIST_ERROR if the current deltas are empty; DZ_OPERATION_FAILED_ERROR if current deltas fail to load.

Since:

  • 4.10.0.32

DzMorphDeltas : getDeltas()

Return Value:

  • The deltas used by this morph.

Number : getHDLimit()

Return Value:

  • The limit for the active level of a High Definition (HD) morph.

Since:

  • 4.6.0.99

DzFloatProperty : getValueControl()

Return Value:

  • The property that controls the strength of this modifier.

Since:

  • 4.9.3.137

Boolean : modifyAsset( DzUri newUri )

Marks the asset as being modified.

Parameter(s):

  • newUri - The new file URI for the asset.

Return Value:

  • true if the asset at the specified URI is marked as modified, otherwise false.

Boolean : modifyAsset()

Marks the asset as being modified.

Return Value:

  • true if the asset is marked as modified, otherwise false.

void : setDeltas( DzMorphDeltas deltas )

Replace the delta set that this morph is using.

Parameter(s):

  • deltas - The new deltas for the morph. Delta sets are reference counted and so can be shared between multiple morphs.

void : setHDLimit( Number limit )

Sets the limit for the active level of a High Definition (HD) morph.

Parameter(s):

  • limit - The limit to set.

Since:

  • 4.6.0.99

DzFloatProperty : getValueChannel()

Deprecated

Use getValueControl() instead.

Signals


void : assetModified()

Signature:“assetModified()”

Emitted when the deltas for the morph have been modified.


void : assetWasSaved()

Signature:“assetWasSaved()”

Emitted when the deltas for the morph have been saved.


void : deltasChanged()

Signature:“deltasChanged()”

Emitted when the deltas for the morph has changed.


void : hdLimitChanged()

Signature:“hdLimitChanged()”

Emitted when the high definition (HD) deltas for the morph have changed.