User Tools

Site Tools


DzFloat3Property

An animatable floating-point property with 3 values.

More...

Inherits :

Constructors

DAZ Script
DzFloat3Property ()
DzFloat3Property ( String name, Boolean canAnimate, Boolean isUserProperty, DzVec3 initVal )
DzFloat3Property ( String name, Boolean canAnimate, Boolean isUserProperty )

Methods

Detailed Description

This class provides an animatable floating-point property with 3 values that is stored and can be accessed as a DzVec3.

Constructors


DzFloat3Property()

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


DzFloat3Property( String name, Boolean canAnimate, Boolean isUserProperty, DzVec3 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.

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


DzVec3 : adjustFloat3Value( DzVec3 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.

DzVec3 : adjustFloat3Value( DzTime tm, DzVec3 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.

DzVec3 : getDefaultFloat3Value()

Return Value:

  • The default value of the property.

DzVec3 : getFloat3FollowValue()

TODO: Add description.


DzVec3 : getFloat3FollowValue( DzTime tm )

TODO: Add description.


DzVec3 : getFloat3Value()

Return Value:

  • The value of the property at the current time.

DzVec3 : getFloat3Value( DzTime tm )

Parameter(s):

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

Return Value:

  • The value of the property at the given time.

DzVec3 : getKeyFloat3Value( 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.

DzVec3 : getLocalFloat3Value()

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.

DzVec3 : getLocalFloat3Value( 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.

DzVec3 : getRawFloat3Value( 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 getFloat3Value(). 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.

DzVec3 : getRawFloat3Value()

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

void : setDefaultFloat3Value( DzVec3 val )

Sets the default value for this property.

Parameter(s):

  • val - The value to set the property to.

void : setFloat3Value( DzTime tm, DzVec3 val )

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

Parameter(s):

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

void : setFloat3Value( DzVec3 val )

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

Parameter(s):

  • val - The value to set the property to.

void : setFloat3Value( DzTime tm, DzVec3 val, InterpolationType interp )

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

Parameter(s):

  • tm - The scene 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.

void : setFloat3Value( DzTime tm, DzVec3 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.

Parameter(s):

  • tm - The scene time to set the value at.
  • valIn - 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 : setKeyFloat3Value( Number i, DzVec3 val )

Sets the value of the i'th key.

Parameter(s):

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

Attention:

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