org.robokind.api.animation.messaging
Class RemoteAnimationPlayerClient

java.lang.Object
  extended by org.robokind.api.animation.messaging.RemoteAnimationPlayerClient
All Implemented Interfaces:
AnimationPlayer

public class RemoteAnimationPlayerClient
extends Object
implements AnimationPlayer

Author:
Matthew Stevenson

Field Summary
 
Fields inherited from interface org.robokind.api.animation.player.AnimationPlayer
PROP_PLAYER_ID
 
Constructor Summary
RemoteAnimationPlayerClient(String animPlayerClientId, String animPlayerHostId)
           
 
Method Summary
 void clearAnimations()
           
 String getAnimationPlayerId()
           
 List<AnimationJob> getCurrentAnimations()
          Returns a List of all uncleared AnimationJobs which have been played by the AnimationPlayer.
 AnimationJob loopAnimation(Animation animation)
           
 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.
 void setAnimationEventFactory(AnimationEvent.AnimationEventFactory factory)
           
 void setAnimationEventSender(org.robokind.api.messaging.MessageSender<AnimationEvent> sender)
           
 void stopAnimation(Animation animation)
           
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

RemoteAnimationPlayerClient

public RemoteAnimationPlayerClient(String animPlayerClientId,
                                   String animPlayerHostId)
Method Detail

getAnimationPlayerId

public String getAnimationPlayerId()
Specified by:
getAnimationPlayerId in interface AnimationPlayer

setAnimationEventFactory

public void setAnimationEventFactory(AnimationEvent.AnimationEventFactory factory)

setAnimationEventSender

public void setAnimationEventSender(org.robokind.api.messaging.MessageSender<AnimationEvent> sender)

playAnimation

public AnimationJob playAnimation(Animation animation)
Description copied from interface: AnimationPlayer
Creates an AnimationJob which plays the given Animation.

Specified by:
playAnimation in interface AnimationPlayer
Parameters:
animation - Animation to play
Returns:
AnimationJob playing the Animation

loopAnimation

public AnimationJob loopAnimation(Animation animation)

stopAnimation

public void stopAnimation(Animation animation)

clearAnimations

public void clearAnimations()

playAnimation

public AnimationJob playAnimation(Animation animation,
                                  Long start,
                                  Long stop)
Description copied from interface: AnimationPlayer
Creates an AnimationJob which plays the given Animation.

Specified by:
playAnimation in interface AnimationPlayer
Parameters:
animation - Animation to play
start - animation start time
stop - animation stop time
Returns:
AnimationJob playing the Animation

getCurrentAnimations

public List<AnimationJob> getCurrentAnimations()
Description copied from interface: AnimationPlayer
Returns a List of all uncleared AnimationJobs which have been played by the AnimationPlayer.

Specified by:
getCurrentAnimations in interface AnimationPlayer
Returns:
List of all uncleared AnimationJobs which have been played by the AnimationPlayer

removeAnimationJob

public void removeAnimationJob(AnimationJob job)
Description copied from interface: AnimationPlayer
Clears an AnimationJob from the List of AnimationJobs from the AnimationPlayer.

Specified by:
removeAnimationJob in interface AnimationPlayer
Parameters:
job - AnimationJob to remove


Copyright © 2011-2013. All Rights Reserved.