Initial commit

Torque/SDK/engine/game/vehicles/wheeledVehicle.h

@@ -0,0 +1,221 @@
+//-----------------------------------------------------------------------------
+// Torque Game Engine
+// Copyright (C) GarageGames.com, Inc.
+//-----------------------------------------------------------------------------
+
+#ifndef _WHEELEDVEHICLE_H_
+#define _WHEELEDVEHICLE_H_
+
+#ifndef _VEHICLE_H_
+#include "game/vehicles/vehicle.h"
+#endif
+
+#ifndef _CLIPPEDPOLYLIST_H_
+#include "collision/clippedPolyList.h"
+#endif
+
+class ParticleEmitter;
+class ParticleEmitterData;
+
+
+//----------------------------------------------------------------------------
+
+struct WheeledVehicleTire: public SimDataBlock {
+   typedef SimDataBlock Parent;
+
+   //
+   StringTableEntry shapeName;// Max shape to render
+
+   // Physical properties
+   F32 mass;                  // Mass of the whole wheel
+   F32 kineticFriction;       // Tire friction coefficient
+   F32 staticFriction;        // Tire friction coefficient
+   F32 restitution;           // Currently not used
+
+   // Tires act as springs and generate lateral and longitudinal
+   // forces to move the vehicle. These distortion/spring forces
+   // are what convert wheel angular velocity into forces that
+   // act on the rigid body.
+   F32 lateralForce;          // Spring force
+   F32 lateralDamping;        // Damping force
+   F32 lateralRelaxation;     // The tire will relax if left alone
+   F32 longitudinalForce;
+   F32 longitudinalDamping;
+   F32 longitudinalRelaxation;
+
+   // Shape information initialized in the preload
+   Resource<TSShape> shape;   // The loaded shape
+   F32 radius;                // Tire radius
+
+   //
+   WheeledVehicleTire();
+   DECLARE_CONOBJECT(WheeledVehicleTire);
+   static void initPersistFields();
+   bool preload(bool, char errorBuffer[256]);
+   virtual void packData(BitStream* stream);
+   virtual void unpackData(BitStream* stream);
+};
+
+
+//----------------------------------------------------------------------------
+
+struct WheeledVehicleSpring: public SimDataBlock {
+   typedef SimDataBlock Parent;
+
+   F32 length;                // Travel distance from root hub position
+   F32 force;                 // Spring force
+   F32 damping;               // Damping force
+   F32 antiSway;              // Opposite wheel anti-sway
+
+   //
+   WheeledVehicleSpring();
+   DECLARE_CONOBJECT(WheeledVehicleSpring);
+   static void initPersistFields();
+   virtual void packData(BitStream* stream);
+   virtual void unpackData(BitStream* stream);
+};
+
+
+//----------------------------------------------------------------------------
+
+struct WheeledVehicleData: public VehicleData {
+   typedef VehicleData Parent;
+
+   enum Constants {
+      MaxWheels = 8,
+      MaxWheelBits = 3
+   };
+
+   enum Sounds {
+      JetSound,
+      EngineSound,
+      SquealSound,
+      WheelImpactSound,
+      MaxSounds,
+   };
+   AudioProfile* sound[MaxSounds];
+
+   ParticleEmitterData* tireEmitter;
+
+   F32 maxWheelSpeed;            // Engine torque is scale based on wheel speed
+   F32 engineTorque;             // Engine force controlled through throttle
+   F32 engineBrake;              // Break force applied when throttle is 0
+   F32 brakeTorque;              // Force used when brakeing
+
+   // Initialized onAdd
+   struct Wheel {
+      S32 opposite;              // Opposite wheel on Y axis (or -1 for none)
+      Point3F pos;               // Root pos of spring
+      S32 springNode;            // Wheel spring/hub node
+      S32 springSequence;        // Suspension animation
+      F32 springLength;          // Suspension animation length
+   } wheel[MaxWheels];
+   U32 wheelCount;
+   ClippedPolyList rigidBody;    // Extracted from shape
+   S32 brakeLightSequence;       // Brakes
+   S32 steeringSequence;         // Steering animation
+
+   //
+   WheeledVehicleData();
+   DECLARE_CONOBJECT(WheeledVehicleData);
+   static void initPersistFields();
+   bool preload(bool, char errorBuffer[256]);
+   bool mirrorWheel(Wheel* we);
+   virtual void packData(BitStream* stream);
+   virtual void unpackData(BitStream* stream);
+};
+
+
+//----------------------------------------------------------------------------
+
+class WheeledVehicle: public Vehicle
+{
+   typedef Vehicle Parent;
+
+   enum MaskBits {
+      WheelMask    = Parent::NextFreeMask << 0,
+      NextFreeMask = Parent::NextFreeMask << 1
+   };
+
+   WheeledVehicleData* mDataBlock;
+
+   bool mBraking;
+   TSThread* mTailLightThread;
+   AUDIOHANDLE mJetSound;
+   AUDIOHANDLE mEngineSound;
+   AUDIOHANDLE mSquealSound;
+
+   struct Wheel {
+      WheeledVehicleTire *tire;
+      WheeledVehicleSpring *spring;
+      WheeledVehicleData::Wheel* data;
+
+      F32 extension;          // Spring extension (0-1)
+      F32 avel;               // Angular velocity
+      F32 apos;               // Anuglar position (client side only)
+      F32 Dy,Dx;              // Current tire deformation
+
+      struct Surface {
+         bool contact;        // Wheel is touching a surface
+         Point3F normal;      // Surface normal
+         U32 material;        // Surface material
+         Point3F pos;         // Point of contact
+         SceneObject* object; // Object in contact with
+      } surface;
+
+      TSShapeInstance* shapeInstance;
+      TSThread* springThread;
+
+      F32 steering;           // Wheel steering scale
+      bool powered;           // Powered by engine
+      bool slipping;          // Traction on last tick
+      F32 torqueScale;        // Max torque % applied to wheel (0-1)
+      F32 slip;               // Amount of wheel slip (0-1)
+      SimObjectPtr<ParticleEmitter> emitter;
+   };
+   Wheel mWheel[WheeledVehicleData::MaxWheels];
+   TSThread* mSteeringThread;
+
+   //
+   bool onNewDataBlock(GameBaseData* dptr);
+   void processTick(const Move *move);
+   void updateMove(const Move *move);
+   void updateForces(F32 dt);
+   void renderImage(SceneState *state, SceneRenderImage *image);
+   void extendWheels(bool clientHack = false);
+
+   // Client sounds & particles
+   void updateWheelThreads();
+   void updateWheelParticles(F32 dt);
+   void updateEngineSound(F32 level);
+   void updateSquealSound(F32 level);
+   void updateJetSound();
+
+   U32 getCollisionMask();
+
+public:
+   DECLARE_CONOBJECT(WheeledVehicle);
+   static void initPersistFields();
+
+   WheeledVehicle();
+   ~WheeledVehicle();
+
+   bool onAdd();
+   void onRemove();
+   void advanceTime(F32 dt);
+   bool buildPolyList(AbstractPolyList* polyList, const Box3F &box, const SphereF &sphere);
+
+   S32 getWheelCount();
+   void setWheelSteering(S32 wheel,F32 steering);
+   void setWheelPowered(S32 wheel,bool powered);
+   void setWheelTire(S32 wheel,WheeledVehicleTire*);
+   void setWheelSpring(S32 wheel,WheeledVehicleSpring*);
+
+   void writePacketData(GameConnection * conn, BitStream *stream);
+   void readPacketData(GameConnection * conn, BitStream *stream);
+   U32  packUpdate(NetConnection * conn, U32 mask, BitStream *stream);
+   void unpackUpdate(NetConnection * conn, BitStream *stream);
+};
+
+
+#endif