Class KeyFrameVec2

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 KeyFrameVec2(
    value?: Immutable<Vector2>,
    inTangent?: Immutable<Vector2>,
    outTangent?: Immutable<Vector2>,
    time?: number,
    tangentMode?: EnumValue<TangentMode>,
): KeyFrameVec2
Parameters
- Optionalvalue: Immutable<Vector2>
- OptionalinTangent: Immutable<Vector2>
- OptionaloutTangent: Immutable<Vector2>
- Optionaltime: number
- OptionaltangentMode: EnumValue<TangentMode>
Returns KeyFrameVec2

Properties

`Protected`_inTangent

_inTangent: Vector2

`Protected`_outTangent

_outTangent: Vector2

`Protected`_tangentMode

_tangentMode: EnumValue<TangentMode>

`Protected`_time

_time: number

`Protected`_value

_value: Vector2

Accessors

inTangent

get inTangent(): Vector2

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

Returns Vector2
set inTangent(value: Immutable<Vector2>): void
Parameters
- value: Immutable<Vector2>
Returns void

outTangent

get outTangent(): Vector2

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

Returns Vector2
set outTangent(value: Immutable<Vector2>): void
Parameters
- value: Immutable<Vector2>
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(): Vector2

Value of the key.

Returns Vector2
set value(value: Immutable<Vector2>): void
Parameters
- value: Immutable<Vector2>
Returns void

Methods

assign

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

clone

clone(): KeyFrameVec2

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

Returns KeyFrameVec2

isEqual

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

`Static`isEqual

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