GetRelativeValue
 
 
 

GetRelativeValue

Description

Returns the set of relative values at the specified index from the interpolator-driven parameter.

Scripting Syntax

oArray = GetRelativeValue( InputObj, Index );

Return Value

Returns an Array containing the relative value for each parameter.

Parameters

Parameter Type Description
InputObj String Animated parameter(s) that the interpolator is controlling or the interpolator itself

Default Value: Currently selected and marked parameter

Index Integer Index of the set of relative values to get.

Default Value: 0

Possible Values:

Description:

0 < Index < NbRelativeValues Sets of relative values are indexed from 0 to (NbRelativeValues - 1)

Examples

VBScript Example

'
'See the example for the SetRelativeValues command.
'

See Also

GetNumRelativeValues RemoveRelativeValue SetRelativeValues