class Animation

Represents an animation sequence. 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
FrameRate	The frame rate of the animation.
Name	The name of the Animation object. (Inherited from Object)
TotalFrames	The total number of frames in the animation.

Methods

Method	Description
AddObserver	Adds a user-defined observer object to the interface, that will receive events from the interface. (Inherited from Object)
CreateTrackForNode	Creates a track for the given node GUID.
FindFrameForNode	Finds a track for the given node GUID.
FindTrackForNode	Finds a track for the given node GUID.
GetClass	Get the name of the Animation class. (Inherited from Object)
GetTrackCount	Gets the number of tracks in the animation.
GetTracks	Gets a collection of all the animation tracks.
IsA	Returns true if Animation is a or is a descendant of the class named as the type parameter. (Inherited from Object)
IsNull	Returns true if the Animation object is invalid. (Inherited from Object)
IsSameObjectAs	Returns true if the Animation object is valid. (Inherited from Object)
NonNull	Returns true if the Animation object is valid. (Inherited from Object)
PrintInfo	Prints the content/info of the Animation object to the log. (Inherited from Object)
RemoveObserver	Removes a previously added observer object. (Inherited from Object)
RemoveTrackForNode	Removes a track for the given node GUID.

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 spAnimation, and if this is the case, returns the object cast into spAnimation. (Inherited from Object)

Properties details

FrameRate

The frame rate of the animation.

Syntax

// Setter
void SetFrameRate( unsigned int value ) const;

// Getter
unsigned int GetFrameRate() const;

SetFrameRate parameters

Type	Name	Min	Max	Description
unsigned int	value			The frame rate of the animation.

GetFrameRate return value

Type: unsigned int

Default: 0

Syntax

// Setter
void SetFrameRate(uint value);

// Getter
uint GetFrameRate();

SetFrameRate parameters

Type	Name	Min	Max	Description
uint	value			The frame rate of the animation.

GetFrameRate return value

Type: uint

Default: 0

Syntax

# Setter
None SetFrameRate(value: int)

# Getter
int GetFrameRate()

SetFrameRate parameters

Name	Type	Min	Max	Description
value	int			The frame rate of the animation.

GetFrameRate return value

Type: int

Default: 0

Name

The name of the Animation 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

TotalFrames

The total number of frames in the animation.

Syntax

// Setter
void SetTotalFrames( unsigned int value ) const;

// Getter
unsigned int GetTotalFrames() const;

SetTotalFrames parameters

Type	Name	Min	Max	Description
unsigned int	value			The total number of frames in the animation.

GetTotalFrames return value

Type: unsigned int

Default: 0

Syntax

// Setter
void SetTotalFrames(uint value);

// Getter
uint GetTotalFrames();

SetTotalFrames parameters

Type	Name	Min	Max	Description
uint	value			The total number of frames in the animation.

GetTotalFrames return value

Type: uint

Default: 0

Syntax

# Setter
None SetTotalFrames(value: int)

# Getter
int GetTotalFrames()

SetTotalFrames parameters

Name	Type	Min	Max	Description
value	int			The total number of frames in the animation.

GetTotalFrames return value

Type: int

Default: 0

Methods details

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

CreateTrackForNode

Creates a track for the given node GUID.

Syntax

spAnimationTrack CreateTrackForNode( const char * nodeGUID ) const;

Parameters

Type	Name	Min	Max	Description
const char *	nodeGUID			The unique id for a SceneNode.

Return value

Type: AnimationTrack

Syntax

spAnimationTrack CreateTrackForNode(string nodeGUID);

Parameters

Type	Name	Min	Max	Description
string	nodeGUID			The unique id for a SceneNode.

Return value

Type: AnimationTrack

Syntax

spAnimationTrack CreateTrackForNode(nodeGUID: str)

Parameters

Name	Type	Min	Max	Description
nodeGUID	str			The unique id for a SceneNode.

Return value

Type: AnimationTrack

FindFrameForNode

Finds a track for the given node GUID.

Syntax

spAnimationTrackKeyFrame FindFrameForNode( const char * nodeGUID , unsigned int frameNumber ) const;

Parameters

Type	Name	Min	Max	Description
const char *	nodeGUID			The unique id for a SceneNode.
unsigned int	frameNumber			The frame number.

Return value

Type: AnimationTrackKeyFrame

Syntax

spAnimationTrackKeyFrame FindFrameForNode(string nodeGUID, uint frameNumber);

Parameters

Type	Name	Min	Max	Description
string	nodeGUID			The unique id for a SceneNode.
uint	frameNumber			The frame number.

Return value

Type: AnimationTrackKeyFrame

Syntax

spAnimationTrackKeyFrame FindFrameForNode(nodeGUID: str, frameNumber: int)

Parameters

Name	Type	Min	Max	Description
nodeGUID	str			The unique id for a SceneNode.
frameNumber	int			The frame number.

Return value

Type: AnimationTrackKeyFrame

FindTrackForNode

Finds a track for the given node GUID.

Syntax

spAnimationTrack FindTrackForNode( const char * nodeGUID ) const;

Parameters

Type	Name	Min	Max	Description
const char *	nodeGUID			The unique id for a SceneNode.

Return value

Type: AnimationTrack

Syntax

spAnimationTrack FindTrackForNode(string nodeGUID);

Parameters

Type	Name	Min	Max	Description
string	nodeGUID			The unique id for a SceneNode.

Return value

Type: AnimationTrack

Syntax

spAnimationTrack FindTrackForNode(nodeGUID: str)

Parameters

Name	Type	Min	Max	Description
nodeGUID	str			The unique id for a SceneNode.

Return value

Type: AnimationTrack

GetClass

Get the name of the Animation 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

GetTrackCount

Gets the number of tracks in the animation.

Syntax

unsigned int GetTrackCount() const;

Parameters

GetTrackCount takes no parameters.

Return value

Type: unsigned int

Syntax

uint GetTrackCount();

Parameters

GetTrackCount takes no parameters.

Return value

Type: uint

Syntax

int GetTrackCount()

Parameters

GetTrackCount takes no parameters.

Return value

Type: int

GetTracks

Gets a collection of all the animation tracks.

Syntax

spAnimationTrackCollection GetTracks() const;

Parameters

GetTracks takes no parameters.

Return value

Type: AnimationTrackCollection

Syntax

spAnimationTrackCollection GetTracks();

Parameters

GetTracks takes no parameters.

Return value

Type: AnimationTrackCollection

Syntax

spAnimationTrackCollection GetTracks()

Parameters

GetTracks takes no parameters.

Return value

Type: AnimationTrackCollection

IsA

Returns true if Animation 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 Animation 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 Animation 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 Animation is, or is a descendant of.

Return value

Type: bool

IsNull

Returns true if the Animation 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 Animation 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 Animation 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 Animation 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.

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.

RemoveTrackForNode

Removes a track for the given node GUID.

Syntax

void RemoveTrackForNode( const char * nodeGUID ) const;

Parameters

Type	Name	Min	Max	Description
const char *	nodeGUID			The unique id for a SceneNode.

Syntax

void RemoveTrackForNode(string nodeGUID);

Parameters

Type	Name	Min	Max	Description
string	nodeGUID			The unique id for a SceneNode.

Syntax

None RemoveTrackForNode(nodeGUID: str)

Parameters

Name	Type	Min	Max	Description
nodeGUID	str			The unique id for a SceneNode.

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 spAnimation, and if this is the case, returns the object cast into spAnimation. (Inherited from Object)

Syntax

static spAnimation SafeCast( const spObject & object ) const;

Parameters

Type	Name	Min	Max	Description
Object	object			Object to cast.

Return value

Type: Animation

Syntax

static spAnimation SafeCast(spObject object);

Parameters

Type	Name	Min	Max	Description
Object	object			Object to cast.

Return value

Type: Animation

Syntax

@staticmethod
spAnimation SafeCast(object: spObject)

Parameters

Name	Type	Min	Max	Description
object	Object			Object to cast.

Return value

Type: Animation