Class AnimationCurves

A set of animation curves representing translation/rotation/scale and generic animation.

Index

Constructors

Accessors

eulerRotation generic position rotation scale

Methods

addEulerRotation addGenericCurve addPositionCurve addRotationCurve addScaleCurve removeEulerRotationCurve removeGenericCurve removePositionCurve removeRotationCurve removeScaleCurve

Constructors

constructor

new AnimationCurves(isInternalConstructor?: boolean): AnimationCurves
Parameters
- OptionalisInternalConstructor: boolean
Returns AnimationCurves

Overrides FrameworkObject.constructor

Accessors

eulerRotation

get eulerRotation(): Iterable<NamedVector3Curve>

Curves for animating generic component properties.

Returns Iterable<NamedVector3Curve>
set eulerRotation(
    value:
        | Iterable<NamedVector3Curve>
        | readonly Immutable<NamedVector3Curve>[],
): void
Parameters
- value: Iterable<NamedVector3Curve> | readonly Immutable<NamedVector3Curve>[]
Returns void

generic

get generic(): Iterable<NamedFloatCurve>

Curves for animating generic component properties.

Returns Iterable<NamedFloatCurve>
set generic(
value: Iterable<NamedFloatCurve> | readonly Immutable<NamedFloatCurve>[],
): void
Parameters
- value: Iterable<NamedFloatCurve> | readonly Immutable<NamedFloatCurve>[]
Returns void

position

get position(): Iterable<NamedVector3Curve>

Curves for animating scene object's position.

Returns Iterable<NamedVector3Curve>
set position(
    value:
        | Iterable<NamedVector3Curve>
        | readonly Immutable<NamedVector3Curve>[],
): void
Parameters
- value: Iterable<NamedVector3Curve> | readonly Immutable<NamedVector3Curve>[]
Returns void

rotation

get rotation(): Iterable<NamedQuaternionCurve>

Curves for animating scene object's rotation.

Returns Iterable<NamedQuaternionCurve>
set rotation(
    value:
        | Iterable<NamedQuaternionCurve>
        | readonly Immutable<NamedQuaternionCurve>[],
): void
Parameters
- value: Iterable<NamedQuaternionCurve> | readonly Immutable<NamedQuaternionCurve>[]
Returns void

scale

get scale(): Iterable<NamedVector3Curve>

Curves for animating scene object's scale.

Returns Iterable<NamedVector3Curve>
set scale(
    value:
        | Iterable<NamedVector3Curve>
        | readonly Immutable<NamedVector3Curve>[],
): void
Parameters
- value: Iterable<NamedVector3Curve> | readonly Immutable<NamedVector3Curve>[]
Returns void

Methods

addEulerRotation

addEulerRotation(name: string, curve: CompoundVector3Curve): void
Registers a new curve used for animating rotation using euler angles.
Parameters
- name: string
  Unique name of the curve. This can be used for retrieving the value of the curve from animation.
- curve: CompoundVector3Curve
  Curve to add to the clip.
Returns void

Note
Euler rotation curves are not directly used for animation. They should be converted to quaternion based rotation curves, in order to be used for animation purposes. However, for editing of an animation in the editor, using Euler curves is much more intuitive for the user.

addGenericCurve

addGenericCurve(name: string, curve: CompoundAnimationCurve): void
Registers a new curve used for generic animation.
Parameters
- name: string
  Unique name of the curve. This can be used for retrieving the value of the curve from animation.
- curve: CompoundAnimationCurve
  Curve to add to the clip.
Returns void

addPositionCurve

addPositionCurve(name: string, curve: CompoundVector3Curve): void
Registers a new curve used for animating position.
Parameters
- name: string
  Unique name of the curve. This name will be used mapping the curve to the relevant bone in a skeleton, if any.
- curve: CompoundVector3Curve
  Curve to add to the clip.
Returns void

addRotationCurve

addRotationCurve(name: string, curve: CompoundQuaternionCurve): void
Registers a new curve used for animating rotation.
Parameters
- name: string
  Unique name of the curve. This name will be used mapping the curve to the relevant bone in a skeleton, if any.
- curve: CompoundQuaternionCurve
  Curve to add to the clip.
Returns void

addScaleCurve

addScaleCurve(name: string, curve: CompoundVector3Curve): void
Registers a new curve used for animating scale.
Parameters
- name: string
  Unique name of the curve. This name will be used mapping the curve to the relevant bone in a skeleton, if any.
- curve: CompoundVector3Curve
  Curve to add to the clip.
Returns void

removeEulerRotationCurve

removeEulerRotationCurve(name: string): void
Removes an existing curve from the clip.
Parameters
- name: string
Returns void

removeGenericCurve

removeGenericCurve(name: string): void
Removes an existing curve from the clip.
Parameters
- name: string
Returns void

removePositionCurve

removePositionCurve(name: string): void
Removes an existing curve from the clip.
Parameters
- name: string
Returns void

removeRotationCurve

removeRotationCurve(name: string): void
Removes an existing curve from the clip.
Parameters
- name: string
Returns void

removeScaleCurve

removeScaleCurve(name: string): void
Removes an existing curve from the clip.
Parameters
- name: string
Returns void

Class AnimationCurves

Index

Constructors

Accessors

Methods

Constructors

constructor

Parameters

Returns AnimationCurves

Accessors

eulerRotation

Returns Iterable<NamedVector3Curve>

Parameters

Returns void

generic

Returns Iterable<NamedFloatCurve>

Parameters

Returns void

position

Returns Iterable<NamedVector3Curve>

Parameters

Returns void

rotation

Returns Iterable<NamedQuaternionCurve>

Parameters

Returns void

scale

Returns Iterable<NamedVector3Curve>

Parameters

Returns void

Methods

addEulerRotation

Parameters

Returns void

Note

addGenericCurve

Parameters

Returns void

addPositionCurve

Parameters

Returns void

addRotationCurve

Parameters

Returns void

addScaleCurve

Parameters

Returns void

removeEulerRotationCurve

Parameters

Returns void

removeGenericCurve

Parameters

Returns void

removePositionCurve

Parameters

Returns void

removeRotationCurve

Parameters

Returns void

removeScaleCurve

Parameters

Returns void

Settings

On This Page