User Tools

Site Tools


DzFloatColorProperty

An animatable floating point color property.

More...

Inherits :

Enumerations

Constructors

DAZ Script
DzFloatColorProperty ()
DzFloatColorProperty ( String name, Boolean canAnimate, Boolean isUserProperty, Color initVal )
DzFloatColorProperty ( String name, Boolean canAnimate, Boolean isUserProperty )

Methods

Detailed Description

This class provides an animatable color property that is stored and can be accessed as a floating point values.

Since:

  • 4.6.4.85

Enumerations


: InterpolationType

Since:

  • 4.11.0.210
  • LINEAR_INTERP - Linear interpolation between key values.
  • CONSTANT_INTERP - Constant interpolation between key values.
  • TCB_INTERP - TCB (Kochanek-Bartels) Spline interpolation between key values.
  • HERMITE_INTERP - Hermite Spline interpolation between key values.

Constructors


DzFloatColorProperty()

Default Constructor. Creates a non-animatable, non-user property.


DzFloatColorProperty( String name, Boolean canAnimate, Boolean isUserProperty, Color initVal )

Parameter(s):

  • name - The name of this property.
  • canAnimate - If true, creates an animatable property.
  • isUserProperty - If true, creates a user property; user properties are properties that can be added/deleted by users.
  • defaultVal - Sets the default value of this property.

DzFloatColorProperty( String name, Boolean canAnimate, Boolean isUserProperty )

Parameter(s):

  • name - The name of this property.
  • canAnimate - If true, creates an animatable property.
  • isUserProperty - If true, creates a user property; user properties are properties that can be added/deleted by users.

Methods


DzFloatColor : adjustFloatColorValue( DzFloatColor val )

Adjust the value of the property based on the contribution of property controllers.

Parameter(s):

  • val - The 'final' value desired for the property.

Return Value:

  • A 'raw' value for the property that will result in the property having the given value with the current controllers.

DzFloatColor : adjustFloatColorValue( DzTime tm, DzFloatColor val )

Adjust the value of the property at the given time based on the contribution of property controllers.

Parameter(s):

  • tm - The scene time at which to adjust the value.
  • val - The 'final' value desired for the property.

Return Value:

  • A 'raw' value for the property that will result in the property having the given value with the current controllers.

DzFloatColor : getDefaultFloatColorValue()

Return Value:

  • The default float color value of the property.

See Also:


DzFloatColor : getFloatColorFollowValue()

Return Value:

  • The difference between the current value of the follow property and its default value at the current time. If no auto-follow property is set, or auto-follow is not enabled for this property, then this method returns 0.

DzFloatColor : getFloatColorFollowValue( DzTime tm )

Parameter(s):

  • tm - The scene time for which to get the value.

Return Value:

  • The difference between the current value of the follow property and this properties default value tm. If no auto-follow property is set, or auto-follow is not enabled for this property, then this method returns 0.

DzFloatColor : getFloatColorValue()

Return Value:

  • The float color value of the property at the current time.

See Also:


DzFloatColor : getFloatColorValue( DzTime tm )

Parameter(s):

  • tm - The scene time to get the color value at.

Return Value:

  • The float color value of the property at the given time.

See Also:


Number : getFloatMax()

Return Value:

  • The maximum allowable value of the property.

See Also:


Number : getFloatMin()

Return Value:

  • The minimum allowable value of the property.

See Also:


Number : getFloatSensitivity()

Return Value:

  • The sensitivity value for this property.

DzFloatColor : getKeyFloatColorValue( Number i )

Parameter(s):

  • i - The index of the key to get the raw color value of.

Return Value:

  • The float color value of the property at the given key.

See Also:


DzFloatColor : getLocalFloatColorValue()

This function is provided for the special case of ERC link redirection; sometimes called 'cross-talk'. For example, if Figure A (a piece of clothing, for example) is 'Fit To' Figure B, the ERC links on Figure A are redirected to follow channels on Figure B; this is how morphs on an item of clothing will follow morphs on the figure, etc. This function will provide the value of the property ignoring any redirection of ERC links. So, for a figure that is not 'Fit To' another figure, this will return the same value as getFloatColorValue(). For a figure that is 'Fit To' another figure, this will return the value that the property would have if the ERC link had not been redirected.

Return Value:

  • The value of the property at the current time without any ERC link redirection.

DzFloatColor : getLocalFloatColorValue( DzTime tm )

This function is provided for the special case of ERC link redirection; sometimes called 'cross-talk'. For example, if Figure A (a piece of clothing, for example) is 'Fit To' Figure B, the ERC links on Figure A are redirected to follow channels on Figure B; this is how morphs on an item of clothing will follow morphs on the figure, etc. This function will provide the value of the property ignoring any redirection of ERC links. So, for a figure that is not 'Fit To' another figure, this will return the same value as getFloatColorValue(). For a figure that is 'Fit To' another figure, this will return the value that the property would have if the ERC link had not been redirected.

Parameter(s):

  • tm - The scene time to get the local value for.

Return Value:

  • The value of the property at the current time without any ERC link redirection.

DzFloatColor : getRawFloatColorValue( DzTime tm )

Parameter(s):

  • tm - The scene time at which to get the 'raw' float color value.

Return Value:

  • The 'raw' float color value of the property.

See Also:


DzFloatColor : getRawFloatColorValue()

Return Value:

  • The 'raw' float color value of the property at the current time.

See Also:


void : setDefaultFloatColorValue( DzFloatColor val )

Sets the default float color value for this property.

Parameter(s):

  • val - The new default value for the property.

See Also:


void : setFloatColorValue( DzFloatColor val )

Sets the float color value of the property at the current time.

Parameter(s):

  • val - The value to set.

See Also:


void : setFloatColorValue( DzTime tm, DzFloatColor val, InterpolationType interp, Number param0, Number param1, Number param2 )

Sets the float color value of the property at the specified time.

Parameter(s):

  • tm - The scene time to set the value for.
  • val - The value to set.
  • interp - The type of interpolation to perform between this keyframe and the next.
  • param0 - The parameter 0 for key interpolation: T value for TCB interpolation, starting slope value for Hermite interpolation.
  • param1 - The parameter 1 for key interpolation: C value for TCB interpolation, ending slope value for Hermite interpolation.
  • param2 - The parameter 2 for key interpolation: B value for TCB interpolation.

void : setFloatColorValue( DzTime tm, DzFloatColor val, InterpolationType interp )

Sets the float color value of the property at the specified time.

Parameter(s):

  • tm - The scene time to set the value for.
  • val - The value to set.
  • interp - The type of interpolation to perform between this keyframe and the next.

void : setFloatColorValue( DzTime tm, DzFloatColor val )

Sets the float color value of the property at the specified time.

Parameter(s):

  • tm - The scene time to set the value for.
  • val - The value to set.

See Also:


void : setFloatMax( Number max )

Set the maxinimum allowable value, as a float.

Parameter(s):

  • max - The maximum value to set.

See Also:


void : setFloatMin( Number min )

Set the mininimum allowable value, as a float.

Parameter(s):

  • min - The minimum value to set.

See Also:


void : setFloatMinMax( Number min, Number max )

Set the mininimum and maximum allowable values, as floats.

Parameter(s):

  • min - The minimum value to set.
  • max - The maximum value to set.

See Also:


void : setFloatSensitivity( Number sens )

Set the sensitivity for this property. This value describes the amount of change in the value of this property caused by adjustment in the interface, especially if limits are off.

Parameter(s):

  • sens - The value to set.

See Also:


void : setKeyFloatColorValue( Number i, DzFloatColor val )

Sets the float color value of this property for the given key.

Parameter(s):

  • i - The index of the key to set the value of.
  • val - The new default value for the property.

void : setRawFloatColorValue( DzTime tm, DzFloatColor val )

Sets the 'raw' float color value of the property at the specified time; this is the actual value of the property without the contribution of property links, etc.

Parameter(s):

  • tm - The scene time to set the raw value for.
  • val - The value to set.

void : setRawFloatColorValue( DzFloatColor val )

Sets the 'raw' float color value of the property at the current time; this is the actual value of the property without the contribution of property links, etc.

Parameter(s):

  • val - The value to set.