User Tools

Site Tools


DzColorProperty

An animatable color property.

More...

Inherits :

Inherited By : DzFloatColorProperty

Enumerations

DAZ Script
AnimationBlendMode{ HSV, HSL, RGB }

Static Methods

Constructors

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

Methods

Signals

Detailed Description

This class provides an animatable color property that is stored and can be accessed as an integer property. The integer value represents a color as a 32 bit rgba value with each byte representing a component with the range [0, 255].

Enumerations


: AnimationBlendMode

The color model that will used for blending values between keyframes in an animation.

  • HSV - Hue, Saturation, and Value.
  • HSL - Hue, Saturation, and Lightness (or Luminosity).
  • RGB - Red, Green, Blue.

Static Methods


AnimationBlendMode : animationBlendModeFromStr( String str )

Converts a string to an enumerated animation blend mode value.

Parameter(s):

  • str - The string to convert.

Return Value:

  • The AnimationBlendMode corresponding to str.

Since:

  • 4.6.4.84

String : animationBlendModeToStr( AnimationBlendMode type )

Converts an enumerated animation blend mode value to a string.

Parameter(s):

  • type - The AnimationBlendMode to convert.

Return Value:

  • A string representation of the enumerated AnimationBlendMode value.

Since:

  • 4.6.4.84

Constructors


DzColorProperty()

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


DzColorProperty( 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.
  • initVal - Sets the default value of this property.

DzColorProperty( 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


AnimationBlendMode : getAnimationBlendMode()

Return Value:

  • The animation blend mode for the property.

Since:

  • 4.6.4.84

Color : getColorValue()

Return Value:

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

Color : getColorValue( DzTime tm )

Parameter(s):

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

Return Value:

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

Color : getDefaultColorValue()

Return Value:

  • The default color value of the property.

Color : getKeyColorValue( Number i )

Parameter(s):

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

Return Value:

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

Color : getRawColorValue( DzTime tm )

Parameter(s):

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

Return Value:

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

Color : getRawColorValue()

Return Value:

  • The raw color value of the property.

void : setAnimationBlendMode( AnimationBlendMode mode )

Sets the animation blend mode for the property.

Parameter(s):

  • mode - The animation blend mode to set.

Since:

  • 4.6.4.84

void : setColorValue( DzTime tm, Color val )

Sets the color value for this property at the given time; or the default value if this property is not animatable.

Parameter(s):

  • tm - The scene time at which to set the value.
  • val - The new value for the property.

void : setColorValue( Color val )

Sets the color value for this property at the current time; or the default value if this property is not animatable.

Parameter(s):

  • val - The new value for the property.

void : setDefaultColorValue( Color val )

Sets the default color value for this property.

Parameter(s):

  • val - The new default value for the property.

void : setKeyColorValue( Number i, Color val )

Sets the 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.

Signals


void : animationBlendModeChanged()

TODO: Add description.