Skip to main content

AnimationKeyFrame

Class

A keyframe with time and respective value.

  • Available on all platforms
Platform details: Snapchat, SPECS, Camera Kit Web, Camera Kit Mobile fully supported.

Platform details

  • Snapchat — Fully supported.

  • SPECS — Fully supported.

  • Camera Kit Web — Fully supported.

  • Camera Kit Mobile — Fully supported.

Since Lens Scripting v234

A keyframe with time and respective value. Could be added to Animation Curve.

Index

Example

// Example of creating keyframe

var keyFrame = AnimationCurve.createKeyFrame();

//Change weighted control points
keyFrame.time = 0.0;
keyFrame.value = 0.0;
keyFrame.inWeightPoint.y = 5;
keyFrame.inWeightPoint.x = 0.5;

keyFrame.time = 1.0;
keyFrame.value = 1.0;
keyFrame.outWeightPoint.y = -10;
keyFrame.outWeightPoint.x = 0.7;

Extends

Properties

inWeightPoint

inWeightPoint: vec2

Incoming Control Point.

Since

Lens Scripting Version 234

Default Value

(0.33, 0.33)

leftTangentType

leftTangentType: TangentType

Since

Lens Scripting Version 234

Default Value

TangentType.Free

outWeightPoint

outWeightPoint: vec2

Outgoing Control Point.

Since

Lens Scripting Version 234

Default Value

(0.33, 0.33)

rightTangentType

rightTangentType: TangentType

Since

Lens Scripting Version 234

Default Value

TangentType.Free

time

time: number

Timestamp of the keyframe.

Since

Lens Scripting Version 234

Default Value

0

value

value: number

Value of the respective timestamp.

Since

Lens Scripting Version 234

Default Value

0

weightedMode

weightedMode: WeightedMode

Since

Lens Scripting Version 234

Default Value

WeightedMode.Easing

Methods

getTypeName()

static getTypeName(): TypeName<AnimationKeyFrame>

Returns the fully-qualified JavaScript type name for this class (for example, "Component.Camera"). This is a static accessor (no instance required) and returns the same value as the instance getTypeName().

Returns

TypeName<AnimationKeyFrame>

Since

Lens Scripting Version 234

Overrides

ScriptObject.getTypeName


getTypeName()

getTypeName(): string

Returns the name of this object's type.

Returns

string

Inherited from

ScriptObject.getTypeName


isOfType()

isOfType(type): boolean

Returns true if the object matches or derives from the passed in type.

Parameters

ParameterType
typestring

Returns

boolean

Inherited from

ScriptObject.isOfType


isSame()

isSame(other): boolean

Returns true if this object is the same as other. Useful for checking if two references point to the same thing.

Parameters

ParameterType
otherScriptObject

Returns

boolean

Inherited from

ScriptObject.isSame