Interface to Alias Character Network.
#include <AlCharacter.h>
class AlCharacter : public AlObject
enum AlCharacterStringInfo
{
kBlindData1,
kBlindData2,
kBlindData3,
kBlindData4
};
AlCharacter();
virtual ~AlCharacter();
virtual AlObject* copyWrapper() const;
statusCode create(const char *);
virtual statusCode deleteObject();
virtual AlObjectType type() const;
virtual const char* name() const;
virtual statusCode setName(const char *);
AlCharSnippet* createSnippet(const char *);
AlCharTransition* createTransition(const char *);
statusCode removeSnippet(AlCharSnippet *);
statusCode removeTransition(AlCharTransition *);
AlCharSnippet* findSnippetByName(const char *);
AlCharTransition* findTransitionByName(const char *);
AlCharSnippet* firstSnippet(void);
AlCharSnippet* nextSnippet(void);
AlCharTransition* firstTransition(void);
AlCharTransition* nextTransition(void);
statusCode connectSnippets(AlCharSnippet *, AlCharTransition *, AlCharSnippet *);
statusCode convertTransitionToSnippet(AlCharTransition *, int, AlCharSnippet **, AlCharTransition **, AlCharTransition **);
statusCode characterStringInfo(AlCharacterStringInfo, const char *&) const;
statusCode setCharacterStringInfo(AlCharacterStringInfo, const char*);
AlCharacter is the interface to the Character Network data of Alias’ Character Network objects.
A Character Network is a topology whose nodes are sequences (short linear pieces of animation) referred to as snippets and whose arcs are transitions between nodes.
See the AlCharSnippet class for more information snippets. See the AlCharTransition class for more information transitions.
Default constructor for AlCharacter Wrapper object. Use the create() method to initialize an AlCharacter object.
Deletes an AlCharacter wrapper object.
Makes an exact copy of the AlCharacter wrapper
NULL - unable to create new wrapper due to lack of memory
non NULL - new Character Network wrapper
Deletes the Alias Character Network object. This method deletes the Character Network object data. Upon return there will be no Character Network corresponding to this wrapper or any other wrapper that references the same Character Network.
sSuccess - the Character Networks has been deleted
sInvalidObject - the Character Network was not valid
Returns the class identifier kCharacterType.
Does any initialization and allocation of data for an AlCharacter. Allocates room for this AlCharacter and adds this character to the universe.
< characterName - name of the Character Network object
sSuccess - named Character Network object created
sFailure - this wrapper already has a Character Network object, i.e already created
sInsufficientMemory - not enough memory available
Returns the name of the Character Network.
NULL - invalid wrapper
non NULL - Character Network name
Renames a Character Network object. If the new name is already in use then a unique name will be generated. Use the name() method to determine the actual name of the Character Network object.
< newCharacterName - the new name of the Character Network object
sSuccess - the Character Network object has been renamed
sInvalidObject - the Character Network was not valid
Creates the named Snippet for the Character. If the new name is already in use then a unique name will be generated. Use the AlSnippet::name() method to determine the actual name of the Character Network Snippet object. See the AlCharSnippet class for more information on Character Network Snippets.
< snippetName - the name of the new Character Network Snippet
NULL - invalid wrapper
non NULL - new Character Network Snippet wrapper
Creates the named Transition for the Character. If the new name is already in use then a unique name will be generated. Use the AlTransition::name() method to determine the actual name of the Character Network Transition object. See the AlCharTransition class for more information on Character Network Transitions.
< transitionName - the name of the new Character Network Transition
NULL - invalid wrapper
non NULL - new Character Network Transition wrapper
Deletes the Character Network Snippet from the Character Network. See the AlCharSnippet class for more information on Character Networks Snippets.
< snippet - the AlCharSnippet wrapper of the Character Network Snippet
sSuccess - the Character Network Snippet has been deleted
sInvalidObject - the Character Network Snippet was not valid
Deletes the Character Network Transition from the Character Network. See the AlCharTransition class for more information on Character Networks Transitions.
< snippet - the AlCharTransition wrapper of the Character Network Transition
sSuccess - the Character Network Transition has been deleted
sInvalidObject - the Character Network Transition was not valid
Finds the named Character Network Snippet in the Character Network and returns a new wrapper for it.
< characterName - name of the object
NULL - wrapper not valid, unable locate the named Character Network Snippet or unable to construct the wrapper
non NULL - named Character Network Snippet wrapper
Finds the named Character Network Transition in the Character Network and returns a new wrapper for it.
< characterName - name of the object
NULL - wrapper not valid, unable locate the named Character Network Transition or unable to construct the wrapper
non NULL - named Character Network Transition wrapper
Returns a new wrapper to first Character Network Snippet in the Character Network.
NULL - wrapper not valid, no Character Network Snippets or unable to construct the wrapper
non NULL - first Character Network Snippet wrapper
Returns a new wrapper to next Character Network Snippet in the Character Network.
NULL - wrapper not valid, no more Character Network Snippets or unable to construct the wrapper
non NULL - next Character Network Snippet wrapper
Returns a new wrapper to first Character Network Transition in the Character Network.
NULL - wrapper not valid, no Character Network Transitions or unable to construct the wrapper
non NULL - first Character Network Transition wrapper
Returns a new wrapper to next Character Network Transition in the Character Network.
NULL - wrapper not valid, no more Character Network Transitions or unable to construct the wrapper
non NULL - next Character Network Transition wrapper
Connects the sourceSnippet to the destinationSnippet via the transition. The snippets and the transition must have been previously created via createSnippet() and createTransition().
< sourceSnippet - source Snippet for transition
< transition - connect source to destination
< destinationSnippet - destination Snippet for transition
sSuccess - everything okay
sInsufficientMemory - not enough memory available
sFailure - could not complete request
Converts a transition from snippet A to snippet B into a transition X’ from A to new snippet C, and a transition X" from C to B. Note that snippets A and B are implied by the transition. newSnippet, newSourceTransition and newDestinationTransition are declared by the caller and passed to the method as follows:
AlCharSnippet *newSnippet; AlCharTransition *newSourceTransition; AlCharTransition *newDestinationTransition; status = character->convertTransitionToSnippet( transition, TRUE, &newSnippet, &newSourceTransition, &newDestinationTransition );
The create() method for the new Snippet and Transitions are invoked by the method so valid wrappers for each object are passed back to the caller.
< transition - the transition that connects snippet A to B
< transitionIsDeleted - TRUE (1) if transition is to be deleted
> newSnippet - new snippet C
> newSourceTransition - new transition X’
> newDestinationTransition - new transition X"
sSuccess - everything okay
sInsufficientMemory - not enough memory available
sFailure - could not complete request
Returns the specified string valued Character data.
< dataType - the type of Character data to return
> sValue - the value of the Character data
sSuccess - the Character data was returned in sValue
sInvalidArgument - the Character dataType is not string valued
Sets the specified string valued Character data.
< dataType - the type of Character data to return
< sValue - the new value of the Character data
sSuccess - the Character data was updated from sValue
sInvalidArgument - the Character dataType is not string valued