torque Torque Game Engine Documentation
TGE Version 1.5.2

ParticleData Class Reference

#include <particleEngine.h>

Inheritance diagram for ParticleData:

Inheritance graph
[legend]

Public Member Functions

 ParticleData ()
 ~ParticleData ()
void initializeParticle (Particle *, const Point3F &)
void packData (BitStream *stream)
void unpackData (BitStream *stream)
bool onAdd ()
 Called when the object is added to the sim.
bool preload (bool server, char errorBuffer[256])
 Called to prepare the datablock for use, after it has been unpacked.
bool loadParameters ()
bool reload (char errorBuffer[256])
 DECLARE_CONOBJECT (ParticleData)

Static Public Member Functions

static void initPersistFields ()
 Register dynamic fields in a subclass of ConsoleObject.

Data Fields

F32 dragCoefficient
F32 windCoefficient
F32 gravityCoefficient
F32 inheritedVelFactor
F32 constantAcceleration
S32 lifetimeMS
S32 lifetimeVarianceMS
F32 spinSpeed
F32 spinRandomMin
F32 spinRandomMax
bool useInvAlpha
bool allowLighting
bool animateTexture
U32 numFrames
U32 framesPerSec
ColorF colors [ParticleEngine::PC_COLOR_KEYS]
F32 sizes [ParticleEngine::PC_SIZE_KEYS]
F32 times [4]
StringTableEntry textureNameList [PDC_MAX_TEX]
TextureHandle textureList [PDC_MAX_TEX]

Private Types

enum  PDConst { PDC_MAX_TEX = 50 }
typedef SimDataBlock Parent

Member Typedef Documentation

Reimplemented from SimDataBlock.


Member Enumeration Documentation

enum ParticleData::PDConst [private]

Enumerator:
PDC_MAX_TEX 


Constructor & Destructor Documentation

ParticleData::ParticleData (  ) 

ParticleData::~ParticleData (  ) 


Member Function Documentation

void ParticleData::initializeParticle ( Particle ,
const Point3F  
)

void ParticleData::packData ( BitStream stream  )  [virtual]

Reimplemented from SimDataBlock.

void ParticleData::unpackData ( BitStream stream  )  [virtual]

Reimplemented from SimDataBlock.

bool ParticleData::onAdd (  )  [virtual]

Called when the object is added to the sim.

Reimplemented from SimDataBlock.

bool ParticleData::preload ( bool  server,
char  errorBuffer[256] 
) [virtual]

Called to prepare the datablock for use, after it has been unpacked.

Parameters:
server Set if we're running on the server (and therefore don't need to load things like textures or sounds).
errorBuffer If an error occurs in loading, this is set to a short string describing the error.
Returns:
True if all went well; false if something failed.
See also:
preload() and File Downloading

Reimplemented from SimDataBlock.

bool ParticleData::loadParameters (  ) 

bool ParticleData::reload ( char  errorBuffer[256]  ) 

ParticleData::DECLARE_CONOBJECT ( ParticleData   ) 

static void ParticleData::initPersistFields (  )  [static]

Register dynamic fields in a subclass of ConsoleObject.

See also:
addField(), addFieldV(), addDepricatedField(), addGroup(), endGroup()

Reimplemented from SimObject.


Field Documentation

ColorF ParticleData::colors[ParticleEngine::PC_COLOR_KEYS]

F32 ParticleData::sizes[ParticleEngine::PC_SIZE_KEYS]

TextureHandle ParticleData::textureList[PDC_MAX_TEX]




All Rights Reserved GarageGames.com, Inc. 1999-2005
Auto-magically Generated with Doxygen