User Tools

Site Tools


DzFollowingProjectionOptions

Provides options for controlling morph projection from a figure to a following figure as a result of “Auto Follow.”.

More...

Inherits :

Enumerations

Properties

Methods

DAZ Script
voidaddCorrelatedMorph ( String srcMorph, String followerMorph )
voidclearCorrelatedMorphs ()
voidcopyFrom ( DzFollowingProjectionOptions other )
StringgetFollowerCorrelatedMorph ( Number which )
NumbergetNumCorrelatedMorphs ()
StringgetSourceCorrelatedMorph ( Number which )
BooleanisAtDefault ()
voidremoveCorrelatedMorph ( Number which )

Detailed Description

When a figure is “Fit to” (set to follow) another figure in the scene, the application uses a name-matching mechanism referred to as “Auto Follow” to establish relationships between properties in the following figure to the corresponding properties in the follow target. This relationship causes certain matched properties on the follower to inherit the values of the properties on the follow target.

Active morphs on the follow target, when configured to “Auto Follow,” are projected from the follow target to the follower at the moment the follower is “Fit to” the follow target; this projection only occurs if a morph target bearing the same name does not already exist on the follower. Morphs that are configured to “Auto Follow” on the follow target that were not active at the moment the follower was “Fit to” the follow target are projected as they become active. These options are used to control how (or even if) “Auto Follow” morphs are projected.

Each figure owns its own instance of this object. To modify the projection options for a follower, request the object from the figure and configure its instance rather than attempting to construct a new instance.

See Also:

Since:

  • 4.8.1.86

Enumerations


: SourceSubdivisionMode

Enum value used to control whether or not the follow target is subdivided when projecting.

  • SrcAuto - Projection will occur with the current subdivision state/resolution of the follow target.
  • SrcCage - Projection will occur with the follow target in its cage state/resolution.
  • SrcSubdivided - Projection will occur with the follow target in its subdivided state/resolution.

Properties


Number : adaptiveTolerance

Holds the tolerance used for considering the locations around the closest found location.


Boolean : considerLinesAsRigid

Holds whether or not the projection considers polylines as rigid for projection purposes.

Since:

  • 4.11.0.66

Boolean : disableMorphProjection

Holds whether or not morph projection is disabled.

Since:

  • 4.11.0.106

Number : distanceSquaredTolerance

Holds the tolerance used for determining if two (or more) locations are considered coincident.

Since:

  • 4.10.0.50

String : followerProjectionMorph

Holds the name of the morph (if any) on the owner of this object to apply while projecting from the follow target.


Number : nearnessFactor

Holds the nearness factor to use if near vertices are included.


Boolean : smartLeftRightHandling

Holds whether or not the projection should be “smart” about projecting values to/from face groups that are on the left vs. right side of the meshes.


SourceSubdivisionMode : sourceSubdivisionMode

Holds whether or not the follow target is subdivided when projecting.


Boolean : useNear

Holds whether or not to include near vertices in the projection calculation.


Boolean : uvSpaceProjection

Holds whether or not UV space will be used during projection calculation.

Since:

  • 4.9.3.1

Boolean : vertexFirstProjection

Holds whether vertices or facets on the follow target looked at first during projection.

Since:

  • 4.9.3.38

Boolean : writtenAsDefinition

Holds whether or not the current options are written to file as the definition for the owner of this object.

Methods


void : addCorrelatedMorph( String srcMorph, String followerMorph )

Adds a pair of (not necessarily matched) morph names to apply in the respective figures during a projection operation.

Parameter(s):

  • srcMorph - The name of the morph in the follow target.
  • followerMorph - The name of the morph in the owner of this object. An empty string here will cause any defined follower projection morph to be used.

void : clearCorrelatedMorphs()

Clears the list of morph pair names to apply during a projection operation.

Since:

  • 4.8.1.88

void : copyFrom( DzFollowingProjectionOptions other )

Copies options from another instance.

Parameter(s):

  • other - The instance to copy.

String : getFollowerCorrelatedMorph( Number which )

Parameter(s):

  • which - The index of the pair of morph names to get.

Return Value:

  • The name of the morph in the owner of this object for the pair at the specified index.

Number : getNumCorrelatedMorphs()

Return Value:

  • The number of morph name pairs to apply during a projection operation.

String : getSourceCorrelatedMorph( Number which )

Parameter(s):

  • which - The index of the pair of morph names to get.

Return Value:

  • The name of the morph in the follow target for the pair at the specified index.

Boolean : isAtDefault()

Return Value:

  • true if all options are at their respective default values, otherwise false.

void : removeCorrelatedMorph( Number which )

Removes a pair of morph names to apply during a projection operation.

Parameter(s):

  • which - The index of the name pair to remove.