com.threerings.media.animation

Class AnimationFrameSequencer.MultiFunction

java.lang.Object

com.threerings.media.animation.AnimationFrameSequencer.MultiFunction

All Implemented Interfaces:

AnimationFrameSequencer, FrameSequencer

Enclosing interface:

AnimationFrameSequencer

public static class AnimationFrameSequencer.MultiFunction
extends Object
implements AnimationFrameSequencer

A sequencer that can step through a series of frames in any order and speed and notify (via SequencedAnimationObserver) when specific frames are reached.

Nested Class Summary

Nested classes/interfaces inherited from interface com.threerings.media.animation.AnimationFrameSequencer

AnimationFrameSequencer.MultiFunction

Nested classes/interfaces inherited from interface com.threerings.media.util.FrameSequencer

FrameSequencer.ConstantRate

Constructor Summary

Constructors

Constructor and Description
MultiFunction(int[] sequence, long[] msPerFrame, boolean[] marks, boolean loop) Creates a fully-specified multifunction frame sequencer.
MultiFunction(int[] sequence, long msPerFrame, boolean loop) Creates the simplest multifunction frame sequencer.

Method Summary

Modifier and Type	Method and Description
void	fastForward(long timeDelta) Called if the display is paused for some length of time and then unpaused.
int	init(MultiFrameImage source) Called prior to the execution of an animation sequence (not necessarily immediately, so time stamps should be obtained in the first call to tick).
void	setAnimation(Animation anim) Called after init to set the animation.
void	setDelay(long msPerFrame) Set the delay to use.
void	setLength(int len) Set the length of the sequence we are to use, or 0 means set it to the length of the sequence array that we were constructed with.
void	setResetOnInit(boolean resets) Do we reset the animation on init? Default is true.
int	tick(long tickStamp) Called every display frame, the frame sequencer should return the index of the animation frame that should be displayed during this tick.

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

MultiFunction

public MultiFunction(int[] sequence,
                     long msPerFrame,
                     boolean loop)

Creates the simplest multifunction frame sequencer.

Parameters:

sequence - the ordering to display the frames.

msPerFrame - the number of ms to display each frame.

loop - if false, the sequencer will report the end of the animation after progressing through all of the frames once, otherwise it will loop indefinitely.

MultiFunction

public MultiFunction(int[] sequence,
                     long[] msPerFrame,
                     boolean[] marks,
                     boolean loop)

Creates a fully-specified multifunction frame sequencer.

Parameters:

sequence - the ordering to display the frames.

msPerFrame - the number of ms to display each frame.

marks - if true for a frame, a FrameReachedEvent will be generated when that frame is reached.

loop - if false, the sequencer will report the end of the animation after progressing through all of the frames once, otherwise it will loop indefinitely.

Method Detail

setDelay

public void setDelay(long msPerFrame)

Set the delay to use.

setLength

public void setLength(int len)

Set the length of the sequence we are to use, or 0 means set it to the length of the sequence array that we were constructed with.

setResetOnInit

public void setResetOnInit(boolean resets)

Do we reset the animation on init? Default is true.

init

public int init(MultiFrameImage source)

Description copied from interface: FrameSequencer

Called prior to the execution of an animation sequence (not necessarily immediately, so time stamps should be obtained in the first call to tick).

Specified by:

init in interface FrameSequencer

Parameters:

source - the multi-frame image that is providing the animation frames.

Returns:

initial frame index

setAnimation

public void setAnimation(Animation anim)

Description copied from interface: AnimationFrameSequencer

Called after init to set the animation.

Specified by:

setAnimation in interface AnimationFrameSequencer

tick

public int tick(long tickStamp)

Description copied from interface: FrameSequencer

Called every display frame, the frame sequencer should return the index of the animation frame that should be displayed during this tick. If the sequencer returns -1, it is taken as an indication that the animation is finished and should be stopped.

Specified by:

tick in interface FrameSequencer

fastForward

public void fastForward(long timeDelta)

Description copied from interface: FrameSequencer

Called if the display is paused for some length of time and then unpaused. Sequencers should adjust any time stamps they are maintaining internally by the delta so that time maintains the illusion of flowing smoothly forward.

Specified by:

fastForward in interface FrameSequencer