Main Page   Class Hierarchy   Compound List   File List   Compound Members   File Members  

PSystemPuppet Class Reference

Puppet that controls a dynamic particle system. More...

#include <puppet.h>

Inheritance diagram for PSystemPuppet::

Puppet List of all members.

Public Methods

 PSystemPuppet (vpmVPM *vpmPuppetInfo, ssfPuppet *ssfPuppetInfo, VPM *vpmFileInfo)
 XML-file-based constructor. More...

void KeyframeAnimation (uint16 anim)
 Does nothing in PSystemPuppet. More...

uint16 PuppetType (void)
 Returns a code identifying the type of puppet. More...

void UpdateTick (void)
 Function that gets called on a puppet every update. More...


Friends

class ParticleJoint

Detailed Description

Puppet that controls a dynamic particle system.

PSystemPuppet controls a particle system in the engine dynamically, and spawns new particles during UpdateTick according to its psys_spawn_rate. The puppet contains particle-system-specific information that only ParticleJoints can access. PSystem puppet can also take position-and-scale-altering PropertyJoints, though it disregards all other light-realted propertyJoints.


Constructor & Destructor Documentation

PSystemPuppet::PSystemPuppet vpmVPM *    vpmPuppetInfo,
ssfPuppet *    ssfPuppetInfo,
VPM *    vpmFileInfo
 

XML-file-based constructor.

Parameters:
vpmPuppetInfo  an XML parse file from the .vpm detailing a specific puppet.
ssfPuppetInfo  an XML parse file from the .ssf detailing a specific puppet.
vpmFileInfo  an XML parse file from the .vpm detailing an entire file.
Creates a particle system based on the XML files.


Member Function Documentation

PSystemPuppet::KeyframeAnimation uint16    anim [virtual]
 

Does nothing in PSystemPuppet.

Parameters:
anim  an integer specifying the animation to start.
In PSystemPuppet, KeyframeAnimation is an empty function.

Reimplemented from Puppet.

uint16 PSystemPuppet::PuppetType void    [virtual]
 

Returns a code identifying the type of puppet.

Returns:
the puppet code

Reimplemented from Puppet.

void PSystemPuppet::UpdateTick void    [virtual]
 

Function that gets called on a puppet every update.

If a puppet requires maintenance or upkeep of some sort, changing data only when the Stage recieves a network packet from Kairaishi might not be sufficient. Every update tick, this function gets called to remedy that problem.

Reimplemented from Puppet.


The documentation for this class was generated from the following file:
Generated on Tue Oct 16 13:42:10 2001 for The Stage by doxygen1.2.11 written by Dimitri van Heesch, © 1997-2001