Animation

java.lang.Object
- org.mini2Dx.core.graphics.Animation<T>

public class Animation<T extends com.badlogic.gdx.graphics.g2d.Sprite>
extends java.lang.Object

Implements an animation with frames of variable or fixed duration

Constructor Summary

Constructors
Constructor and Description

Animation()
Constructor

Constructors
Constructor and Description
`Animation()` Constructor

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`addFrame(T frame, float duration)` Adds a frame to the animation
`void`	`draw(Graphics g)` Draws the current frame of the animation
`void`	`draw(Graphics g, float x, float y)` Draws the current frame of the animation
`void`	`flip(boolean flipX, boolean flipY)` Sets the flipX and flipY to the current frame
`com.badlogic.gdx.graphics.Color`	`getColor()` Returns the `Color` tint applied to each frame
`T`	`getCurrentFrame()` Returns the `T` of the current frame
`int`	`getCurrentFrameIndex()` Returns the index of the current frame
`boolean`	`getFlipX()` Returns the flipX of the current frame
`boolean`	`getFlipY()` Returns the flipY of the current frame
`T`	`getFrame(int index)` Returns the frame at a given index
`int`	`getNumberOfFrames()` Returns the total number of frames in this animation
`float`	`getOriginX()` Returns the origin X coordinate to be applied to each frame
`float`	`getOriginY()` Returns the origin Y coordinate to be applied to each frame
`float`	`getRotation()` Returns the rotation of all frames
`boolean`	`isFinished()` Returns if this animation has finished If this is a looping animation, this method always returns false
`boolean`	`isLooping()` Returns if the animation is looping
`void`	`removeFrame(int index)` Removes a frame from the animation
`void`	`restart()` Restarts the animation.
`void`	`rotate(float degrees)` Increases/decreases the rotation of all frames
`void`	`setColor(com.badlogic.gdx.graphics.Color color)` Sets the `Color` tint applied to each frame
`void`	`setColor(float r, float g, float b, float a)` Sets the `Color` tint applied to each frame
`void`	`setFlipX(boolean flipX)` Sets the flipX to the current frame
`void`	`setFlipY(boolean flipY)` Sets the flipY to the current frame
`void`	`setLooping(boolean looping)` Sets if the animation should loop
`void`	`setOriginX(float originX)` Sets the origin X coordinate to be applied to each frame
`void`	`setOriginY(float originY)` Sets the origin Y coordinate to be applied to each frame
`void`	`setRotation(float rotation)` Sets the rotation of all frames
`void`	`update(float delta)` Updates the animation

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - Animation
```
public Animation()
```
    Constructor
- Method Detail
  - addFrame
```
public void addFrame(T frame,
                     float duration)
```
    Adds a frame to the animation
    
    Parameters:
    
    frame - The frame to be added
    
    duration - The duration of the frame in seconds
  - removeFrame
```
public void removeFrame(int index)
```
    Removes a frame from the animation
    
    Parameters:
    
    index - The index of the frame to be removed
  - restart
```
public void restart()
```
    Restarts the animation. This is the equivalent to setting the current frame index to zero
  - update
```
public void update(float delta)
```
    Updates the animation
    
    Parameters:
    
    delta - The time in seconds since the last update
  - draw
```
public void draw(Graphics g)
```
    Draws the current frame of the animation
    
    Parameters:
    
    g - The Graphics context available for rendering
  - draw
```
public void draw(Graphics g,
                 float x,
                 float y)
```
    Draws the current frame of the animation
    
    Parameters:
    
    g - The Graphics context available for rendering
    
    x - The x coordinate to render at
    
    y - The y coordinate to render at
  - getFrame
```
public T getFrame(int index)
```
    Returns the frame at a given index
    
    Parameters:
    
    index - The frame's index
    
    Returns:
    
    Null if there is no frame image
  - getCurrentFrame
```
public T getCurrentFrame()
```
    Returns the T of the current frame
    
    Returns:
    
    Null if there is no frame image
  - getNumberOfFrames
```
public int getNumberOfFrames()
```
    Returns the total number of frames in this animation
    
    Returns:
    
    A value greater than or equal to 0
  - getCurrentFrameIndex
```
public int getCurrentFrameIndex()
```
    Returns the index of the current frame
    
    Returns:
    
    A value greater than or equal to 0
  - isLooping
```
public boolean isLooping()
```
    Returns if the animation is looping
    
    Returns:
    
    True if the animation is looping
  - setLooping
```
public void setLooping(boolean looping)
```
    Sets if the animation should loop
    
    Parameters:
    
    looping - False if the animation should stop when it reaches the last frame
  - rotate
```
public void rotate(float degrees)
```
    Increases/decreases the rotation of all frames
    
    Parameters:
    
    degrees - The amount in degrees to rotate by
  - getRotation
```
public float getRotation()
```
    Returns the rotation of all frames
    
    Returns:
    
    The rotation in degrees
  - setRotation
```
public void setRotation(float rotation)
```
    Sets the rotation of all frames
    
    Parameters:
    
    rotation - The rotation in degrees
  - getColor
```
public com.badlogic.gdx.graphics.Color getColor()
```
    Returns the Color tint applied to each frame
    
    Returns:
  - setColor
```
public void setColor(com.badlogic.gdx.graphics.Color color)
```
    Sets the Color tint applied to each frame
    
    Parameters:
    
    color -
  - setColor
```
public void setColor(float r,
                     float g,
                     float b,
                     float a)
```
    Sets the Color tint applied to each frame
    
    Parameters:
    
    r - The red value (0f - 1f)
    
    g - The green value (0f - 1f)
    
    b - The blue value (0f - 1f)
    
    a - The alpha value (0f - 1f)
  - getOriginX
```
public float getOriginX()
```
    Returns the origin X coordinate to be applied to each frame
    
    Returns:
  - setOriginX
```
public void setOriginX(float originX)
```
    Sets the origin X coordinate to be applied to each frame
    
    Parameters:
    
    originX -
  - getOriginY
```
public float getOriginY()
```
    Returns the origin Y coordinate to be applied to each frame
    
    Returns:
  - setOriginY
```
public void setOriginY(float originY)
```
    Sets the origin Y coordinate to be applied to each frame
    
    Parameters:
    
    originY -
  - flip
```
public void flip(boolean flipX,
                 boolean flipY)
```
    Sets the flipX and flipY to the current frame
    
    Parameters:
    
    flipX -
    
    flipY -
  - setFlipX
```
public void setFlipX(boolean flipX)
```
    Sets the flipX to the current frame
    
    Parameters:
    
    flipX -
  - setFlipY
```
public void setFlipY(boolean flipY)
```
    Sets the flipY to the current frame
    
    Parameters:
    
    flipY -
  - getFlipX
```
public boolean getFlipX()
```
    Returns the flipX of the current frame
    
    Returns:
  - getFlipY
```
public boolean getFlipY()
```
    Returns the flipY of the current frame
    
    Returns:
  - isFinished
```
public boolean isFinished()
```
    Returns if this animation has finished If this is a looping animation, this method always returns false
    
    Returns:
    
    True if animation has finished

Class Animation<T extends com.badlogic.gdx.graphics.g2d.Sprite>

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

Animation

Method Detail

addFrame

removeFrame

restart

update

draw

draw

getFrame

getCurrentFrame

getNumberOfFrames

getCurrentFrameIndex

isLooping

setLooping

rotate

getRotation

setRotation

getColor

setColor

setColor

getOriginX

setOriginX

getOriginY

setOriginY

flip

setFlipX

setFlipY

getFlipX

getFlipY

isFinished