Animatable

All Known Implementing Classes:

Animation, Sprite
```
public interface Animatable
```
An Animatable object is one that may be incorporated into an Animation as one of its frames. Every Animatable object is either a Sprite or an Animation. For simplicity's sake, both Sprites and Animations may be treated as consisting of one or more Animatable frames, indexed by the integers from 0 to getNumFrames() - 1 inclusive, each with its own duration in fracunits. Durations of 0 or less are interpreted as infinite. A Sprite has exactly one frame, namely itself, with a duration of 0.

See Also:

Animation

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method and Description
`boolean`	`framesAreCompatible(int index1, int index2)` Returns whether the two frames at the specified indices are compatible for AnimationInstances' transitioning purposes.
`Animatable`	`getFilteredCopy(Filter filter, boolean load)` Returns a new Animatable created by applying a Filter to all of the Sprites of which this Animatable is ultimately composed.
`Animatable`	`getFrame(int index)` Returns this Animatable's frame at the specified index.
`long`	`getFrameDuration(int index)` Returns the duration in fracunits of this Animatable's frame at the specified index.
`Drawable`	`getInstance()` Returns a Drawable instantiation of this Animatable.
`int`	`getLevel()` Returns how many levels of Animations this Animatable and its frames and sub-frames comprise.
`int`	`getNumFrames()` Returns how many frames this Animatable has.
`java.util.Set<Sprite>`	`getSprites()` Returns an unmodifiable Set view of all of the Sprites that ultimately compose this Animatable.

- Method Detail
  - getLevel
```
int getLevel()
```
    Returns how many levels of Animations this Animatable and its frames and sub-frames comprise. For example, an Animation of Animations of Animations has a level of 3.
    
    Returns:
    
    This Animatable's level
  - getNumFrames
```
int getNumFrames()
```
    Returns how many frames this Animatable has.
    
    Returns:
    
    This Animatable's number of frames
  - getFrame
```
Animatable getFrame(int index)
```
    Returns this Animatable's frame at the specified index.
    
    Parameters:
    
    index - The index of the frame to be returned
    
    Returns:
    
    This Animatable's frame at the specified index
    
    Throws:
    
    java.lang.IndexOutOfBoundsException - if the index is out of range
  - getFrameDuration
```
long getFrameDuration(int index)
```
    Returns the duration in fracunits of this Animatable's frame at the specified index.
    
    Parameters:
    
    index - The index of the frame whose duration is to be returned
    
    Returns:
    
    The duration of this Animatable's frame at the specified index
    
    Throws:
    
    java.lang.IndexOutOfBoundsException - if the index is out of range
  - framesAreCompatible
```
boolean framesAreCompatible(int index1,
                            int index2)
```
    Returns whether the two frames at the specified indices are compatible for AnimationInstances' transitioning purposes. An AnimationInstance of this Animatable, if it is an Animation, or of an Animation that incorporates this Animatable may transition between the frames at the specified indices without resetting all of its indices at its lower levels to 0 if and only if this method returns true.
    
    Parameters:
    
    index1 - The index of the first frame
    
    index2 - The index of the second frame
    
    Returns:
    
    Whether or not an AnimationInstance may transition between the two frames without resetting its lower indices to 0
    
    Throws:
    
    java.lang.IndexOutOfBoundsException - if either of the two indices are out of range
  - getSprites
```
java.util.Set<Sprite> getSprites()
```
    Returns an unmodifiable Set view of all of the Sprites that ultimately compose this Animatable. If this Animatable is a Sprite, the returned Set will only contain the Sprite itself. If this Animatable is an Animation, the returned Set will be equal to the union of the return values of getSprites() for each of the Animation's frames.
    
    Returns:
    
    The Sprites that ultimately compose this Animatable
  - getFilteredCopy
```
Animatable getFilteredCopy(Filter filter,
                           boolean load)
```
    Returns a new Animatable created by applying a Filter to all of the Sprites of which this Animatable is ultimately composed. The returned Animatable will have the same hierarchical Animation structure as this Animatable. In particular, if this Animatable is a Sprite, the returned Animatable will also be a Sprite. To avoid redundant Sprite creation, Sprites keep track of the filtered copies of themselves that have been created, so applying this method to the same Sprite twice will cause the same filtered Sprite to be returned twice.
    
    Parameters:
    
    filter - The Filter to apply to this Animatable's Sprites to create the new Animatable
    
    load - Whether the new Animatable should load its Sprites upon its creation
    
    Returns:
    
    A filtered copy of this Animatable
  - getInstance
```
Drawable getInstance()
```
    Returns a Drawable instantiation of this Animatable.
    
    Returns:
    
    A Drawable instantiation of this Animatable

Interface Animatable

Method Summary

Method Detail

getLevel

getNumFrames

getFrame

getFrameDuration

framesAreCompatible

getSprites

getFilteredCopy

getInstance