com.threerings.cast

Interface FrameProvider

public interface FrameProvider

Provides a mechanism where by a character component can obtain access to its image frames for a particular action in an on demand manner.

Method Summary

Modifier and Type	Method and Description
String	getFramePath(CharacterComponent component, String action, String type, Set<String> existentPaths) Returns the file path of the animation frames (in the eight sprite directions) for the specified action of the specified component.
ActionFrames	getFrames(CharacterComponent component, String action, String type) Returns the animation frames (in the eight sprite directions) for the specified action of the specified component.

Method Detail

getFrames

ActionFrames getFrames(CharacterComponent component,
                       String action,
                       String type)

Returns the animation frames (in the eight sprite directions) for the specified action of the specified component. May return null if the specified action does not exist for the specified component.

getFramePath

String getFramePath(CharacterComponent component,
                    String action,
                    String type,
                    Set<String> existentPaths)

Returns the file path of the animation frames (in the eight sprite directions) for the specified action of the specified component. May return a path to the default action or null if the specified action does not exist for the specified component.

Parameters:

existentPaths - the set of all paths for which there are valid frames.