Tween

Wick. Tween

Class representing a tween.

Constructor

new Tween(playheadPosition, transformation, fullRotations)

Description:
  • Create a tween

Source:
Parameters:
Name Type Description
playheadPosition number

the playhead position relative to the frame that the tween belongs to

transformation Wick.Transform

the transformation this tween will apply to child objects

fullRotations number

the number of rotations to add to the tween's transformation

Members

easingType :string

Description:
  • The type of interpolation to use for easing.

Source:

The type of interpolation to use for easing.

Type:
  • string

layerIndex :number

Description:
  • The index of the parent layer of this tween.

Source:

The index of the parent layer of this tween.

Type:
  • number

originalLayerIndex :number

Description:
  • The index of the layer that this tween last belonged to. Used when copying and pasting tweens.

Source:

The index of the layer that this tween last belonged to. Used when copying and pasting tweens.

Type:
  • number

playheadPosition :number

Description:
  • The playhead position of the tween.

Source:

The playhead position of the tween.

Type:
  • number

transformation :object

Description:
  • The transformation representing the position, rotation and other elements of the tween.

Source:

The transformation representing the position, rotation and other elements of the tween.

Type:
  • object

Methods

(static) interpolate(tweenA, tweenB, playheadPosition)

Description:
  • Create a tween by interpolating two existing tweens.

Source:
Parameters:
Name Type Description
tweenA Wick.Tween

The first tween

tweenB Wick.Tween

The second tween

playheadPosition Number

The point between the two tweens to use to interpolate

applyTransformsToClip(clip)

Description:
  • Set the transformation of a clip to this tween's transformation.

Source:
Parameters:
Name Type Description
clip Wick.Clip

the clip to apply the tween transforms to.

getNextTween() → {Wick.Tween}

Description:
  • The tween that comes after this tween in the parent frame.

Source:
Returns:
Type
Wick.Tween

remove()

Description:
  • Remove this tween from its parent frame.

Source:

restrictToFrameSize()

Description:
  • Prevents tweens from existing outside of the frame's length. Call this after changing the length of the parent frame.

Source: