User Tools

Site Tools


DzERCBake

Implements the logic of 'baking' a numeric property to the numeric properties it controls.

More...

Inherits :

Constructors

DAZ Script
DzERCBake ()

Methods

Signals

voidERCChanged ()

Detailed Description

This utility class implements the logic of 'baking' (unlinking) the current state of a controller property on a node to the numeric properties it controls, such that the controlled properties remain at the respective values they were at in that moment of time. The DzERCLink between the 'baked' properties and the controller is removed.

The controller property (the DzNumericProperty that does the controlling) must be set before calling doBake(); see setControllerProperty().

See Also:

Attention:

  • This object is provided by the Property Hierarchy plugin. It is only available when the Property Hierarchy plugin is activated and enabled.

Since:

  • 4.9.3.101

Constructors


DzERCBake()

Default constructor.

Methods


Boolean : doBake()

Performs the ERC bake based on the current settings.

Return Value:

  • true if the bake operation was successful, otherwise false.

Boolean : doBakeKeyed( Boolean warn )

Performs the ERC bake based on the current settings.

Return Value:

  • true if the bake operation was successful, otherwise false.

DzNumericProperty : getControllerProperty()

Return Value:

  • The property (if any) that controls the properties that will be baked when doBake() is called.

void : setControllerProperty( DzNumericProperty prop )

Sets the property that controls the properties that will be baked when doBake() is called.

Parameter(s):

  • prop - The property to set as the controller to bake.

Signals


void : ERCChanged()

TODO: Add description.