Torque3D Documentation / _generateds / guiAnimBitmapCtrl

guiAnimBitmapCtrl

consoledoc.h

More...

Callbacks

void

triggered when a loop completes

void

triggered when an animation completes

void
onFrame(int frameIndex, int frame)

triggered when a frame increments

Public Attributes

string

A list of frames and/or frame ranges to use for particle animation if animateTexture is true.

Point2I

The number of frames, in rows and columns stored in textureName (when animateTexture is true).

int

Index of currently Displaying Frame.

int

Frame Rate.

bool

loop?

bool

play?

bool

play reversed?

Detailed Description

UNDOCUMENTED!

Callbacks

onLoop()

triggered when a loop completes

onCompleted()

triggered when an animation completes

onFrame(int frameIndex, int frame)

triggered when a frame increments

Public Attributes

string animTexFrames 

A list of frames and/or frame ranges to use for particle animation if animateTexture is true.

Each frame token must be separated by whitespace. A frame token must be a positive integer frame number or a range of frame numbers separated with a '-'. The range separator, '-', cannot have any whitspace around it.

Ranges can be specified to move through the frames in reverse as well as forward (eg. 19-14). Frame numbers exceeding the number of tiles will wrap.

mAnimTexFrames = "0-16 20 19 18 17 31-21";

Point2I animTexTiling 

The number of frames, in rows and columns stored in textureName (when animateTexture is true).

A maximum of 256 frames can be stored in a single texture when using mAnimTexTiling. Value should be "NumColumns NumRows", for example "4 4".

int curFrame 

Index of currently Displaying Frame.

int fps 

Frame Rate.

bool Loop 

loop?

bool play 

play?

bool reverse 

play reversed?