Class lime.animation.KeyframeAnimation

Extends lime.animation.Animation.

Defined in: keyframeanimation.js.

Class Summary
Constructor Attributes	Constructor Name and Description
	lime.animation.KeyframeAnimation() Keyframe Animation object.

Field Summary
Field Attributes	Field Name and Description
<private>	currentFrame_ Current frame index of the playhead
	delay Delay in seconds between frames
<private>	frames_ Array of frame images
	looping Should the animation keep looping or stop when frame animation done.
<private>	numFramesLoaded_ Number of frame images loaded
	scope
<private>	usesBackgroundCanvas_ Animation is using Background Canvas to make the changes.

Fields borrowed from class lime.animation.Animation:: isPlaying_, targets, update

Method Summary
Method Attributes	Method Name and Description
	addFrame(frame) Add frame to the current animation
<private>	frameLoadedHandler_() Handler to be called on every loaded frame image
	getDelay() Returns the delay in seconds between frames.
	play()
	setDelay(value) Set the delay between frames to specific value.
	setFrames(frames) Set array of frames to be used in the animation
	setLooping(looping) Set the keyframe animation to keep loopoing or just play the animation once.
	updateAll(t, targets)

Methods borrowed from class lime.animation.Animation:: addTarget, cloneParam, enableOptimizations, getDirector, getDuration, getEasing, getTargetProp, initTarget, makeTargetProp, removeTarget, reverse, setDuration, setEasing, step_, stop, useTransitions

Class Detail

lime.animation.KeyframeAnimation()

Keyframe Animation object. Keyframe Animation contains images that are changed on targets. Similar to GIF effect.

Field Detail

<private> currentFrame_

Current frame index of the playhead

delay

Delay in seconds between frames

<private> frames_

Array of frame images

looping

Should the animation keep looping or stop when frame animation done. Setting loopoing to true, this is deafault behaviour.

<private> numFramesLoaded_

Number of frame images loaded

scope

<private> usesBackgroundCanvas_

Animation is using Background Canvas to make the changes. Faster if there are many targets but only supported on Webkit.

Method Detail

{lime.animation.KeyframeAnimation} addFrame(frame)

Add frame to the current animation

Parameters:
{string} frame: Path to frame image.

Returns:: {lime.animation.KeyframeAnimation} object itself.

<private> frameLoadedHandler_()

Handler to be called on every loaded frame image

{number} getDelay()

Returns the delay in seconds between frames.

Returns:: {number} Delay between frames.

play()

{lime.animation.KeyframeAnimation} setDelay(value)

Set the delay between frames to specific value.

Parameters:
{number} value: New delay value.

Returns:: {lime.animation.KeyframeAnimation} object itself.

{lime.animation.KeyframeAnimation} setFrames(frames)

Set array of frames to be used in the animation

Parameters:
{Array.} frames: Paths to frame images.

Returns:: {lime.animation.KeyframeAnimation} object itself.

{lime.animation.KeyframeAnimation} setLooping(looping)

Set the keyframe animation to keep loopoing or just play the animation once.

Parameters:
{boolean} looping: Keep looping or not.

Returns:: {lime.animation.KeyframeAnimation} object itself.

updateAll(t, targets)

Parameters:
t
targets

Classes

Class lime.animation.KeyframeAnimation