com.threerings.cast

Class CharacterManager

java.lang.Object

com.threerings.cast.CharacterManager

All Implemented Interfaces:

DirectionCodes

public class CharacterManager
extends Object
implements DirectionCodes

The character manager provides facilities for constructing sprites that are used to represent characters in a scene. It also handles the compositing and caching of composited character animations.

Field Summary

Fields inherited from interface com.threerings.util.DirectionCodes

CARDINAL_DIRECTIONS, CCW, CW, DIRECTION_COUNT, DOWN, EAST, EASTNORTHEAST, EASTSOUTHEAST, FINE_DIRECTION_COUNT, HORIZONTAL, LEFT, NONE, NORTH, NORTHEAST, NORTHNORTHEAST, NORTHNORTHWEST, NORTHWEST, RIGHT, SOUTH, SOUTHEAST, SOUTHSOUTHEAST, SOUTHSOUTHWEST, SOUTHWEST, UP, VERTICAL, WEST, WESTNORTHWEST, WESTSOUTHWEST

Constructor Summary

Constructors

Constructor and Description
CharacterManager(ImageManager imgr, ComponentRepository crepo) Constructs the character manager.

Method Summary

Modifier and Type	Method and Description
ActionFrames	getActionFrames(CharacterDescriptor descrip, String action) Obtains the composited animation frames for the specified action for a character with the specified descriptor.
ActionSequence	getActionSequence(String action) Returns the action sequence instance with the specified name or null if no such sequence exists.
CharacterSprite	getCharacter(CharacterDescriptor desc) Returns a CharacterSprite representing the character described by the given CharacterDescriptor, or null if an error occurs.
<T extends CharacterSprite> T	getCharacter(CharacterDescriptor desc, Class<T> charClass) Returns a CharacterSprite representing the character described by the given CharacterDescriptor, or null if an error occurs.
ComponentRepository	getComponentRepository() Returns the component repository being used by this manager.
void	resolveActionSequence(CharacterDescriptor desc, String action) Informs the character manager that the action sequence for the given character descriptor is likely to be needed in the near future and so any efforts that can be made to load it into the action sequence cache in advance should be undertaken.
void	setActionCache(ActionCache cache) Instructs the character manager to use the provided cache for composited action animations.
static void	setCacheSize(int cacheKilobytes) Sets the size of the cache used for composited animation frames.
void	setCharacterClass(Class<? extends CharacterSprite> charClass) Instructs the character manager to construct instances of this derived class of CharacterSprite when creating new sprites.

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

CharacterManager

public CharacterManager(ImageManager imgr,
                        ComponentRepository crepo)

Constructs the character manager.

Method Detail

setCacheSize

public static void setCacheSize(int cacheKilobytes)

Sets the size of the cache used for composited animation frames. This must be called before the CharacterManager is created.

getComponentRepository

public ComponentRepository getComponentRepository()

Returns the component repository being used by this manager.

setCharacterClass

public void setCharacterClass(Class<? extends CharacterSprite> charClass)

Instructs the character manager to construct instances of this derived class of CharacterSprite when creating new sprites.

Throws:

IllegalArgumentException - thrown if the supplied class does not derive from CharacterSprite.

setActionCache

public void setActionCache(ActionCache cache)

Instructs the character manager to use the provided cache for composited action animations.

getCharacter

public CharacterSprite getCharacter(CharacterDescriptor desc)

Returns a CharacterSprite representing the character described by the given CharacterDescriptor, or null if an error occurs.

Parameters:

desc - the character descriptor.

getCharacter

public <T extends CharacterSprite> T getCharacter(CharacterDescriptor desc,
                                                  Class<T> charClass)

Returns a CharacterSprite representing the character described by the given CharacterDescriptor, or null if an error occurs.

Parameters:

desc - the character descriptor.

charClass - the CharacterSprite derived class that should be instantiated instead of the configured default (which is set via setCharacterClass(java.lang.Class<? extends com.threerings.cast.CharacterSprite>)).

getActionFrames

public ActionFrames getActionFrames(CharacterDescriptor descrip,
                                    String action)
                             throws NoSuchComponentException

Obtains the composited animation frames for the specified action for a character with the specified descriptor. The resulting composited animation will be cached.

Throws:

NoSuchComponentException - thrown if any of the components in the supplied descriptor do not exist.

IllegalArgumentException - thrown if any of the components referenced in the descriptor do not support the specified action.

resolveActionSequence

public void resolveActionSequence(CharacterDescriptor desc,
                                  String action)

Informs the character manager that the action sequence for the given character descriptor is likely to be needed in the near future and so any efforts that can be made to load it into the action sequence cache in advance should be undertaken.

This will eventually be revamped to spiffily load action sequences in the background.

getActionSequence

public ActionSequence getActionSequence(String action)

Returns the action sequence instance with the specified name or null if no such sequence exists.