User Tools

Site Tools


DzIntProperty

An animatable integer property.

More...

Inherits :

Inherited By : DzBoolProperty, DzColorProperty, DzEnumProperty and DzInt2Property

Constructors

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

Methods

Detailed Description

TODO: Add detailed description.

Constructors


DzIntProperty()

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


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

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.

Methods


Number : adjustValue( Number 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.

Number : adjustValue( DzTime tm, Number 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.

Number : getDefaultValue()

Return Value:

  • The default value of the property.

Number : getDoubleDefaultValue()

Return Value:

  • The default value of this property as a double precision value.

Number : getDoubleValue( DzTime tm )

Parameter(s):

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

Return Value:

  • The value of this property as a double at the given time.

Number : getKeyValue( Number i )

Parameter(s):

  • index - The index of the key to get the value for.

Return Value:

  • The value of the i'th key in the property.

Number : getLocalValue()

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 getValue(). 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.

Number : getLocalValue( 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 getValue(). 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 given time without any ERC link redirection.

Number : getMax()

Return Value:

  • The maximum allowable value of the property.

Number : getMin()

Return Value:

  • The minimum allowable value of the property.

Number : getRawValue( DzTime tm )

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.

Parameter(s):

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

Return Value:

  • 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 : 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.

Return Value:

  • 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 : getSensitivity()

Return Value:

  • The sensitivity setting for this property.

Number : getValue( DzTime tm )

Parameter(s):

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

Return Value:

  • The value of the property at the given time.

Number : getValue()

Return Value:

  • The value of the property at the current time.

void : setDefaultValue( Number val )

Sets the default value for this property.

Parameter(s):

  • val - The value to set as the default for this property.

void : setDoubleDefaultValue( Number val )

Truncates a double precision value to an integer and sets the default value.

Parameter(s):

  • val - The value to set as the default for this property.

void : setDoubleValue( DzTime tm, Number val )

Sets the value for this property at the given time; or the default value if this property is not animatable; truncates a double precision value to an integer.

Parameter(s):

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

void : setKeyValue( Number keyIndex, Number val )

Sets the value of the i'th key.

Parameter(s):

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

Attention:

  • You are responsible to ensure the key index is within the valid range.

void : setMax( Number max )

Set the maximum allowable value.

Parameter(s):

  • max - The maximum value to set.

void : setMin( Number min )

Set the mininimum allowable value.

Parameter(s):

  • min - The minimum value to set.

void : setMinMax( Number min, Number max )

Set the mininimum and maximum allowable values.

Parameter(s):

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

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

Parameter(s):

  • sens - The value to set.

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

Parameter(s):

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

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

Parameter(s):

  • val - The value to set.