User Tools

Site Tools


DzSimulationSettingsProvider

A container class for an element used to hold settings for controlling a simulation.

More...

Inherits :

Properties

Methods

DAZ Script
DzSimulationSettingsProviderduplicateProvider ( DzElementDuplicateContext context )
DzShapegetShape ()
BooleanmodifyAsset ( DzUri newUri )
BooleanmodifyAsset ()
BooleanshouldAlwaysEmbed ()

Signals

voidassetModified ()
voidassetWasSaved ()
voidsettingsChanged ()
voidshapeChanged ( DzShape newShape, DzShape oldShape )

Detailed Description

Since:

  • 4.9.3.135

Properties


DzAuthor : assetAuthor

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


DzVersion : assetFileRevision

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


String : assetId

Holds the asset id for this material.


Date : assetModifiedDate

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


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 material; only valid when the asset is in an embedded state - i.e. modified. (Read Only)


DzUri : assetUri

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

Methods


DzSimulationSettingsProvider : duplicateProvider( DzElementDuplicateContext context )

Parameter(s):

  • context - The context of the simulation settings provider to duplicate.

Return Value:

  • The duplicate simulation settings provider if one could be duplicated, otherwise NULL.

DzShape : getShape()

Return Value:

  • The shape for this simulation settings provider (if any), otherwise NULL.

Since:

  • 4.10.0.64

Boolean : modifyAsset( DzUri newUri )

Marks the asset as being modified.

Parameter(s):

  • newUri - The new file URI for the asset.

Return Value:

  • true on success, otherwise false.

Boolean : modifyAsset()

Marks the asset as being modified.

Return Value:

  • true on success, otherwise false.

Boolean : shouldAlwaysEmbed()

Determine if this provider should always embed.

Return Value:

  • true.

Signals


void : assetModified()

Signature:“assetModified()”

Emitted when this provider has been modified.


void : assetWasSaved()

Signature:“assetWasSaved()”

Emitted after this provider has been saved.


void : settingsChanged()

Signature:“settingsChanged()”

Emitted when the settings on this provider has changed.


void : shapeChanged( DzShape newShape, DzShape oldShape )

Signature:“shapeChanged(DzShape*,DzShape*)”

Emitted when the shape that this provider is assigned to has changed.

Parameter(s):

  • newShape - The shape that this provider is now assigned to.
  • oldShape - The shape that this provider was previously assigned to (if any), otherwise NULL.

Since:

  • 4.10.0.64