---

puppet.h

Go to the documentation of this file.

#ifndef __STAGE_PUPPET__
#define __STAGE_PUPPET__

/*******************************************/
/* Defines & Includes                      */
/*******************************************/

/* Parsing code for XML files. *************/
/*******************************************/
#include "ssf.h"
#include "vpm.h"

/* Knowledge of the engine and joint types */
/*******************************************/
#include "engineAbstract.h"
#include "joint.h"

/* Hard Size Limits ************************/
/*******************************************/

#define ACTION_MAX 64

/* Puppet Type Identifiers *****************/
/*******************************************/

#define PUPPET_NUM 0x0001

#define MODELPUPPET_NUM 0x0002

#define LIGHTPUPPET_NUM 0x0004

#define PSYSTEMPUPPET_NUM 0x0008

/* Puppet-Related Error Codes **************/
/*******************************************/

#define PUPPET_NULL -101

#define PUPPET_ALREADY_EXISTS -102

#define NO_ACTION -103

/*******************************************/
/* Classes                                 */
/*******************************************/

class Puppet
{
 protected:
  JointPtr *actionArray;
  uint16 actionArrayMax;
  string modelName;
 public:
  HANDLE_TYPE myHandle;
 protected:
  VECTOR_TYPE position;
  VECTOR_TYPE scale;
  VECTOR_TYPE orientation;

 public:
  Puppet::Puppet( void );

  Puppet::~Puppet( void );

  virtual void ActOnJoint( uint16 jointEntry, float value );

  virtual RESULT_TYPE AddNodeJoint( uint16 actionArrayLoc, uint16 actionCode, uint16 actionNode, float valMax, float valMin, string &name, VECTOR_TYPE supplementalData );

  virtual RESULT_TYPE AddParticleJoint( uint16 actionArrayLoc, PuppetProperty aP, VECTOR_TYPE vBegin, VECTOR_TYPE vEnd, string &n, VECTOR_TYPE sup );

  virtual RESULT_TYPE AddPropertyJoint( uint16 actionArrayLoc, PuppetProperty aP, VECTOR_TYPE vBegin, VECTOR_TYPE vEnd, string &n, VECTOR_TYPE sup, HANDLE_TYPE pH);

  virtual RESULT_TYPE DeleteJoint( uint16 actionArrayLoc );

  void FillCommon(vpmVPM *vpmPuppetInfo, ssfPuppet *ssfPuppetInfo, VPM *vpmFileInfo,  ObjectCreateStruct &createstruct);
  VECTOR_TYPE GetPosition( void );

  VECTOR_TYPE GetScale( void );

  virtual void KeyframeAnimation( uint16 anim ) = 0;

  RESULT_TYPE ModifyJoint( uint16 actionArrayLoc, JointPart part, float mVal );
  RESULT_TYPE ModifyJoint( uint16 actionArrayLoc, JointPart part, string &mVal );
  RESULT_TYPE ModifyJoint( uint16 actionArrayLoc, JointPart part, uint16 mVal );
  RESULT_TYPE ModifyJoint( uint16 actionArrayLoc, JointPart part, VECTOR_TYPE mVal );

  virtual uint16 PuppetType( void );

  void SetPosition( VECTOR_TYPE newPosition );

  void SetScale( VECTOR_TYPE newScale );

  virtual void UpdateTick( void ) = 0;
};

class ModelPuppet : public Puppet
{
 private:
  string modelFile;
  string textureFile;
 public:
  ModelPuppet( vpmVPM *vpmPuppetInfo, ssfPuppet *ssfPuppetInfo, VPM *vpmFileInfo );
  void KeyframeAnimation( uint16 anim );
#ifdef __ENGINE_LITHTECH__

  void NodeControlFunc( HOBJECT hObj, HMODELNODE hNode, LTMatrix *pGlobalMat );
#endif

  uint16 PuppetType( void );
  void UpdateTick( void );
};

class LightPuppet : public Puppet
{
 public:
  LightPuppet( vpmVPM *vpmPuppetInfo, ssfPuppet *ssfPuppetInfo, VPM *vpmFileInfo );
  void KeyframeAnimation( uint16 anim );
  uint16 PuppetType( void );
  void UpdateTick( void );
};

class PSystemPuppet : public Puppet
{
 private:
  VECTOR_TYPE psys_color;
  float psys_gravity;
  float psys_lifetime;
  uint16 psys_spawn_rate;
  string textureFile;

 public:
  PSystemPuppet( vpmVPM *vpmPuppetInfo, ssfPuppet *ssfPuppetInfo, VPM *vpmFileInfo );
  void KeyframeAnimation( uint16 anim );
  uint16 PuppetType( void );
  void UpdateTick( void );

  friend class ParticleJoint;
};

typedef Puppet *PuppetPtr;

/*******************************************/
/* External Functions                      */
/*******************************************/

#ifdef __ENGINE_LITHTECH__

void PuppetNodeControlFunc( HOBJECT hObj, HMODELNODE hNode, LTMatrix *pGlobalMat, void *pUserData);
#endif

void StringToActionType( char *the_string, uint16 &joint_type, uint16 &action_type );
void StringToObjectType( char *the_string, uint16 &object_type );

/*******************************************/
/* Externed Globals                        */
/*******************************************/

#endif

---