Interface to the Alias CharSnippet Network.
#include <AlCharSnippet.h>
class AlCharSnippet : public AlObject
enum AlCharSnippetIntegerInfo
{
kXPosition,
kYPosition,
kStart,
kEnd,
kPreviewMeasure,
kRunLoops,
kRunExit,
kRunFrames,
kLastStored,
kNodeNumber
};
enum AlCharSnippetStringInfo
{
kStageName,
kSetName,
kBlindData1,
kBlindData2,
kBlindData3,
kBlindData4
};
AlCharSnippet();
virtual ~AlCharSnippet();
virtual AlObject* copyWrapper() const;
AlCharSnippet* copyObject();
virtual statusCode deleteObject();
statusCode create(AlCharacter *, const char *);
virtual AlObjectType type() const;
virtual const char* name() const;
virtual statusCode setName(const char*);
AlCharTransition* firstTransition(void);
AlCharTransition* nextTransition(void);
int setTraversal(int);
statusCode charSnippetIntegerInfo(AlCharSnippetIntegerInfo, int&) const;
statusCode charSnippetStringInfo(AlCharSnippetStringInfo, const char *&) const;
statusCode setCharSnippetIntegerInfo(AlCharSnippetIntegerInfo, int);
statusCode setCharSnippetStringInfo(AlCharSnippetStringInfo, const char*);
AlCharSnippet is the interface to the CharSnippet Network data of Alias’ Character Network objects.
A Snippet is a sequence or short linear pieces of animation. Snippets are connected by Transitions to form a Character Network.
See the AlCharacter class for more information Character Networks. See the AlCharTransition class for more information on transitions.
Default constructor for AlCharSnippet Wrapper object. Use the create() method to initialize an AlCharSnippet object.
Deletes an AlCharSnippet wrapper object.
Makes an exact copy of the AlCharSnippet wrapper
NULL - unable to create new wrapper due to lack of memory
non NULL - new Character Network Snippet wrapper
Copies this AlCharSnippet returning a pointer to the new copy.
NULL - unable to create new object or wrapper due to lack of memory
non NULL - new Character Network Snippet wrapper
Does any initialization and allocation of data for an AlCharSnippet. Allocates room for this AlCharSnippet and adds this Snippet to the character.
< character - Character Network to create the Snippet in
< snippetName - name of the Character Network Snippet object
sSuccess - named Character Network Snippet object created
sInsufficientMemory - not enough memory available
Deletes an AlCharSnippet object. This method deletes the Character Network Snippet object data. Upon return there will be no Character Network Snippet corresponding to this wrapper or any other wrapper that references the same Character Network Snippet.
sSuccess - the Character Network Snippet has been deleted
sInvalidObject - the Character Network Snippet wrapper was not valid
Returns the class identifier kCharSnippetType.
AlCharSnippet* AlCharSnippet::asCharSnippetPtr()
This virtual function returns a non-null pointer to itself, indicating that it is safe to cast to an object of this class.
Returns the name of the CharSnippet.
NULL - invalid wrapper
non NULL - Character Network Snippet name
Renames a Character Network Snippet 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 Snippet 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
Returns a new wrapper to first transition of the Character Network Snippet.
NULL - wrapper not valid, no transitions or unable to construct the wrapper
non NULL - first Snippet transition wrapper
Returns a new wrapper to next transition in the Character Network Snippet.
NULL - wrapper not valid, no more transitions or unable to construct the wrapper
non NULL - next Snippet transition wrapper
Sets the Snippet traversal status and returns the previous status.
< traversalStatus - the new Snippet object traversal status
the previous traversal status
Returns the specified integer valued Character Transition data.
< dataType - the type of Character Transition data to return
> iValue - the value of the Character Transition data
sSuccess - the Character Transition data was returned in iValue
sInvalidArgument - the Character Transition dataType is not integer valued
Returns the specified string valued Character Transition data.
< dataType - the type of Character Transition data to return
> sValue - the value of the Character Transition data
sSuccess - the Character Transition data was returned in sValue
sInvalidArgument - the Character Transition dataType is not string valued
Sets the specified integer valued Character Transition data.
< dataType - the type of Character Transition data to return
< iValue - the new value of the Character Transition data
sSuccess - the Character Transition data was updated from iValue
sInvalidArgument - the Character Transition dataType is not integer valued
Sets the specified string valued Character Transition data.
< dataType - the type of Character Transition data to return
< sValue - the new value of the Character Transition data
sSuccess - the Character Transition data was updated from sValue
sInvalidArgument - the Character Transition dataType is not string valued