ComponentParam
Properties
| Name | Type | Access | Min Version | Description |
|---|---|---|---|---|
displayName | string | R | 25.0 | Returns the display name of the component param |
Instance Methods
areKeyframesSupported
25.0boolean
Returns bool whether keyframes are supported for this component parameter
createAddKeyframeAction
25.0Action
Creates and returns an action object which can be used to add a keyframe component
Parameters
| Name | Type | Description |
|---|---|---|
Keyframe | object | - |
createKeyframe
25.0object
Creates and returns a keyframe initialised with the ComponentParam's type and passed in value. This throws if the passed in value is not compatible with the component param type
createRemoveKeyframeAction
25.0Action
Returns an action which removes keyframe at specific time
Parameters
| Name | Type | Description |
|---|---|---|
TickTime | object | - |
UpdateUI | boolean | - |
createRemoveKeyframeRangeAction
25.0Action
Returns an action which removes keyframe at specific time range
Parameters
| Name | Type | Description |
|---|---|---|
TickTime | object | - |
TickTime | object | - |
UpdateUI | boolean | - |
createSetInterpolationAtKeyframeAction
25.0Action
Returns an action which sets the interpolation mode of keyframe at the given time
Parameters
| Name | Type | Description |
|---|---|---|
TickTime | object | - |
InterpolationMode | number | - |
UpdateUI | boolean | - |
createSetTimeVaryingAction
25.0Action
Creates and returns an action object to set the component to be time varying
Parameters
| Name | Type | Description |
|---|---|---|
inTimeVarying | boolean | - |
createSetValueAction
25.0Action
Creates and returns an action object which can be used to set the value of a non-time varying component
Parameters
| Name | Type | Description |
|---|---|---|
Keyframe | object | - |
inSafeForPlayback | boolean | - |
findNearestKeyframe
25.0Keyframe
Find sthe nearest key for the given time
Parameters
| Name | Type | Description |
|---|---|---|
TickTime | object | - |
TickTime | object | - |
findNextKeyframe
25.0Keyframe
find the next keyframe for the given time
Parameters
| Name | Type | Description |
|---|---|---|
TickTime | object | - |
findPreviousKeyframe
25.0Keyframe
find the previous keyframe for the given time
Parameters
| Name | Type | Description |
|---|---|---|
TickTime | object | - |
getKeyframeListAsTickTimes
25.0Array
Get a list of tickTime for the keyframes of this component param
getKeyframePtr
25.0Keyframe
Get the Keyframe at the given tickTime postion
Parameters
| Name | Type | Description |
|---|---|---|
time | - |
getStartValue
25.0Keyframe
Returned promise will be fullfilled with the start value (keyframe) of the component param
getValueAtTime
25.0object
Gets the value of component Param at the given time
isTimeVarying
25.0boolean
Returns true if the parameter value varies over time (for the duration of the item)