libgdx API

com.badlogic.gdx.scenes.scene2d.actions
Class TemporalAction

java.lang.Object
  extended by com.badlogic.gdx.scenes.scene2d.Action
      extended by com.badlogic.gdx.scenes.scene2d.actions.TemporalAction
All Implemented Interfaces:
Pool.Poolable
Direct Known Subclasses:
AlphaAction, ColorAction, FloatAction, IntAction, MoveToAction, RelativeTemporalAction, RotateToAction, ScaleToAction, SizeToAction

public abstract class TemporalAction
extends Action

Base class for actions that transition over time using the percent complete.

Author:
Nathan Sweet

Field Summary
 
Fields inherited from class com.badlogic.gdx.scenes.scene2d.Action
actor
 
Constructor Summary
TemporalAction()
           
TemporalAction(float duration)
           
TemporalAction(float duration, Interpolation interpolation)
           
 
Method Summary
 boolean act(float delta)
          Updates the action based on time.
protected  void begin()
          Called the first time act(float) is called.
protected  void end()
          Called the last time act(float) is called.
 void finish()
          Skips to the end of the transition.
 float getDuration()
           
 Interpolation getInterpolation()
           
 float getTime()
          Gets the transition time so far.
 boolean isReverse()
           
 void reset()
          Resets the optional state of this action to as if it were newly created, allowing the action to be pooled and reused.
 void restart()
          Sets the state of the action so it can be run again.
 void setDuration(float duration)
          Sets the length of the transition in seconds.
 void setInterpolation(Interpolation interpolation)
           
 void setReverse(boolean reverse)
          When true, the action's progress will go from 100% to 0%.
 void setTime(float time)
          Sets the transition time so far.
protected abstract  void update(float percent)
          Called each frame.
 
Methods inherited from class com.badlogic.gdx.scenes.scene2d.Action
getActor, getPool, setActor, setPool, toString
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Constructor Detail

TemporalAction

public TemporalAction()

TemporalAction

public TemporalAction(float duration)

TemporalAction

public TemporalAction(float duration,
                      Interpolation interpolation)
Method Detail

act

public boolean act(float delta)
Description copied from class: Action
Updates the action based on time. Typically this is called each frame by Actor.act(float).

Specified by:
act in class Action
Parameters:
delta - Time in seconds since the last frame.
Returns:
true if the action is done. This method may continue to be called after the action is done.

begin

protected void begin()
Called the first time act(float) is called. This is a good place to query the actor's starting state.


end

protected void end()
Called the last time act(float) is called.


update

protected abstract void update(float percent)
Called each frame.

Parameters:
percent - The percentage of completion for this action, growing from 0 to 1 over the duration. If reversed, this will shrink from 1 to 0.

finish

public void finish()
Skips to the end of the transition.


restart

public void restart()
Description copied from class: Action
Sets the state of the action so it can be run again.

Overrides:
restart in class Action

reset

public void reset()
Description copied from class: Action
Resets the optional state of this action to as if it were newly created, allowing the action to be pooled and reused. State required to be set for every usage of this action or computed during the action does not need to be reset.

The default implementation calls Action.restart().

If a subclass has optional state, it must override this method, call super, and reset the optional state.

Specified by:
reset in interface Pool.Poolable
Overrides:
reset in class Action

getTime

public float getTime()
Gets the transition time so far.


setTime

public void setTime(float time)
Sets the transition time so far.


getDuration

public float getDuration()

setDuration

public void setDuration(float duration)
Sets the length of the transition in seconds.


getInterpolation

public Interpolation getInterpolation()

setInterpolation

public void setInterpolation(Interpolation interpolation)

isReverse

public boolean isReverse()

setReverse

public void setReverse(boolean reverse)
When true, the action's progress will go from 100% to 0%.


libgdx API

Copyright 2010 Mario Zechner (contact@badlogicgames.com), Nathan Sweet (admin@esotericsoftware.com)