Inheritance diagram for DzFloatProperty:
The different types of key interpolation
DzFloatProperty::DzFloatProperty | ( | ) |
Default Constructor. Creates a non-animatable, non-user property.
DzFloatProperty::DzFloatProperty | ( | String | name, | |
Boolean | canAnimate, | |||
Boolean | isUserProperty, | |||
Number | initVal = 0.0 | |||
) |
This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.
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. |
Adds the given value to all the key values.
val | The addend for the values. | |
applyToDefault | If true, val will also be added to the default value for the property. |
Adjust the value of the property at the given time based on the contribution of property controllers.
tm | The scene time at which to adjust the value. | |
val | The 'final' value desired for the property. |
Adjust the value of the property based on the contribution of property controllers.
val | The 'final' value desired for the property. |
DzFloatProperty::displayAsPercentChanged | ( | ) | [signal] |
Signature: "displayAsPercentChanged()"
Emitted if the way this property is displayed changed.
Divides all key values by the given amount.
val | The divisor for the values. | |
applyToDefault | If true, the default value for the property will also be divided. |
Number DzFloatProperty::getDefaultValue | ( | ) |
Boolean DzFloatProperty::getDisplayAsPercent | ( | ) |
InterpolationType DzFloatProperty::getKeyInterpolationType | ( | Number | i | ) |
i | The index of the key to get the interpolation values for. |
index | The index of the key to get the value for. |
This function is provided for the special case of ERC 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 a piece 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 getValue(). For a figure that is 'Fit To' another figure, this will return the value that the property would have if the ERC had not been redirected.
tm | The time at which to get the calculate this properties value. |
Number DzFloatProperty::getLocalValue | ( | ) |
This function is provided for the special case of ERC 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 a piece 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 getValue(). For a figure that is 'Fit To' another figure, this will return the value that the property would have if the ERC had not been redirected.
Number DzFloatProperty::getMax | ( | ) |
Number DzFloatProperty::getMin | ( | ) |
This function is provided to make it easy to get the 'keyed' value of the property without any modifications. When the value of a property is evaluated, first the value based on key interpolation is calculated, that value is then passed to each of the controllers on the property (ERC Links for example) which can modify that value. This modified value is then returned as the value of the property by getValue(). This function returns the value of the property before the application of the controllers - strictly the result of key interpolation.
tm | The scene time at which to get the value of the property. |
Number DzFloatProperty::getRawValue | ( | ) |
This function is provided to make it easy to get the 'keyed' value of the property without any modifications. When the value of a property is evaluated, first the value based on key interpolation is calculated, that value is then passed to each of the controllers on the property (ERC Links for example) which can modify that value. This modified value is then returned as the value of the property by getValue(). This function returns the value of the property before the application of the controllers - strictly the result of key interpolation.
Number DzFloatProperty::getSensitivity | ( | ) |
Number DzFloatProperty::getValue | ( | ) |
Multiplies all key values by the given amount.
val | The multiplier for the values. | |
applyToDefault | If true, the default value for the property will also be multiplied. |
void DzFloatProperty::setDefaultValue | ( | Number | val | ) |
Sets the default value for this property.
void DzFloatProperty::setDisplayAsPercent | ( | Boolean | onOff | ) |
Sets whether this property should have its value displayed as a percentage - the default is false ( value is displayed as a decimal )
void DzFloatProperty::setKeyInterpolation | ( | Number | i, | |
InterpolationType | interp, | |||
Number | param0, | |||
Number | param1, | |||
Number | param2 | |||
) |
Sets the interpolation method for the i'th key. User is responsible to assure that i lies within the valid range of keys for this property.
i | The index of the key to change. | |
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 DzFloatProperty::setKeyInterpolation | ( | Number | i, | |
InterpolationType | interp | |||
) |
Sets the interpolation method for the i'th key. User is responsible to assure that i lies within the valid range of keys for this property.
i | The index of the key to change. | |
interp | The type of interpolation to perform between this keyframe and the next. |
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.
i | The index of the key to change. | |
val | The new value for the key. |
void DzFloatProperty::setMax | ( | Number | max | ) |
Set the maximum allowable value
void DzFloatProperty::setMin | ( | Number | min | ) |
Set the mininimum allowable value
Set the mininimum and maximum allowable values
void DzFloatProperty::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 DzFloatProperty::setValue | ( | DzTime | tm, | |
Number | val, | |||
InterpolationType | interp, | |||
Number | param0, | |||
Number | param1, | |||
Number | param2 | |||
) |
Sets the value for this property at the given time - or the default value if this property is not animatable.
tm | The time to set the value at. | |
val | The value to set the property to. | |
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 DzFloatProperty::setValue | ( | DzTime | tm, | |
Number | val, | |||
InterpolationType | interp | |||
) |
Sets the value for this property at the given time - or the default value if this property is not animatable.
tm | The time to set the value at. | |
val | The value to set the property to. | |
interp | The type of interpolation to perform between this keyframe and the next. Parameters for interpolation are set to defaults. |
Sets the value for this property at the given time - or the default value if this property is not animatable.
tm | The time to set the value at. | |
val | The value to set the property to. |
void DzFloatProperty::setValue | ( | Number | val | ) |
Sets the value for this property at the current time - or the default value if this property is not animatable.
val | The value to set the property to. |
Subtracts the given value to all the key values.
val | The value to be subtracted from the key values. | |
applyToDefault | If true, val will also be subtracted from the default value for the property. |