AlCharTransition

Interface to Alias CharTransition Network.

Synopsis

#include <AlCharTransition.h>
class AlCharTransition :  public AlObject
enum AlCharTransitionIntegerInfo
{
	kLength,
	kActive,
	kStartTransitionType,
	kStartType,
	kStartFrame,
	kStartTo,
	kByFrame,
	kEndTransitionType,
	kEndType,
	kEndFrame,
	kTangentIn,
	kTangentOut,
	kPreCalcAnimation,
	kLastStored
};
enum AlCharTransitionStringInfo
{
	kBlindData1,
	kBlindData2,
	kBlindData3,
	kBlindData4
};
	AlCharTransition();
virtual 	~AlCharTransition();
virtual AlObject*	copyWrapper() const;
AlCharTransition*	copyObject();
virtual statusCode	deleteObject();
statusCode	create(AlCharacter *, const char *);
virtual AlObjectType	type() const;
virtual const char*	name() const;
virtual statusCode	setName(const char *);
int 	setTraversal(int);
statusCode	getSnippets(AlCharSnippet **, AlCharSnippet **);
statusCode	charTransitionIntegerInfo(AlCharTransitionIntegerInfo, int&) const;
statusCode	charTransitionStringInfo(AlCharTransitionStringInfo, const char *&) const;
statusCode	setCharTransitionIntegerInfo(AlCharTransitionIntegerInfo, int);
statusCode	setCharTransitionStringInfo(AlCharTransitionStringInfo, const char *);

Description

AlCharTransition is the interface to the CharTransition Network data of Alias’ CharTransition Network objects. To create a character transition, first instantiate and create an AlCharTransition.

AlCharTransition::AlCharTransition()

Description

Constructs an AlCharTransition wrapper object.

AlCharTransition::~AlCharTransition()

Description

Deletes an AlCharTransition wrapper object.

AlObject* AlCharTransition::copyWrapper() const

Description

Makes an exact copy of the AlCharTransition wrapper.

AlCharTransition *AlCharTransition::copyObject()

Description

Copies this AlCharTransition returning a pointer to the new copy.

statusCode AlCharTransition::create(AlCharacter *character,const char *arc_name)

Description

Does any initialization and allocation of data for an AlCharTransition. Allocates room for this AlCharTransition and adds this character to the universe.

Return Codes

sSuccess - operation was successful

sInsufficientMemory - not enough memory available

sFailure - could not complete request

statusCode AlCharTransition::deleteObject()

Description

Deletes an AlCharTransition wrapper object.

Return Codes

sInvalidObject - invalid wrapper

sSuccess - deletion was successful

AlObjectType AlCharTransition::type() const

Description

Returns the class identifier kCharTransitionType.

const char *AlCharTransition::name(void) const

Description

Returns the name of the CharTransition.

statusCode AlCharTransition::setName(const char *new_transition_name)

Description

Renames a transition.

int AlCharTransition::setTraversal(int traversalStatus)

Description

Sets the Transition traversal status and returns the previous status.

statusCode AlCharTransition::getSnippets(AlCharSnippet **sourceSnippet,AlCharSnippet **destinationSnippet)

Description

Returns the source and destination snippets for the transition.

Return Codes

sSuccess - operation was successful

sInvalidObject - invalid wrapper

sInsufficientMemory - not enough memory available

sFailure - could not complete request

statusCode AlCharTransition::charTransitionIntegerInfo(AlCharTransitionIntegerInfo dataType,int& iValue) const

Description

Returns the specified integer valued Character Transition data.

Arguments

< dataType - the type of Character Transition data to return

> iValue - the value of the Character Transition data

Return Codes

sSuccess - the Character Transition data was returned in iValue

sInvalidArgument - the Character Transition dataType is not integer valued

statusCode AlCharTransition::charTransitionStringInfo(AlCharTransitionStringInfo dataType,const char *& sValue) const

Description

Returns the specified string valued Character Transition data.

Arguments

< dataType - the type of Character Transition data to return

> sValue - the value of the Character Transition data

Return Codes

sSuccess - the Character Transition data was returned in sValue

sInvalidArgument - the Character Transition dataType is not string valued

statusCode AlCharTransition::setCharTransitionIntegerInfo(AlCharTransitionIntegerInfo dataType,int iValue)

Description

Sets the specified integer valued Character Transition data.

Arguments

< dataType - the type of Character Transition data to return

< iValue - the new value of the Character Transition data

Return Codes

sSuccess - the Character Transition data was updated from iValue

sInvalidArgument - the Character Transition dataType is not integer valued

statusCode AlCharTransition::setCharTransitionStringInfo(AlCharTransitionStringInfo dataType,const char* sValue)

Description

Sets the specified string valued Character Transition data.

Arguments

< dataType - the type of Character Transition data to return

< sValue - the new value of the Character Transition data

Return Codes

sSuccess - the Character Transition data was updated from sValue

sInvalidArgument - the Character Transition dataType is not string valued