Inherits AssetBase, and AssetBase.

Methods
bool	getAnimationCycle ()

bool	getAnimationCycle ()

int	getAnimationFrameCount ([bool validatedFrames])

int	getAnimationFrameCount ([bool validatedFrames])

string	getAnimationFrames ([bool validatedFrames])

string	getAnimationFrames ([bool validatedFrames])

float	getAnimationTime ()

float	getAnimationTime ()

string	getImage ()

string	getImage ()

void	setAnimationCycle (bool animationCycle)

void	setAnimationCycle (bool animationCycle)

void	setAnimationFrames (animationFrames)

void	setAnimationFrames (animationFrames)

void	setAnimationTime (float animationTime)

void	setAnimationTime (float animationTime)

void	setImage (assetId)

void	setImage (assetId)

Methods inherited from AssetBase
string	getAssetId ()

string	getAssetId ()

void	refreshAsset ()

void	refreshAsset ()

Methods inherited from SimObject
void	addFieldFilter (fieldName)

void	addFieldFilter (fieldName)

string	call (%args)

string	call (%args)

int	clone ([bool copyDynamicFields?=false])

int	clone ([bool copyDynamicFields?=false])

void	delete ()

void	delete ()

void	dump ()

void	dump ()

void	dumpClassHierarchy ()

void	dumpClassHierarchy ()

string	getClassName ()

string	getClassName ()

string	getClassNamespace ()

string	getClassNamespace ()

string	getDynamicField (index)

string	getDynamicField (index)

int	getDynamicFieldCount ()

int	getDynamicFieldCount ()

string	getField (int index)

string	getField (int index)

int	getFieldCount ()

int	getFieldCount ()

string	getFieldType (fieldName)

string	getFieldType (fieldName)

string	getFieldValue (fieldName)

string	getFieldValue (fieldName)

int	getGroup ()

int	getGroup ()

int	getId ()

int	getId ()

string	getInternalName ()

string	getInternalName ()

string	getName ()

string	getName ()

string	getProgenitorFile ()

string	getProgenitorFile ()

string	getSuperClassNamespace ()

string	getSuperClassNamespace ()

int	getType ()

int	getType ()

bool	isChildOfGroup ()

bool	isChildOfGroup ()

bool	isMemberOfClass (string classname)

bool	isMemberOfClass (string classname)

bool	isMethod (string method name)

bool	isMethod (string method name)

bool	isTimerActive ()

bool	isTimerActive ()

void	removeFieldFilter (fieldName)

void	removeFieldFilter (fieldName)

bool	save (fileName,[selectedOnly])

bool	save (fileName,[selectedOnly])

int	schedule (time, command,< arg1...argN >)

int	schedule (time, command,< arg1...argN >)

void	setClassNamespace ()

void	setClassNamespace ()

bool	setFieldValue (fieldName, value)

bool	setFieldValue (fieldName, value)

void	setInternalName ()

void	setInternalName ()

void	setName (newName)

void	setName (newName)

void	setProgenitorFile (file)

void	setProgenitorFile (file)

void	setSuperClassNamespace ()

void	setSuperClassNamespace ()

bool	startTimer (callbackFunction, float timePeriod,[repeat])

bool	startTimer (callbackFunction, float timePeriod,[repeat])

void	stopTimer ()

void	stopTimer ()

Fields
bool	AnimationCycle

intList	AnimationFrames

float	AnimationTime

bool	AssetAutoUnload

string	AssetCategory

string	AssetDescription

bool	AssetInternal

string	AssetName

bool	AssetPrivate

imageAssetPtr	Image

bool	RandomStart

SimBase
bool	canSaveDynamicFields

string	internalName

SimObjectPtr	parentGroup

Namespace Linking
string	superclass

string	class

Fields inherited from AssetBase
bool	AssetAutoUnload

string	AssetCategory

string	AssetDescription

bool	AssetInternal

string	AssetName

bool	AssetPrivate

bool	canSaveDynamicFields

string	internalName

SimObjectPtr	parentGroup

string	superclass

string	class

Fields inherited from SimObject
bool	canSaveDynamicFields

string	internalName

SimObjectPtr	parentGroup

string	superclass

string	class

Methods

bool AnimationAsset::getAnimationCycle ( )

Gets whether the animation cycles or not.

Returns: Whether the animation cycles or not.

bool AnimationAsset::getAnimationCycle ( )

Gets whether the animation cycles or not.

Returns: Whether the animation cycles or not.

int AnimationAsset::getAnimationFrameCount ( )

Gets the count of frame that compose the animation or optionally only the ones validated against the image asset.

Parameters

validatedFrames - Whether to return only the validated frames or not. Optional: Default is false.

Returns: The image frames that compose the animation or optionally only the ones validated against the image asset.

int AnimationAsset::getAnimationFrameCount ( )

Gets the count of frame that compose the animation or optionally only the ones validated against the image asset.

Parameters

validatedFrames - Whether to return only the validated frames or not. Optional: Default is false.

Returns: The image frames that compose the animation or optionally only the ones validated against the image asset.

string AnimationAsset::getAnimationFrames ( )

Gets the frames that compose the animation or optionally only the ones validated against the image asset.

Parameters

validatedFrames - Whether to return only the validated frames or not. Optional: Default is false.

Returns: The image frames that compose the animation or optionally only the ones validated against the image asset.

string AnimationAsset::getAnimationFrames ( )

Gets the frames that compose the animation or optionally only the ones validated against the image asset.

Parameters

validatedFrames - Whether to return only the validated frames or not. Optional: Default is false.

Returns: The image frames that compose the animation or optionally only the ones validated against the image asset.

float AnimationAsset::getAnimationTime ( )

Gets the total time to cycle through all animation frames.

Returns: The total time to cycle through all animation frames.

float AnimationAsset::getAnimationTime ( )

Gets the total time to cycle through all animation frames.

Returns: The total time to cycle through all animation frames.

string AnimationAsset::getImage ( )

Gets the image asset Id.

Returns: The image asset Id.

string AnimationAsset::getImage ( )

Gets the image asset Id.

Returns: The image asset Id.

void AnimationAsset::setAnimationCycle ( bool animationCycle )

Sets whether the animation cycles or not.

Parameters

animationCycle Whether the animation cycles or not.

Returns: No return value.

void AnimationAsset::setAnimationCycle ( bool animationCycle )

Sets whether the animation cycles or not.

Parameters

animationCycle Whether the animation cycles or not.

Returns: No return value.

void AnimationAsset::setAnimationFrames ( animationFrames )

Sets the image frames that compose the animation.

Parameters

animationFrames A set of image frames that compose the animation.

Returns: No return value.

void AnimationAsset::setAnimationFrames ( animationFrames )

Sets the image frames that compose the animation.

Parameters

animationFrames A set of image frames that compose the animation.

Returns: No return value.

void AnimationAsset::setAnimationTime ( float animationTime )

Sets the total time to cycle through all animation frames.

Parameters

animationTime The total time to cycle through all animation frames.

Returns: No return value.

void AnimationAsset::setAnimationTime ( float animationTime )

Sets the total time to cycle through all animation frames.

Parameters

animationTime The total time to cycle through all animation frames.

Returns: No return value.

void AnimationAsset::setImage ( assetId )

Sets the image asset Id.

Returns: No return value.

void AnimationAsset::setImage ( assetId )

Sets the image asset Id.

Returns: No return value.

Member Data Documentation

bool AnimationAsset::AnimationCycle

intList AnimationAsset::AnimationFrames

float AnimationAsset::AnimationTime

bool AnimationAsset::AssetAutoUnload

Whether the asset is automatically unloaded when an asset is released and has no other acquisitions or not.

string AnimationAsset::AssetCategory

An arbitrary category that can be used to categorized assets.

string AnimationAsset::AssetDescription

The simple description of the asset contents.

bool AnimationAsset::AssetInternal

Whether the asset is used internally only or not.

string AnimationAsset::AssetName

The name of the asset. The is not a unique identification like an asset Id.

bool AnimationAsset::AssetPrivate

Whether the asset is private or not.

bool AnimationAsset::canSaveDynamicFields

string AnimationAsset::class

Script SuperClass of object.

imageAssetPtr AnimationAsset::Image

string AnimationAsset::internalName

SimObjectPtr AnimationAsset::parentGroup

Group hierarchy parent of the object.

bool AnimationAsset::RandomStart

string AnimationAsset::superclass

Script Class of object.