fr.lri.swingstates.canvas.animations.transitions

Class AnimationSuspended

java.lang.Object

fr.lri.swingstates.sm.Transition

fr.lri.swingstates.sm.transitions.Event

fr.lri.swingstates.canvas.animations.transitions.AnimationSuspended

public class AnimationSuspended
extends Event

A transition triggered by an animation that has just been suspended. For example, one can want to resume an animation animSlept when an animation animAwake is suspended.

        Transition tshape = new AnimationSuspended(animAwake) {
                public void action() {
                        // resumes
 
 animSlept
 
  animation.
                        animSlept.resume();
                }
        }
        
 

Author:

Caroline Appert

Constructor Summary

Constructors

Constructor and Description
AnimationSuspended() Builds a transition that loops on the current state triggered when any animation has just been suspended.
AnimationSuspended(Animation anim) Builds a transition that loops on the current state triggered when an animation has just been suspended.
AnimationSuspended(Animation anim, java.lang.String outState) Builds a transition triggered when an animation has just been supended.
AnimationSuspended(ATag tagAnim) Builds a transition that loops on the current state triggered when a tagged animation has just been suspended.
AnimationSuspended(ATag tagAnim, java.lang.String outState) Builds a transition triggered when a tagged animation has just been supended.
AnimationSuspended(java.lang.String outState) Builds a transition triggered when any animation has just been supended.

Method Summary

Methods

Modifier and Type	Method and Description
Animation	getAnimation()
VirtualAnimationEvent	getAnimationEvent()
boolean	matches(java.util.EventObject eventObject) Tests if an event can trigger that transition.
java.lang.String	toString()

Methods inherited from class fr.lri.swingstates.sm.transitions.Event

getClassEvent

Methods inherited from class fr.lri.swingstates.sm.Transition

action, getEvent, getInputState, getOutputState, guard, manageEventID, oldToString, pickingRequired, setTriggeringEvent

Methods inherited from class java.lang.Object

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

Constructor Detail

AnimationSuspended

public AnimationSuspended()

Builds a transition that loops on the current state triggered when any animation has just been suspended.

AnimationSuspended

public AnimationSuspended(Animation anim)

Builds a transition that loops on the current state triggered when an animation has just been suspended.

Parameters:

anim - The animation that fires this transition.

AnimationSuspended

public AnimationSuspended(ATag tagAnim)

Builds a transition that loops on the current state triggered when a tagged animation has just been suspended.

Parameters:

tagAnim - The tag of the animation that fires this transition.

AnimationSuspended

public AnimationSuspended(java.lang.String outState)

Builds a transition triggered when any animation has just been supended.

Parameters:

outState - The name of the output state.

AnimationSuspended

public AnimationSuspended(Animation anim,
                  java.lang.String outState)

Builds a transition triggered when an animation has just been supended.

Parameters:

anim - The animation that fires this transition.

outState - The name of the output state.

AnimationSuspended

public AnimationSuspended(ATag tagAnim,
                  java.lang.String outState)

Builds a transition triggered when a tagged animation has just been supended.

Parameters:

tagAnim - The tag of the animation that fires this transition.

outState - The name of the output state.

Method Detail

getAnimation

public Animation getAnimation()

Returns:

the animation that has just fired this transition.

getAnimationEvent

public VirtualAnimationEvent getAnimationEvent()

toString

public java.lang.String toString()

Overrides:

toString in class Event

matches

public boolean matches(java.util.EventObject eventObject)

Tests if an event can trigger that transition.

Overrides:

matches in class Event

Parameters:

eventObject - The event to test

Returns:

True if the eventObject can trigger this transition.