DzColorProperty Class Reference
[Property Objects]

An animatible color property. More...

Inheritance diagram for DzColorProperty:

DzIntProperty DzNumericProperty DzProperty DzBase QObject Object List of all members.

Constructors

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

Methods

Color getColorValue ()
void setColorValue (DzTime tm, Color val)
void setColorValue (Color val)

Detailed Description

An animatible color property.

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].


Constructor & Destructor Documentation

DzColorProperty::DzColorProperty (  ) 

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

DzColorProperty::DzColorProperty ( String  name,
Boolean  canAnimate,
Boolean  isUserProperty 
)

This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.

Parameters:
name The name of this property.
canAnimate If true, creates an animatable property.
isUserProperty If true, create a user property. User properties are properties that can be added/deleted by users.

DzColorProperty::DzColorProperty ( String  name,
Boolean  canAnimate,
Boolean  isUserProperty,
Color  initVal 
)

Overloaded constructor.

Parameters:
name The name of this property.
canAnimate If true, creates an animatable property.
isUserProperty If true, create a user property. User properties are properties that can be added/deleted by users.
initVal Sets the default value of this property.


Member Function Documentation

QColor DzColorProperty::getColorValue (  ) 

Returns:
The color value of the property at the current time.

void DzColorProperty::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.

Parameters:
tm The scene time at which to set the value
val The new value for the property

void DzColorProperty::setColorValue ( Color  val  ) 

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

Parameters:
val The new value for the property


Generated on Thu Sep 24 12:21:11 2009

Copyright © 2002 - 2009 DAZ 3D, Inc.