User Tools

Site Tools


DzMorphLoaderBatch

Implements the loading and application of a batch of morphs from geometry files.

More...

Inherits :

Constructors

DAZ Script
DzMorphLoaderBatch ()

Methods

DAZ Script
voidaddFromConfigFile ( String filename )
voidaddFromFile ( String file )
voidaddFromFiles ( Array files )
voidaddFromMesh ( vertexmesh_dz mesh )
voidaddMorph ( DzMorphLoader morph )
voidclear ()
StringcreateMorphs ( vertexmesh_dz mesh, DzNode node, Boolean onlyErrorsOrWarnings=true, Boolean plainText=true )
StringcreateMorphs ( DzFileIOSettings settings, DzNode node, Boolean onlyErrorsOrWarnings=true, Boolean plainText=true )
NumberfindMorph ( DzMorphLoader morph )
DzMorphLoadergetMorph ( Number index )
DzNodegetNode ()
NumbergetNumMorphs ()
voidmoveMorph ( DzMorphLoader morph, Boolean upDown )
StringpresetConfigurationFile ()
voidremoveMorph ( DzMorphLoader morph )
BooleansaveProjectSettingsToConfigFile ( String filename, Boolean saveRelative, Boolean saveObjects )
voidsetNode ( DzNode node )
voidsetPresetConfigurationFile ( String filename )
voidsetUsePresetConfiguration ( Boolean onOff )
BooleanusePresetConfiguration ()

Signals

voidmorphAdded ( DzMorphLoader morph )
voidmorphListChanged ()
voidmorphMoved ( Number srcIdx, Number destIdx )
voidmorphRemoved ( DzMorphLoader morph, Number formerIndex )

Detailed Description

This class implements a batch of morph loader objects that will be applied to the same node(s).

Since:

  • 4.9.3.46

Attention:

  • This object is provided by the Morph Loader Pro plugin. It is only available when the Morph Loader Pro plugin is activated and enabled.

Constructors


DzMorphLoaderBatch()

Default Constructor. Creates a morph loader batch that will be applied to the given node.

Methods


void : addFromConfigFile( String filename )

Adds a morph to the list to load.

Parameter(s):

  • filename - The filename of the object configuration file to load.

Attention:

  • setNode() must be called before this is.

Since:

  • 4.9.3.47

void : addFromFile( String file )

Adds a morph to the list to load.

Parameter(s):

  • file - The filename of the morph file to load.

Attention:

  • setNode() must be called before this is.

void : addFromFiles( Array files )

Adds a list of morphs to the list to load.

Parameter(s):

  • files - A list of the filenames of the morph files to load.

Attention:

  • setNode() must be called before this is.

See Also:


void : addFromMesh( vertexmesh_dz mesh )

Adds a morph to the list to load.

Parameter(s):

  • mesh - The vertex mesh with the morph to load.

Attention:

  • setNode() must be called before this is.

void : addMorph( DzMorphLoader morph )

Adds a morph to the list to load.

Parameter(s):

  • morph - The morph to add.

void : clear()

Clears the list of morphs to load.


String : createMorphs( vertexmesh_dz mesh, DzNode node, Boolean onlyErrorsOrWarnings=true, Boolean plainText=true )

Creates morphs on the node provided from the given geometry. This function supports morph creation from vertex-only geometries.

Parameter(s):

  • mesh - The geometry for the morphs.
  • node - The node containing the geometry to create the morphs for.
  • onlyErrorsOrWarnings - If true (default), only errors and warnings will be returned.
  • plainText - If true (default), the returned string will be plain text, otherwise the returned string will contain HTML.

Return Value:

  • The log containing messages about the creation of the morphs.

String : createMorphs( DzFileIOSettings settings, DzNode node, Boolean onlyErrorsOrWarnings=true, Boolean plainText=true )

Creates morphs on the node provided from the geometry loaded from the files. This function supports morph creation from vertex-only geometries.

Parameter(s):

  • settings - The scale to apply to the geometry that is read from the file.
  • node - The node containing the geometry to create the morph for.
  • onlyErrorsOrWarnings - If true (default), only errors and warnings will be returned.
  • plainText - If true (default), the returned string will be plain text, otherwise the returned string will contain HTML.

Return Value:

  • The log containing messages about the creation of the morph.

Number : findMorph( DzMorphLoader morph )

Parameter(s):

  • morph - The morph to find.

Return Value:

  • The index of the found morph (if any), otherwise -1.

DzMorphLoader : getMorph( Number index )

Parameter(s):

  • index - The index of the morph to get.

Return Value:

  • The morph in the list at the given index (if valid), otherwise Null.

DzNode : getNode()

Return Value:

  • The node with the object that morphs will be loaded for (if set), otherwise NULL.

Number : getNumMorphs()

Return Value:

  • The number of morphs in the list to load.

void : moveMorph( DzMorphLoader morph, Boolean upDown )

Moves the position of a morph in the list.

Parameter(s):

  • morph - The morph to move.
  • upDown - If true, the morph is moved to the position earlier in the list. If false, the morph is moved to the position later in the list.

String : presetConfigurationFile()

Return Value:

  • The filename of the preset configuration file to use (if any) to setup a morph added from file, otherwise an empty string.

See Also:


void : removeMorph( DzMorphLoader morph )

Removes a morph from the list to load.

Parameter(s):

  • morph - The morph to remove.

Boolean : saveProjectSettingsToConfigFile( String filename, Boolean saveRelative, Boolean saveObjects )

Saves project (and potentially object) settings to configuration files (*.dsx).

Parameter(s):

  • filename - The full path of the file to write to.
  • saveRelative - If true, object settings files are saved relative to the project file. If false, object settings files are saved adjacent to their respective source.
  • saveObjects - If true, object settings will be saved to their respective files. If false, object settings files are not saved.

Return Value:

  • true if the save was successful, otherwise false. (since 4.15.0.4)

Since:

  • 4.9.3.47

void : setNode( DzNode node )

Sets the node with the object to load morphs for.

Parameter(s):

  • node - The node to set.

void : setPresetConfigurationFile( String filename )

Sets the filename of a preset configuration file to use to setup morphs that are added to the list from file.

Parameter(s):

  • filename - The filename of the preset configuration file to use.

See Also:


void : setUsePresetConfiguration( Boolean onOff )

Sets whether or not a preset configuration file should be used to setup morphs that are added from file.

Parameter(s):

  • onOff - If true, a preset configuration file should be used.

See Also:


Boolean : usePresetConfiguration()

Return Value:

  • true if a preset configuration file should be used to setup morphs that are added from file, otherwise false.

See Also:

Signals


void : morphAdded( DzMorphLoader morph )

TODO: Add description.


void : morphListChanged()

TODO: Add description.


void : morphMoved( Number srcIdx, Number destIdx )

TODO: Add description.


void : morphRemoved( DzMorphLoader morph, Number formerIndex )

TODO: Add description.