Package com.badlogic.gdx.scenes.scene2d.actions

Class FloatAction

java.lang.Object

com.badlogic.gdx.scenes.scene2d.Action

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

com.badlogic.gdx.scenes.scene2d.actions.FloatAction

All Implemented Interfaces:

Pool.Poolable

public class FloatAction
extends TemporalAction

An action that has a float, whose value is transitioned over time.

Field Summary

Fields inherited from class com.badlogic.gdx.scenes.scene2d.Action

actor, target

Constructor Summary

Constructors

Constructor	Description
FloatAction()	Creates a FloatAction that transitions from 0 to 1.
FloatAction(float start, float end)	Creates a FloatAction that transitions from start to end.
FloatAction(float start, float end, float duration)	Creates a FloatAction that transitions from start to end.
FloatAction(float start, float end, float duration, Interpolation interpolation)	Creates a FloatAction that transitions from start to end.

Method Summary

Modifier and Type	Method	Description
protected void	begin()	Called the first time TemporalAction.act(float) is called.
float	getEnd()
float	getStart()
float	getValue()	Gets the current float value.
void	setEnd(float end)	Sets the value to transition to.
void	setStart(float start)	Sets the value to transition from.
void	setValue(float value)	Sets the current float value.
protected void	update(float percent)	Called each frame.

Methods inherited from class com.badlogic.gdx.scenes.scene2d.actions.TemporalAction

act, end, finish, getDuration, getInterpolation, getTime, isComplete, isReverse, reset, restart, setDuration, setInterpolation, setReverse, setTime

Methods inherited from class com.badlogic.gdx.scenes.scene2d.Action

getActor, getPool, getTarget, setActor, setPool, setTarget, toString

Methods inherited from class java.lang.Object

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

Constructor Detail

FloatAction

public FloatAction()

Creates a FloatAction that transitions from 0 to 1.

FloatAction

public FloatAction(float start,
                   float end)

Creates a FloatAction that transitions from start to end.

FloatAction

public FloatAction(float start,
                   float end,
                   float duration)

Creates a FloatAction that transitions from start to end.

FloatAction

public FloatAction(float start,
                   float end,
                   float duration,
                   @Null
                   Interpolation interpolation)

Creates a FloatAction that transitions from start to end.

Method Detail

begin

protected void begin()

Description copied from class: TemporalAction

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

Overrides:

begin in class TemporalAction

update

protected void update(float percent)

Description copied from class: TemporalAction

Called each frame.

Specified by:

update in class TemporalAction

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.

getValue

public float getValue()

Gets the current float value.

setValue

public void setValue(float value)

Sets the current float value.

getStart

public float getStart()

setStart

public void setStart(float start)

Sets the value to transition from.

getEnd

public float getEnd()

setEnd

public void setEnd(float end)

Sets the value to transition to.