torque Torque Game Engine Documentation
TGE Version 1.5.2

ParticleEmitterNode Class Reference

#include <particleEmitter.h>

Inheritance diagram for ParticleEmitterNode:

Inheritance graph
[legend]

Public Member Functions

 ParticleEmitterNode ()
 ~ParticleEmitterNode ()
void advanceTime (F32 dt)
 Advances simulation time for animations.
void setEmitterDataBlock (ParticleEmitterData *data)
ParticleEmittergetParticleEmitter ()
 DECLARE_CONOBJECT (ParticleEmitterNode)
U32 packUpdate (NetConnection *conn, U32 mask, BitStream *stream)
 Instructs this object to pack its state for transfer over the network.
void unpackUpdate (NetConnection *conn, BitStream *stream)
 Instructs this object to read state data previously packed with packUpdate.
virtual void onGroupAdd ()
 Called when the object is added to a SimGroup.

Static Public Member Functions

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

Protected Member Functions

bool onAdd ()
 Called when the object is added to the sim.
void onRemove ()
 Called when the object is removed from the sim.
bool onNewDataBlock (GameBaseData *dptr)
 Called when a new datablock is set.

Protected Attributes

ParticleEmitterDatamEmitterDatablock
S32 mEmitterDatablockId
ParticleEmittermEmitter
F32 mVelocity

Private Types

typedef GameBase Parent

Private Attributes

ParticleEmitterNodeDatamDataBlock

Member Typedef Documentation

Reimplemented from GameBase.


Constructor & Destructor Documentation

ParticleEmitterNode::ParticleEmitterNode (  ) 

ParticleEmitterNode::~ParticleEmitterNode (  ) 


Member Function Documentation

bool ParticleEmitterNode::onAdd (  )  [protected, virtual]

Called when the object is added to the sim.

Reimplemented from GameBase.

void ParticleEmitterNode::onRemove (  )  [protected, virtual]

Called when the object is removed from the sim.

Reimplemented from GameBase.

bool ParticleEmitterNode::onNewDataBlock ( GameBaseData dptr  )  [protected, virtual]

Called when a new datablock is set.

This allows subclasses to appropriately handle new datablocks.

See also:
setDataBlock()
Parameters:
dptr New datablock

Reimplemented from GameBase.

void ParticleEmitterNode::advanceTime ( F32  dt  )  [virtual]

Advances simulation time for animations.

This is called every frame.

Parameters:
dt Time since last advance call

Reimplemented from GameBase.

void ParticleEmitterNode::setEmitterDataBlock ( ParticleEmitterData data  ) 

ParticleEmitter* ParticleEmitterNode::getParticleEmitter (  )  [inline]

ParticleEmitterNode::DECLARE_CONOBJECT ( ParticleEmitterNode   ) 

static void ParticleEmitterNode::initPersistFields (  )  [static]

Register dynamic fields in a subclass of ConsoleObject.

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

Reimplemented from GameBase.

U32 ParticleEmitterNode::packUpdate ( NetConnection conn,
U32  mask,
BitStream stream 
) [virtual]

Instructs this object to pack its state for transfer over the network.

Parameters:
conn Net connection being used
mask Mask indicating fields to transmit.
stream Bitstream to pack data to
Returns:
Any bits which were not dealt with. The value is stored by the networking system. Don't set bits you weren't passed.

Reimplemented from GameBase.

void ParticleEmitterNode::unpackUpdate ( NetConnection conn,
BitStream stream 
) [virtual]

Instructs this object to read state data previously packed with packUpdate.

Parameters:
conn Net connection being used
stream stream to read from

Reimplemented from GameBase.

virtual void ParticleEmitterNode::onGroupAdd (  )  [virtual]

Called when the object is added to a SimGroup.

Reimplemented from SimObject.


Field Documentation




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