Class KeyFrameVec3

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

Properties

`Protected`_inTangent

_inTangent: Vector3

`Protected`_outTangent

_outTangent: Vector3

`Protected`_tangentMode

_tangentMode: EnumValue<TangentMode>

`Protected`_time

_time: number

`Protected`_value

_value: Vector3

Accessors

inTangent

get inTangent(): Vector3

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

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

outTangent

get outTangent(): Vector3

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

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

Value of the key.

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

Methods

assign

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

clone

clone(): KeyFrameVec3

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

Returns KeyFrameVec3

isEqual

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

`Static`isEqual

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