Class KeyFrame

Animation keyframe, represented as an endpoint of a cubic hermite spline.

Index

Constructors

Properties

_inTangent _outTangent _tangentMode _time _value

Accessors

inTangent outTangent tangentMode time value

Methods

assign clone isEqual isEqual

Constructors

constructor

new KeyFrame(
    value?: number,
    inTangent?: number,
    outTangent?: number,
    time?: number,
    tangentMode?: EnumValue<TangentMode>,
): KeyFrame
Parameters
- Optionalvalue: number
- OptionalinTangent: number
- OptionaloutTangent: number
- Optionaltime: number
- OptionaltangentMode: EnumValue<TangentMode>
Returns KeyFrame

Properties

`Protected`_inTangent

_inTangent: number

`Protected`_outTangent

_outTangent: number

`Protected`_tangentMode

_tangentMode: EnumValue<TangentMode>

`Protected`_time

_time: number

`Protected`_value

_value: number

Accessors

inTangent

get inTangent(): number

Input tangent (going from the previous key to this one) of the key.

Returns number
set inTangent(value: number): void
Parameters
- value: number
Returns void

outTangent

get outTangent(): number

Output tangent (going from this key to next one) of the key.

Returns number
set outTangent(value: number): void
Parameters
- value: number
Returns void

tangentMode

get tangentMode(): EnumValue<TangentMode>

The keyframe's tangent mode (this field is needed only inside the editor).

Returns EnumValue<TangentMode>
set tangentMode(value: EnumValue<TangentMode>): void
Parameters
- value: EnumValue<TangentMode>
Returns void

time

get time(): number

Position of the key along the animation spline.

Returns number
set time(value: number): void
Parameters
- value: number
Returns void

value

get value(): number

Value of the key.

Returns number
set value(value: number): void
Parameters
- value: number
Returns void

Methods

assign

assign(other: Immutable<KeyFrame>): KeyFrame
Copies all properties defined by the prototype of KeyFrame from other to this instance.
Parameters
- other: Immutable<KeyFrame>
Returns KeyFrame

clone

clone(): KeyFrame

Clones this instance and returns a new KeyFrame with identical values.

Returns KeyFrame

isEqual

isEqual(this: Immutable<KeyFrame>, other: Immutable<KeyFrame>): boolean
Determines if this KeyFrame instance is equal to the other instance.
Parameters
- this: Immutable<KeyFrame>
- other: Immutable<KeyFrame>
Returns boolean

`Static`isEqual

isEqual(lhs: Immutable<KeyFrame>, rhs: Immutable<KeyFrame>): boolean
Determines if both KeyFrame instances are equal.
Parameters
- lhs: Immutable<KeyFrame>
- rhs: Immutable<KeyFrame>
Returns boolean