class AnimationTrack

Represents a track for a node in an animation. Maintains a collection of key frames. 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 AnimationTrack object. (Inherited from Object)
NodeGUID	The GUID of the node this track animates.

Methods

Method	Description
AddKeyFrame	Adds a key frame to the track.
AddObserver	Adds a user-defined observer object to the interface, that will receive events from the interface. (Inherited from Object)
CreateTransformKeyFrame	Create and add a full transform key frame. Finally return the newly created object.
FindFrameByFrameNumber	Find key frame by frame number and return the object or null.
GetClass	Get the name of the AnimationTrack class. (Inherited from Object)
GetKeyFrameAtIndex	Gets the key frame at given index.(Use FindFrameByFrameNumber if you want to get by frameNumber).
GetKeyFrameCount	Gets the number of key frames in the track.
InitTransformKeyFrames	Initialize number of transform key frames. The operation will reset any currently set key frames.
IsA	Returns true if AnimationTrack is a or is a descendant of the class named as the type parameter. (Inherited from Object)
IsNull	Returns true if the AnimationTrack object is invalid. (Inherited from Object)
IsSameObjectAs	Returns true if the AnimationTrack object is valid. (Inherited from Object)
NonNull	Returns true if the AnimationTrack object is valid. (Inherited from Object)
PrintInfo	Prints the content/info of the AnimationTrack object to the log. (Inherited from Object)
RemoveKeyFrame	Removes a key frame from the track.
RemoveObserver	Removes a previously added observer object. (Inherited from Object)
SortByFrameNumbers	Sort already inserted key frames by frame numbers in ascending order.

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

Properties details

Name

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

NodeGUID

The GUID of the node this track animates.

Syntax

// Setter
void SetNodeGUID( const char * nodeGUID ) const;

// Getter
spString GetNodeGUID() const;

SetNodeGUID parameters

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

GetNodeGUID return value

Type: spString

Syntax

// Setter
void SetNodeGUID(string nodeGUID);

// Getter
string GetNodeGUID();

SetNodeGUID parameters

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

GetNodeGUID return value

Type: string

Syntax

# Setter
None SetNodeGUID(nodeGUID: str)

# Getter
str GetNodeGUID()

SetNodeGUID parameters

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

GetNodeGUID return value

Type: str

Methods details

AddKeyFrame

Adds a key frame to the track.

Syntax

void AddKeyFrame( const spAnimationTrackKeyFrame & keyFrame ) const;

Parameters

Type	Name	Min	Max	Description
AnimationTrackKeyFrame	keyFrame			The key frame to add.

Syntax

void AddKeyFrame(spAnimationTrackKeyFrame keyFrame);

Parameters

Type	Name	Min	Max	Description
AnimationTrackKeyFrame	keyFrame			The key frame to add.

Syntax

None AddKeyFrame(keyFrame: spAnimationTrackKeyFrame)

Parameters

Name	Type	Min	Max	Description
keyFrame	AnimationTrackKeyFrame			The key frame to add.

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

CreateTransformKeyFrame

Create and add a full transform key frame. Finally return the newly created object.

Syntax

spAnimationTrackKeyFrame CreateTransformKeyFrame( unsigned int frameNumber ) const;

Parameters

Type	Name	Min	Max	Description
unsigned int	frameNumber			The frame number of the key frame.

Return value

Type: AnimationTrackKeyFrame

Syntax

spAnimationTrackKeyFrame CreateTransformKeyFrame(uint frameNumber);

Parameters

Type	Name	Min	Max	Description
uint	frameNumber			The frame number of the key frame.

Return value

Type: AnimationTrackKeyFrame

Syntax

spAnimationTrackKeyFrame CreateTransformKeyFrame(frameNumber: int)

Parameters

Name	Type	Min	Max	Description
frameNumber	int			The frame number of the key frame.

Return value

Type: AnimationTrackKeyFrame

FindFrameByFrameNumber

Find key frame by frame number and return the object or null.

Syntax

spAnimationTrackKeyFrame FindFrameByFrameNumber( unsigned int frameNumber ) const;

Parameters

Type	Name	Min	Max	Description
unsigned int	frameNumber			The frame number of the key frame.

Return value

Type: AnimationTrackKeyFrame

Syntax

spAnimationTrackKeyFrame FindFrameByFrameNumber(uint frameNumber);

Parameters

Type	Name	Min	Max	Description
uint	frameNumber			The frame number of the key frame.

Return value

Type: AnimationTrackKeyFrame

Syntax

spAnimationTrackKeyFrame FindFrameByFrameNumber(frameNumber: int)

Parameters

Name	Type	Min	Max	Description
frameNumber	int			The frame number of the key frame.

Return value

Type: AnimationTrackKeyFrame

GetClass

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

GetKeyFrameAtIndex

Gets the key frame at given index.(Use FindFrameByFrameNumber if you want to get by frameNumber).

Syntax

spAnimationTrackKeyFrame GetKeyFrameAtIndex( unsigned int index ) const;

Parameters

Type	Name	Min	Max	Description
unsigned int	index			The index to .

Return value

Type: AnimationTrackKeyFrame

Syntax

spAnimationTrackKeyFrame GetKeyFrameAtIndex(uint index);

Parameters

Type	Name	Min	Max	Description
uint	index			The index to .

Return value

Type: AnimationTrackKeyFrame

Syntax

spAnimationTrackKeyFrame GetKeyFrameAtIndex(index: int)

Parameters

Name	Type	Min	Max	Description
index	int			The index to .

Return value

Type: AnimationTrackKeyFrame

GetKeyFrameCount

Gets the number of key frames in the track.

Syntax

unsigned int GetKeyFrameCount() const;

Parameters

GetKeyFrameCount takes no parameters.

Return value

Type: unsigned int

Syntax

uint GetKeyFrameCount();

Parameters

GetKeyFrameCount takes no parameters.

Return value

Type: uint

Syntax

int GetKeyFrameCount()

Parameters

GetKeyFrameCount takes no parameters.

Return value

Type: int

InitTransformKeyFrames

Initialize number of transform key frames. The operation will reset any currently set key frames.

Syntax

void InitTransformKeyFrames( unsigned int totalFrames ) const;

Parameters

Type	Name	Min	Max	Description
unsigned int	totalFrames			The total number of frames to initialize.

Syntax

void InitTransformKeyFrames(uint totalFrames);

Parameters

Type	Name	Min	Max	Description
uint	totalFrames			The total number of frames to initialize.

Syntax

None InitTransformKeyFrames(totalFrames: int)

Parameters

Name	Type	Min	Max	Description
totalFrames	int			The total number of frames to initialize.

IsA

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

Return value

Type: bool

IsNull

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

RemoveKeyFrame

Removes a key frame from the track.

Syntax

void RemoveKeyFrame( const spAnimationTrackKeyFrame & keyFrame ) const;

Parameters

Type	Name	Min	Max	Description
AnimationTrackKeyFrame	keyFrame			The key frame to remove.

Syntax

void RemoveKeyFrame(spAnimationTrackKeyFrame keyFrame);

Parameters

Type	Name	Min	Max	Description
AnimationTrackKeyFrame	keyFrame			The key frame to remove.

Syntax

None RemoveKeyFrame(keyFrame: spAnimationTrackKeyFrame)

Parameters

Name	Type	Min	Max	Description
keyFrame	AnimationTrackKeyFrame			The key frame to remove.

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.

SortByFrameNumbers

Sort already inserted key frames by frame numbers in ascending order.

Syntax

void SortByFrameNumbers() const;

Parameters

SortByFrameNumbers takes no parameters.

Syntax

void SortByFrameNumbers();

Parameters

SortByFrameNumbers takes no parameters.

Syntax

None SortByFrameNumbers()

Parameters

SortByFrameNumbers takes no parameters.

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

Syntax

static spAnimationTrack SafeCast( const spObject & object ) const;

Parameters

Type	Name	Min	Max	Description
Object	object			Object to cast.

Return value

Type: AnimationTrack

Syntax

static spAnimationTrack SafeCast(spObject object);

Parameters

Type	Name	Min	Max	Description
Object	object			Object to cast.

Return value

Type: AnimationTrack

Syntax

@staticmethod
spAnimationTrack SafeCast(object: spObject)

Parameters

Name	Type	Min	Max	Description
object	Object			Object to cast.

Return value

Type: AnimationTrack