com.threerings.cast

Interface ComponentRepository

All Known Implementing Classes:

BundledComponentRepository

public interface ComponentRepository

Makes available a collection of character components and associated metadata. Character components are animated sequences that can be composited together to create a complete character visualization (imagine interchanging pairs of boots, torsos, hats, etc.).

Method Summary

Modifier and Type	Method and Description
Iterator<ActionSequence>	enumerateActionSequences() Iterates over the ActionSequence instances representing every available action sequence.
Iterator<ComponentClass>	enumerateComponentClasses() Iterates over the ComponentClass instances representing all available character component classes.
Iterator<Integer>	enumerateComponentIds(ComponentClass compClass) Iterates over the component ids of all components in the specified class.
CharacterComponent	getComponent(int componentId) Returns the CharacterComponent object for the given component identifier.
CharacterComponent	getComponent(String className, String compName) Returns the CharacterComponent object with the given component class and name.
ComponentClass	getComponentClass(String className) Returns the ComponentClass with the specified name or null if none exists with that name.

Method Detail

getComponent

CharacterComponent getComponent(int componentId)
                         throws NoSuchComponentException

Returns the CharacterComponent object for the given component identifier.

Throws:

NoSuchComponentException

getComponent

CharacterComponent getComponent(String className,
                                String compName)
                         throws NoSuchComponentException

Returns the CharacterComponent object with the given component class and name.

Throws:

NoSuchComponentException

getComponentClass

ComponentClass getComponentClass(String className)

Returns the ComponentClass with the specified name or null if none exists with that name.

enumerateComponentClasses

Iterator<ComponentClass> enumerateComponentClasses()

Iterates over the ComponentClass instances representing all available character component classes.

enumerateActionSequences

Iterator<ActionSequence> enumerateActionSequences()

Iterates over the ActionSequence instances representing every available action sequence.

enumerateComponentIds

Iterator<Integer> enumerateComponentIds(ComponentClass compClass)

Iterates over the component ids of all components in the specified class.