class AnimationTable

Table containing all animations in the scene. Currently animation and related types are API-only and not used by processors or external format's like *FBX, USD, GLTF, BGEO and etc)

Properties

Property	Description
Name	The name of the AnimationTable object. (Inherited from Object)

Methods

Method	Description
AddAnimation	Adds an animation to the table. The returned value is the id of the animation within the table.
AddItem	Adds an item to the table. The returned value is the id of the item within the table, which can be used to retrieve the item using GetItem(). (Inherited from Table)
AddObserver	Adds a user-defined observer object to the interface, that will receive events from the interface. (Inherited from Object)
Clear	Clears the table, and removes all items. If AddItem is called after Clear, the item ids will start over from 0. (Inherited from Table)
Copy	Clears the current table and copies the items from a source table. (Inherited from Table)
FindAnimation	Finds an animation object in the table using name. Returns the first occurrence if found, null otherwise.
FindAnimationId	Finds an animation object's id in the table using name. Returns the first occurrence if found, -1 otherwise.
FindItem	Finds a named item in the table. If multiple items have the same name, the first will be returned. If no item was found, null will be returned. (Inherited from Table)
FindItemId	Finds the id of an item in the table, using the name. If multiple items have the same name, the first will be returned. If no item was found, the return will be -1. (Inherited from Table)
GetAnimation	Returns the i:th animation, using the id of the animation.
GetAnimationsCount	Returns the number of animations in the animation table.
GetClass	Get the name of the AnimationTable class. (Inherited from Object)
GetItem	Returns the i:th item, using the id of the item. (Inherited from Table)
GetItemsCount	The number of item id:s in the table. If an item has been removed, using RemoveItem, the id is still counted in this method. GetIdsCount also equals the id that will be applied to the next item added to the table. (Inherited from Table)
IsA	Returns true if AnimationTable is a or is a descendant of the class named as the type parameter. (Inherited from Object)
IsNull	Returns true if the AnimationTable object is invalid. (Inherited from Object)
IsSameObjectAs	Returns true if the AnimationTable object is valid. (Inherited from Object)
NonNull	Returns true if the AnimationTable object is valid. (Inherited from Object)
PrintInfo	Prints the content/info of the AnimationTable object to the log. (Inherited from Object)
RemoveAnimation	Removes an animation. If GetAnimation is called with the animation id, the value returned will be null.
RemoveItem	Removes an item, and invalidates the id. The id will not point at a valid item, until Clear is called and new items are added up until the id. (Inherited from Table)
RemoveObserver	Removes a previously added observer object. (Inherited from Object)
SetAnimation	Set the animation object at the given index.
SetItem	Sets an item in the table. The id must exist in the table. (Inherited from Table)

Static methods

Method	Description
IsClassA	Returns true if the class is a or is a descendant of the class named as the type parameter. (Inherited from Object)
SafeCast	SafeCast makes sure the input object is of a class that can be cast into spAnimationTable, and if this is the case, returns the object cast into spAnimationTable. (Inherited from Object)

Properties details

Name

The name of the AnimationTable object. (Inherited from Object)

Syntax

// Setter
void SetName( const char * name ) const;

// Getter
spString GetName() const;

SetName parameters

Type	Name	Min	Max	Description
const char *	name			New name of the object.

GetName return value

Type: spString

Syntax

// Setter
void SetName(string name);

// Getter
string GetName();

SetName parameters

Type	Name	Min	Max	Description
string	name			New name of the object.

GetName return value

Type: string

Syntax

# Setter
None SetName(name: str)

# Getter
str GetName()

SetName parameters

Name	Type	Min	Max	Description
name	str			New name of the object.

GetName return value

Type: str

Methods details

AddAnimation

Adds an animation to the table. The returned value is the id of the animation within the table.

Syntax

rid AddAnimation( const spAnimation & animation ) const;

Parameters

Type	Name	Min	Max	Description
Animation	animation			The animation to add into the table.

Return value

Type: rid

Syntax

int AddAnimation(spAnimation animation);

Parameters

Type	Name	Min	Max	Description
Animation	animation			The animation to add into the table.

Return value

Type: int

Syntax

int AddAnimation(animation: spAnimation)

Parameters

Name	Type	Min	Max	Description
animation	Animation			The animation to add into the table.

Return value

Type: int

AddItem

Adds an item to the table. The returned value is the id of the item within the table, which can be used to retrieve the item using GetItem().

Syntax

rid AddItem( const spObject & item ) const;

Parameters

Type	Name	Min	Max	Description
Object	item			Is the item that is to be added to the table.

Return value

Type: rid

Syntax

int AddItem(spObject item);

Parameters

Type	Name	Min	Max	Description
Object	item			Is the item that is to be added to the table.

Return value

Type: int

Syntax

int AddItem(item: spObject)

Parameters

Name	Type	Min	Max	Description
item	Object			Is the item that is to be added to the table.

Return value

Type: int

AddObserver

Adds a user-defined observer object to the interface, that will receive events from the interface. (Inherited from Object)

Syntax

rid AddObserver( const spObserver & observer ) const;

Parameters

Type	Name	Min	Max	Description
Observer	observer			Observer is the object that will receive events.

Return value

Type: rid

Syntax

int AddObserver(spObserver observer);

Parameters

Type	Name	Min	Max	Description
Observer	observer			Observer is the object that will receive events.

Return value

Type: int

Syntax

int AddObserver(observer: spObserver)

Parameters

Name	Type	Min	Max	Description
observer	Observer			Observer is the object that will receive events.

Return value

Type: int

Clear

Clears the table, and removes all items. If AddItem is called after Clear, the item ids will start over from 0.

Syntax

void Clear() const;

Parameters

Clear takes no parameters.

Syntax

void Clear();

Parameters

Clear takes no parameters.

Syntax

None Clear()

Parameters

Clear takes no parameters.

Copy

Clears the current table and copies the items from a source table.

Syntax

void Copy( const spTable & src ) const;

Parameters

Type	Name	Min	Max	Description
Table	src			The table to copy.

Syntax

void Copy(spTable src);

Parameters

Type	Name	Min	Max	Description
Table	src			The table to copy.

Syntax

None Copy(src: spTable)

Parameters

Name	Type	Min	Max	Description
src	Table			The table to copy.

FindAnimation

Finds an animation object in the table using name. Returns the first occurrence if found, null otherwise.

Syntax

spAnimation FindAnimation( const char * name ) const;

Parameters

Type	Name	Min	Max	Description
const char *	name			The name of the animation to look for.

Return value

Type: Animation

Syntax

spAnimation FindAnimation(string name);

Parameters

Type	Name	Min	Max	Description
string	name			The name of the animation to look for.

Return value

Type: Animation

Syntax

spAnimation FindAnimation(name: str)

Parameters

Name	Type	Min	Max	Description
name	str			The name of the animation to look for.

Return value

Type: Animation

FindAnimationId

Finds an animation object's id in the table using name. Returns the first occurrence if found, -1 otherwise.

Syntax

rid FindAnimationId( const char * name ) const;

Parameters

Type	Name	Min	Max	Description
const char *	name			The name of the animation to look for.

Return value

Type: rid

Syntax

int FindAnimationId(string name);

Parameters

Type	Name	Min	Max	Description
string	name			The name of the animation to look for.

Return value

Type: int

Syntax

int FindAnimationId(name: str)

Parameters

Name	Type	Min	Max	Description
name	str			The name of the animation to look for.

Return value

Type: int

FindItem

Finds a named item in the table. If multiple items have the same name, the first will be returned. If no item was found, null will be returned.

Syntax

spObject FindItem( const char * name ) const;

Parameters

Type	Name	Min	Max	Description
const char *	name			Is the string that is to be searched for.

Return value

Type: Object

Syntax

spObject FindItem(string name);

Parameters

Type	Name	Min	Max	Description
string	name			Is the string that is to be searched for.

Return value

Type: Object

Syntax

spObject FindItem(name: str)

Parameters

Name	Type	Min	Max	Description
name	str			Is the string that is to be searched for.

Return value

Type: Object

FindItemId

Finds the id of an item in the table, using the name. If multiple items have the same name, the first will be returned. If no item was found, the return will be -1.

Syntax

rid FindItemId( const char * name ) const;

Parameters

Type	Name	Min	Max	Description
const char *	name			Is the string that is to be searched for.

Return value

Type: rid

Syntax

int FindItemId(string name);

Parameters

Type	Name	Min	Max	Description
string	name			Is the string that is to be searched for.

Return value

Type: int

Syntax

int FindItemId(name: str)

Parameters

Name	Type	Min	Max	Description
name	str			Is the string that is to be searched for.

Return value

Type: int

GetAnimation

Returns the i:th animation, using the id of the animation.

Syntax

spAnimation GetAnimation( rid index ) const;

Parameters

Type	Name	Min	Max	Description
rid	index			The id of the animation in the table.

Return value

Type: Animation

Syntax

spAnimation GetAnimation(int index);

Parameters

Type	Name	Min	Max	Description
int	index			The id of the animation in the table.

Return value

Type: Animation

Syntax

spAnimation GetAnimation(index: int)

Parameters

Name	Type	Min	Max	Description
index	int			The id of the animation in the table.

Return value

Type: Animation

GetAnimationsCount

Returns the number of animations in the animation table.

Syntax

unsigned int GetAnimationsCount() const;

Parameters

GetAnimationsCount takes no parameters.

Return value

Type: unsigned int

Syntax

uint GetAnimationsCount();

Parameters

GetAnimationsCount takes no parameters.

Return value

Type: uint

Syntax

int GetAnimationsCount()

Parameters

GetAnimationsCount takes no parameters.

Return value

Type: int

GetClass

Get the name of the AnimationTable class. (Inherited from Object)

Syntax

spString GetClass() const;

Parameters

GetClass takes no parameters.

Return value

Type: spString

Syntax

string GetClass();

Parameters

GetClass takes no parameters.

Return value

Type: string

Syntax

str GetClass()

Parameters

GetClass takes no parameters.

Return value

Type: str

GetItem

Returns the i:th item, using the id of the item.

Syntax

spObject GetItem( rid id ) const;

Parameters

Type	Name	Min	Max	Description
rid	id			Is the id of the requested object.

Return value

Type: Object

Syntax

spObject GetItem(int id);

Parameters

Type	Name	Min	Max	Description
int	id			Is the id of the requested object.

Return value

Type: Object

Syntax

spObject GetItem(id: int)

Parameters

Name	Type	Min	Max	Description
id	int			Is the id of the requested object.

Return value

Type: Object

GetItemsCount

The number of item id:s in the table. If an item has been removed, using RemoveItem, the id is still counted in this method. GetIdsCount also equals the id that will be applied to the next item added to the table.

Syntax

unsigned int GetItemsCount() const;

Parameters

GetItemsCount takes no parameters.

Return value

Type: unsigned int

Syntax

uint GetItemsCount();

Parameters

GetItemsCount takes no parameters.

Return value

Type: uint

Syntax

int GetItemsCount()

Parameters

GetItemsCount takes no parameters.

Return value

Type: int

IsA

Returns true if AnimationTable is a or is a descendant of the class named as the type parameter. (Inherited from Object)

Syntax

bool IsA( const char * type ) const;

Parameters

Type	Name	Min	Max	Description
const char *	type			Name of the class to check if AnimationTable is, or is a descendant of.

Return value

Type: bool

Syntax

bool IsA(string type);

Parameters

Type	Name	Min	Max	Description
string	type			Name of the class to check if AnimationTable is, or is a descendant of.

Return value

Type: bool

Syntax

bool IsA(type: str)

Parameters

Name	Type	Min	Max	Description
type	str			Name of the class to check if AnimationTable is, or is a descendant of.

Return value

Type: bool

IsNull

Returns true if the AnimationTable object is invalid. (Inherited from Object)

Syntax

bool IsNull() const;

Parameters

IsNull takes no parameters.

Return value

Type: bool

Syntax

bool IsNull();

Parameters

IsNull takes no parameters.

Return value

Type: bool

Syntax

bool IsNull()

Parameters

IsNull takes no parameters.

Return value

Type: bool

IsSameObjectAs

Returns true if the AnimationTable object is valid. (Inherited from Object)

Syntax

bool IsSameObjectAs( const spObject & object ) const;

Parameters

Type	Name	Min	Max	Description
Object	object			Object to compare with.

Return value

Type: bool

Syntax

bool IsSameObjectAs(spObject object);

Parameters

Type	Name	Min	Max	Description
Object	object			Object to compare with.

Return value

Type: bool

Syntax

bool IsSameObjectAs(object: spObject)

Parameters

Name	Type	Min	Max	Description
object	Object			Object to compare with.

Return value

Type: bool

NonNull

Returns true if the AnimationTable object is valid. (Inherited from Object)

Syntax

bool NonNull() const;

Parameters

NonNull takes no parameters.

Return value

Type: bool

Syntax

bool NonNull();

Parameters

NonNull takes no parameters.

Return value

Type: bool

Syntax

bool NonNull()

Parameters

NonNull takes no parameters.

Return value

Type: bool

PrintInfo

Prints the content/info of the AnimationTable object to the log. (Inherited from Object)

Syntax

void PrintInfo() const;

Parameters

PrintInfo takes no parameters.

Syntax

void PrintInfo();

Parameters

PrintInfo takes no parameters.

Syntax

None PrintInfo()

Parameters

PrintInfo takes no parameters.

RemoveAnimation

Removes an animation. If GetAnimation is called with the animation id, the value returned will be null.

Syntax

void RemoveAnimation( unsigned int index ) const;

Parameters

Type	Name	Min	Max	Description
unsigned int	index			The id of the animation in the table.

Syntax

void RemoveAnimation(uint index);

Parameters

Type	Name	Min	Max	Description
uint	index			The id of the animation in the table.

Syntax

None RemoveAnimation(index: int)

Parameters

Name	Type	Min	Max	Description
index	int			The id of the animation in the table.

RemoveItem

Removes an item, and invalidates the id. The id will not point at a valid item, until Clear is called and new items are added up until the id.

Syntax

void RemoveItem( rid id ) const;

Parameters

Type	Name	Min	Max	Description
rid	id			The id of the object that should be removed.

Syntax

void RemoveItem(int id);

Parameters

Type	Name	Min	Max	Description
int	id			The id of the object that should be removed.

Syntax

None RemoveItem(id: int)

Parameters

Name	Type	Min	Max	Description
id	int			The id of the object that should be removed.

RemoveObserver

Removes a previously added observer object. (Inherited from Object)

Syntax

void RemoveObserver( rid observerId ) const;

Parameters

Type	Name	Min	Max	Description
rid	observerId			ObserverId is the id returned by AddObserver when the observer was added.

Syntax

void RemoveObserver(int observerId);

Parameters

Type	Name	Min	Max	Description
int	observerId			ObserverId is the id returned by AddObserver when the observer was added.

Syntax

None RemoveObserver(observerId: int)

Parameters

Name	Type	Min	Max	Description
observerId	int			ObserverId is the id returned by AddObserver when the observer was added.

SetAnimation

Set the animation object at the given index.

Syntax

void SetAnimation( rid index , const spAnimation & animation ) const;

Parameters

Type	Name	Min	Max	Description
rid	index			The id of the animation in the table.
Animation	animation			The animation to set into the table.

Syntax

void SetAnimation(int index, spAnimation animation);

Parameters

Type	Name	Min	Max	Description
int	index			The id of the animation in the table.
Animation	animation			The animation to set into the table.

Syntax

None SetAnimation(index: int, animation: spAnimation)

Parameters

Name	Type	Min	Max	Description
index	int			The id of the animation in the table.
animation	Animation			The animation to set into the table.

SetItem

Sets an item in the table. The id must exist in the table.

Syntax

void SetItem( rid id , const spObject & item ) const;

Parameters

Type	Name	Min	Max	Description
rid	id			Is the id that is to be set.
Object	item			Is the object set to the id.

Syntax

void SetItem(int id, spObject item);

Parameters

Type	Name	Min	Max	Description
int	id			Is the id that is to be set.
Object	item			Is the object set to the id.

Syntax

None SetItem(id: int, item: spObject)

Parameters

Name	Type	Min	Max	Description
id	int			Is the id that is to be set.
item	Object			Is the object set to the id.

Static methods details

IsClassA

Returns true if the class is a or is a descendant of the class named as the type parameter. (Inherited from Object)

Syntax

static bool IsClassA( const char * type ) const;

Parameters

Type	Name	Min	Max	Description
const char *	type			Name of the class to check if the class is, or is a descendant of.

Return value

Type: bool

Syntax

static bool IsClassA(string type);

Parameters

Type	Name	Min	Max	Description
string	type			Name of the class to check if the class is, or is a descendant of.

Return value

Type: bool

Syntax

@staticmethod
bool IsClassA(type: str)

Parameters

Name	Type	Min	Max	Description
type	str			Name of the class to check if the class is, or is a descendant of.

Return value

Type: bool

SafeCast

SafeCast makes sure the input object is of a class that can be cast into spAnimationTable, and if this is the case, returns the object cast into spAnimationTable. (Inherited from Object)

Syntax

static spAnimationTable SafeCast( const spObject & object ) const;

Parameters

Type	Name	Min	Max	Description
Object	object			Object to cast.

Return value

Type: AnimationTable

Syntax

static spAnimationTable SafeCast(spObject object);

Parameters

Type	Name	Min	Max	Description
Object	object			Object to cast.

Return value

Type: AnimationTable

Syntax

@staticmethod
spAnimationTable SafeCast(object: spObject)

Parameters

Name	Type	Min	Max	Description
object	Object			Object to cast.

Return value

Type: AnimationTable