Animation (mini2Dx-parent 0.8 API)

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

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

Implements an animation with frames of variable or fixed duration

Author:: Thomas Cashman

Constructor Summary

Constructors
Constructor and Description

Animation()
Constructor

Constructors
Constructor and Description
`Animation()` Constructor

Method Summary

Methods
Modifier and Type	Method and Description
`void`	`addFrame(T frame, float duration)` Adds a frame to the animation
`void`	`draw(Graphics g, float x, float y)` Draws the current frame of the animation
`T`	`getCurrentFrame()` Returns the `T` of the current frame
`int`	`getCurrentFrameIndex()` Returns the index of the current frame
`int`	`getNumberOfFrames()` Returns the total number of frames in this animation
`boolean`	`isLooping()` Returns if the animation is looping
`void`	`removeFrame(int index)` Removes a frame from the animation
`void`	`restart()` Restarts the animation.
`void`	`setLooping(boolean looping)` Sets if the animation should loop
`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,
        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
  - 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

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

getCurrentFrame

getNumberOfFrames

getCurrentFrameIndex

isLooping

setLooping