Class TemporalAction
- java.lang.Object
-
- com.badlogic.gdx.scenes.scene2d.Action
-
- 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.
-
-
Constructor Summary
Constructors Constructor Description TemporalAction()
TemporalAction(float duration)
TemporalAction(float duration, Interpolation interpolation)
-
Method Summary
All Methods Instance Methods Abstract Methods Concrete Methods Modifier and Type Method Description boolean
act(float delta)
Updates the action based on time.protected void
begin()
Called the first timeact(float)
is called.protected void
end()
Called the last timeact(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
isComplete()
Returns true afteract(float)
has been called where time >= duration.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.
-
-
-
Constructor Detail
-
TemporalAction
public TemporalAction()
-
TemporalAction
public TemporalAction(float duration)
-
TemporalAction
public TemporalAction(float duration, @Null 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 byActor.act(float)
.
-
begin
protected void begin()
Called the first timeact(float)
is called. This is a good place to query theactor's
starting state.
-
end
protected void end()
Called the last timeact(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. Ifreversed
, 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.
-
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 interfacePool.Poolable
- Overrides:
reset
in classAction
-
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
@Null public Interpolation getInterpolation()
-
setInterpolation
public void setInterpolation(@Null Interpolation interpolation)
-
isReverse
public boolean isReverse()
-
setReverse
public void setReverse(boolean reverse)
When true, the action's progress will go from 100% to 0%.
-
isComplete
public boolean isComplete()
Returns true afteract(float)
has been called where time >= duration.
-
-