DzIntProperty Class Reference
[Property Objects]

An animatible integer property. More...

Inheritance diagram for DzIntProperty:

DzNumericProperty DzProperty DzBase QObject Object DzBoolProperty DzColorProperty DzEnumProperty List of all members.

Methods

Number adjustValue (DzTime tm, Number val)
Number adjustValue (Number val)
Number getDefaultValue ()
Number getKeyValue (Number i)
Number getLocalValue (DzTime tm)
Number getLocalValue ()
Number getMax ()
Number getMin ()
Number getRawValue (DzTime tm)
Number getRawValue ()
Number getSensitivity ()
Number getValue ()
Number getValue (DzTime tm)
void setDefaultValue (Number val)
void setKeyValue (Number keyIndex, Number val)
void setMax (Number max)
void setMin (Number min)
void setMinMax (Number min, Number max)
void setSensitivity (Number sens)
void setValue (DzTime tm, Number val)
void setValue (Number val)

Constructors

 DzIntProperty (String name, Boolean canAnimate, Boolean isUserProperty, Number initVal=0)
 DzIntProperty ()

Detailed Description

An animatible integer property.


Constructor & Destructor Documentation

DzIntProperty::DzIntProperty (  ) 

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

DzIntProperty::DzIntProperty ( String  name,
Boolean  canAnimate,
Boolean  isUserProperty,
Number  initVal = 0 
)

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.
defaultVal Sets the default value of this property.


Member Function Documentation

Number DzIntProperty::adjustValue ( DzTime  tm,
Number  val 
)

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

Parameters:
tm The scene time at which to adjust the value.
val The 'final' value desired for the property.
Returns:
A 'raw' value for the property that will result in the property having the given value with the current controllers.

Number DzIntProperty::adjustValue ( Number  val  ) 

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

Parameters:
val The 'final' value desired for the property.
Returns:
A 'raw' value for the property that will result in the property having the given value with the current controllers.

Number DzIntProperty::getDefaultValue (  ) 

Returns:
The default value of the property.

Number DzIntProperty::getKeyValue ( Number  i  ) 

Returns:
The value of the i'th key in the property.

Number DzIntProperty::getLocalValue ( DzTime  tm  ) 

Returns:
The value of the property at the current time without any ERC redirection.

Number DzIntProperty::getLocalValue (  ) 

Returns:
The value of the property at the given time without any ERC redirection.

Number DzIntProperty::getMax (  ) 

Returns:
The maximum allowable value of the property

Number DzIntProperty::getMin (  ) 

Returns:
The minimum allowable value of the property

Number DzIntProperty::getRawValue ( DzTime  tm  ) 

Returns:
The 'raw' value of the property at the given time - this is the actual value of the property without the contribution of property links, etc.

Number DzIntProperty::getRawValue (  ) 

Returns:
The 'raw' value of the property at the current time - this is the actual value of the property without the contribution of property links, etc.

Number DzIntProperty::getSensitivity (  ) 

Returns:
The sensitivity setting for this property.

Number DzIntProperty::getValue (  ) 

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

Number DzIntProperty::getValue ( DzTime  tm  ) 

Returns:
The value of the property at the given time.

void DzIntProperty::setDefaultValue ( Number  val  ) 

Sets the default value for this property.

void DzIntProperty::setKeyValue ( Number  keyIndex,
Number  val 
)

Sets the value of the i'th key. User is responsible to assure that i lies within the valid range of keys for this property.

void DzIntProperty::setMax ( Number  max  ) 

Set the maximum allowable value

void DzIntProperty::setMin ( Number  min  ) 

Set the mininimum allowable value

void DzIntProperty::setMinMax ( Number  min,
Number  max 
)

Set the mininimum and maximum allowable values

void DzIntProperty::setSensitivity ( 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.

void DzIntProperty::setValue ( DzTime  tm,
Number  val 
)

Sets the value for this property at the given time - or the default value if this property is not animatable. This function differs from setRawValue() in that it takes into account any controllers on the property such that calling setValue( getValue() ) should not change the value of the property.

void DzIntProperty::setValue ( Number  val  ) 

Sets the value for this property at the current time - or the default value if this property is not animatable. This function differs from setRawValue() in that it takes into account any controllers on the property such that calling setValue( getValue() ) should not change the value of the property.


Generated on Thu Sep 24 12:21:12 2009

Copyright © 2002 - 2009 DAZ 3D, Inc.