org.robokind.api.animation.player
Interface AnimationPlayer

All Known Implementing Classes:
RemoteAnimationPlayerClient

public interface AnimationPlayer

An AnimationPlayer plays an Animation by creating an AnimationJob which defines how the Animation advances.

Author:
Matthew Stevenson

Field Summary
static String PROP_PLAYER_ID
           
 
Method Summary
 String getAnimationPlayerId()
           
 List<AnimationJob> getCurrentAnimations()
          Returns a List of all uncleared AnimationJobs which have been played by the AnimationPlayer.
 AnimationJob playAnimation(Animation animation)
          Creates an AnimationJob which plays the given Animation.
 AnimationJob playAnimation(Animation animation, Long start, Long stop)
          Creates an AnimationJob which plays the given Animation.
 void removeAnimationJob(AnimationJob job)
          Clears an AnimationJob from the List of AnimationJobs from the AnimationPlayer.
 

Field Detail

PROP_PLAYER_ID

static final String PROP_PLAYER_ID
See Also:
Constant Field Values
Method Detail

getAnimationPlayerId

String getAnimationPlayerId()

playAnimation

AnimationJob playAnimation(Animation animation)
Creates an AnimationJob which plays the given Animation.

Parameters:
animation - Animation to play
Returns:
AnimationJob playing the Animation

playAnimation

AnimationJob playAnimation(Animation animation,
                           Long start,
                           Long stop)
Creates an AnimationJob which plays the given Animation.

Parameters:
animation - Animation to play
start - animation start time
stop - animation stop time
Returns:
AnimationJob playing the Animation

getCurrentAnimations

List<AnimationJob> getCurrentAnimations()
Returns a List of all uncleared AnimationJobs which have been played by the AnimationPlayer.

Returns:
List of all uncleared AnimationJobs which have been played by the AnimationPlayer

removeAnimationJob

void removeAnimationJob(AnimationJob job)
Clears an AnimationJob from the List of AnimationJobs from the AnimationPlayer.

Parameters:
job - AnimationJob to remove


Copyright © 2011-2013. All Rights Reserved.