org.mechio.api.animation.messaging

Class RemoteAnimationPlayerClient

java.lang.Object

org.jflux.api.core.util.DefaultNotifier<AnimationSignal>

org.mechio.api.animation.messaging.RemoteAnimationPlayerClient

All Implemented Interfaces:

org.jflux.api.core.Listener<AnimationSignal>, org.jflux.api.core.Notifier<AnimationSignal>, AnimationPlayer

public class RemoteAnimationPlayerClient
extends org.jflux.api.core.util.DefaultNotifier<AnimationSignal>
implements AnimationPlayer, org.jflux.api.core.Listener<AnimationSignal>

Author:

Matthew Stevenson

Field Summary

Fields inherited from class org.jflux.api.core.util.DefaultNotifier

myListeners

Fields inherited from interface org.mechio.api.animation.player.AnimationPlayer

PROP_PLAYER_ID

Constructor Summary

Constructors

Constructor and Description
RemoteAnimationPlayerClient(org.osgi.framework.BundleContext context, String animPlayerClientId, String animPlayerHostId)

Method Summary

Methods

Modifier and Type	Method and Description
void	addAnimationSignalListener(org.jflux.api.core.Listener<AnimationSignal> listener) Adds a Listener for AnimationSignal events.
void	clearAnimations()
String	getAnimationPlayerId()
List<AnimationJob>	getCurrentAnimations() Returns a List of all uncleared AnimationJobs which have been played by the AnimationPlayer.
void	handleEvent(AnimationSignal t)
AnimationJob	loopAnimation(Animation animation)
AnimationJob	loopAnimation(Animation animation, boolean register)
AnimationJob	playAnimation(Animation animation) Creates an AnimationJob which plays the given Animation.
AnimationJob	playAnimation(Animation animation, boolean register)
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	removeAnimationSignalListener(org.jflux.api.core.Listener<AnimationSignal> listener) Removes a Listener for AnimationSignal events.
void	setAnimationEventFactory(AnimationEvent.AnimationEventFactory factory)
void	setAnimationEventSender(org.jflux.api.messaging.rk.MessageSender<AnimationEvent> sender)
void	setAnimationSignalReceiver(org.jflux.api.messaging.rk.MessageAsyncReceiver<AnimationSignal> receiver)
void	stopAnimation(Animation animation)

Methods inherited from class org.jflux.api.core.util.DefaultNotifier

addListener, notifyListeners, removeListener

Methods inherited from class java.lang.Object

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

Constructor Detail

RemoteAnimationPlayerClient

public RemoteAnimationPlayerClient(org.osgi.framework.BundleContext context,
                           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.jflux.api.messaging.rk.MessageSender<AnimationEvent> sender)

setAnimationSignalReceiver

public void setAnimationSignalReceiver(org.jflux.api.messaging.rk.MessageAsyncReceiver<AnimationSignal> receiver)

playAnimation

public AnimationJob playAnimation(Animation animation,
                         boolean register)

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,
                         boolean register)

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

addAnimationSignalListener

public void addAnimationSignalListener(org.jflux.api.core.Listener<AnimationSignal> listener)

Description copied from interface: AnimationPlayer

Adds a Listener for AnimationSignal events.

Specified by:

addAnimationSignalListener in interface AnimationPlayer

Parameters:

listener - Listener for AnimationSignal events

removeAnimationSignalListener

public void removeAnimationSignalListener(org.jflux.api.core.Listener<AnimationSignal> listener)

Description copied from interface: AnimationPlayer

Removes a Listener for AnimationSignal events.

Specified by:

removeAnimationSignalListener in interface AnimationPlayer

Parameters:

listener - Listener for AnimationSignal events

handleEvent

public void handleEvent(AnimationSignal t)

Specified by:

handleEvent in interface org.jflux.api.core.Listener<AnimationSignal>