class AnimationTrackTransformKeyFrame

Represents a key frame on the animation track with a baked transformation. 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
FrameNumber	The frame number of the key frame. (Inherited from AnimationTrackKeyFrame)
Name	The name of the AnimationTrackTransformKeyFrame object. (Inherited from Object)

Methods

Method	Description
AddObserver	Adds a user-defined observer object to the interface, that will receive events from the interface. (Inherited from Object)
GetClass	Get the name of the AnimationTrackTransformKeyFrame class. (Inherited from Object)
GetTransform	Gets the transformation for this key frame.
IsA	Returns true if AnimationTrackTransformKeyFrame is a or is a descendant of the class named as the type parameter. (Inherited from Object)
IsNull	Returns true if the AnimationTrackTransformKeyFrame object is invalid. (Inherited from Object)
IsSameObjectAs	Returns true if the AnimationTrackTransformKeyFrame object is valid. (Inherited from Object)
NonNull	Returns true if the AnimationTrackTransformKeyFrame object is valid. (Inherited from Object)
PrintInfo	Prints the content/info of the AnimationTrackTransformKeyFrame object to the log. (Inherited from Object)
RemoveObserver	Removes a previously added observer object. (Inherited from Object)

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

Properties details

FrameNumber

The frame number of the key frame.

Syntax

// Setter
void SetFrameNumber( unsigned int frameNumber ) const;

// Getter
unsigned int GetFrameNumber() const;

SetFrameNumber parameters

Type	Name	Min	Max	Description
unsigned int	frameNumber			The frame number to set.

GetFrameNumber return value

Type: unsigned int

Syntax

// Setter
void SetFrameNumber(uint frameNumber);

// Getter
uint GetFrameNumber();

SetFrameNumber parameters

Type	Name	Min	Max	Description
uint	frameNumber			The frame number to set.

GetFrameNumber return value

Type: uint

Syntax

# Setter
None SetFrameNumber(frameNumber: int)

# Getter
int GetFrameNumber()

SetFrameNumber parameters

Name	Type	Min	Max	Description
frameNumber	int			The frame number to set.

GetFrameNumber return value

Type: int

Name

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

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

GetClass

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

GetTransform

Gets the transformation for this key frame.

Syntax

spMatrix4x4 GetTransform() const;

Parameters

GetTransform takes no parameters.

Return value

Type: Matrix4x4

Syntax

spMatrix4x4 GetTransform();

Parameters

GetTransform takes no parameters.

Return value

Type: Matrix4x4

Syntax

spMatrix4x4 GetTransform()

Parameters

GetTransform takes no parameters.

Return value

Type: Matrix4x4

IsA

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

Return value

Type: bool

IsNull

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

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

Syntax

static spAnimationTrackTransformKeyFrame SafeCast( const spObject & object ) const;

Parameters

Type	Name	Min	Max	Description
Object	object			Object to cast.

Return value

Type: AnimationTrackTransformKeyFrame

Syntax

static spAnimationTrackTransformKeyFrame SafeCast(spObject object);

Parameters

Type	Name	Min	Max	Description
Object	object			Object to cast.

Return value

Type: AnimationTrackTransformKeyFrame

Syntax

@staticmethod
spAnimationTrackTransformKeyFrame SafeCast(object: spObject)

Parameters

Name	Type	Min	Max	Description
object	Object			Object to cast.

Return value

Type: AnimationTrackTransformKeyFrame