---

joint.h

Go to the documentation of this file.

#ifndef __THESTAGE_JOINT__
#define __THESTAGE_JOINT__

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

/* Chooses an engine and defines abstracts */
/*******************************************/
#include "engineAbstract.h"

/* Joint Type Identifiers ******************/
/*******************************************/
#define JOINT_NUM 0x0001

#define NODEJOINT_NUM 0x0002

#define PROPERTYJOINT_NUM 0x0004

#define PARTICLEJOINT_NUM 0x0008

/* Joint Error Codes ***********************/
/*******************************************/
#define OUT_OF_BOUNDS -1

#define MASSIVE_POINTER_FAILURE -2

/* String libraries for C++-style support **/
/*******************************************/

#include <iostream>
#include <string>

using namespace std;

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

enum JointPart
{
  JP_ACTION_CODE = 0,
  JP_NAME,
  JP_SUPPLEMENTAL_DATA,
  JP_VALUE,
  JP_VALUE_START,
  JP_VALUE_END,
  JP_TARGET
};

enum NodeAction
{
  NA_NOTHING = 0,
  NA_ROTATE,
  NA_TRANSLATE
};

enum PuppetProperty
{
  PP_NOTHING = 50,
  PP_POSITION,
  PP_SCALE,
  PP_LIGHT_R,
  PP_LIGHT_G,
  PP_LIGHT_B,
  PP_LIGHT_RADIUS,
  PP_PARTICLE_SPAWN_RATE = 100,
  PP_PARTICLE_GRAVITY,
  PP_PARTICLE_R,
  PP_PARTICLE_G,
  PP_PARTICLE_B,
  PP_PARTICLE_LIFETIME,
  PP_PARTICLE_VEL_X,
  PP_PARTICLE_VEL_Y,
  PP_PARTICLE_VEL_Z
};

class Joint
{
 protected:
  uint16 actionCode;
 public:
  string name;
 protected:
  VECTOR_TYPE supplementalData;
 
 public:
  virtual uint16 JointType( void ) = 0;
  virtual void Modify( JointPart part, float mVal ) = 0;
  virtual void Modify( JointPart part, string &mVal ) = 0;
  virtual void Modify( JointPart part, uint16 mVal ) = 0;
  virtual void Modify( JointPart part, VECTOR_TYPE mVal ) = 0;
  virtual void SetValue( float newValue ) = 0;
};

typedef Joint *JointPtr;

class NodeJoint : public Joint
{ 
 private:
  uint16 affectedNode;
  float value;
  float valueMaximum;
  float valueMinimum;

 public:
  NodeJoint( void );
  NodeJoint( uint16 aC, uint16 aN, float v, float vMax, float vMin, string &n, VECTOR_TYPE sup );
  ~NodeJoint( void );
#ifdef __ENGINE_LITHTECH__

  void ApplyJoint( LTMatrix *modifyMe );
#endif

  uint16 GetAffectedNode( void );
  void Init( uint16 aC, uint16 aN, float v, float vMax, float vMin, string &n, VECTOR_TYPE sup );
  uint16 JointType( void );
  void Modify( JointPart part, float mVal );
  void Modify( JointPart part, string &mVal );
  void Modify( JointPart part, uint16 mVal );
  void Modify( JointPart part, VECTOR_TYPE mVal );
  void SetValue( float newValue );
};



class PropertyJoint : public Joint
{
 protected:
  PuppetProperty affectedProperty;
  HANDLE_TYPE puppetHandle;
  VECTOR_TYPE value;
  VECTOR_TYPE valueBeginRange;
  VECTOR_TYPE valueEndRange;

 public:
  /* \fn PropertyJoint::PropertyJoint( void )
     \brief Empty constructor

     This constructor ssigns joint to a non-existant property with no action.
  */
  PropertyJoint( void );
  PropertyJoint( PuppetProperty aP, VECTOR_TYPE vBegin, VECTOR_TYPE vEnd, string &n, VECTOR_TYPE sup, HANDLE_TYPE pH );
  ~PropertyJoint( void );
  void Init( PuppetProperty aP, VECTOR_TYPE vBegin, VECTOR_TYPE vEnd, string &n, VECTOR_TYPE sup );
  uint16 JointType( void );
  void Modify( JointPart part, float mVal );
  void Modify( JointPart part, string &mVal );
  void Modify( JointPart part, uint16 mVal );
  void Modify( JointPart part, VECTOR_TYPE mVal );
  void SetValue( float newValue );
};

class ParticleJoint : public PropertyJoint
{
 private:
  void *puppetData;
 public:
  ParticleJoint( PuppetProperty aP, VECTOR_TYPE vBegin, VECTOR_TYPE vEnd, string &n, VECTOR_TYPE sup, void *pD );
  uint16 JointType( void );
  void SetValue( float newValue );
};

#endif

---