propclass/wheeled.h

/*
    Crystal Space Entity Layer
    Copyright (C) 2006 by Jorrit Tyberghein

    This library is free software; you can redistribute it and/or
    modify it under the terms of the GNU Library General Public
    License as published by the Free Software Foundation; either
    version 2 of the License, or (at your option) any later version.

    This library is distributed in the hope that it will be useful,
    but WITHOUT ANY WARRANTY; without even the implied warranty of
    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
    Library General Public License for more details.

    You should have received a copy of the GNU Library General Public
    License along with this library; if not, write to the Free
    Software Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
*/

#ifndef __CEL_PF_WHEELED__
#define __CEL_PF_WHEELED__

#include "cstypes.h"
#include "csutil/scf.h"
#include "csgeom/matrix3.h"

struct iCelEntity;
struct iBodyGroup;
struct iMeshFactoryWrapper;
struct iODEHinge2Joint;
struct iODEAMotorJoint;
struct iRigidBody;

struct iPcWheeled : public virtual iBase
{
  SCF_INTERFACE (iPcWheeled, 1, 0, 0);

  virtual void SetWheelMesh(const char* wheelfact, const char* wheelfile) = 0;

  virtual void SetWheelMesh(size_t wheelnum, const char* wheelfact,
      const char* wheelfile) = 0;

  virtual void SetTankMode(bool tankmode) = 0;

  virtual bool GetTankMode() = 0;

  CS_DEPRECATED_METHOD virtual void SetABSEnabled(bool enabled) = 0;

  CS_DEPRECATED_METHOD virtual bool GetABSEnabled() = 0;

  virtual void SetDifferential(bool enabled) = 0;

  virtual void SetAntiSway(bool enabled) = 0;

  virtual void SetAntiSwayFactor(float antiswayfactor) = 0;

  virtual void SetAntiSwayLimit(float antiswaylimit) = 0;

  
  virtual bool GetDifferential() = 0;

  virtual bool GetAntiSway() = 0;

  virtual float GetAntiSwayFactor() = 0;

  virtual float GetAntiSwayLimit() = 0;
  
  virtual void SetABS(bool enabled) = 0;

  virtual bool GetABS() = 0;

  virtual size_t AddWheelAuto(csVector3 position, const char* wheelfact = 0,
     const char* wheelfile = 0,
     csMatrix3 rotation = csMatrix3(0.0f,0.0f,0.0f,0.0f)) = 0;

  CS_DEPRECATED_METHOD virtual size_t AddWheel(csVector3 position,
                       float turnspeed, float returnspeed,
                       float suspensionsoftness, float suspensiondamping,
                       float brakepower, float enginepower,
                       float leftsteersensitivity,
                       float rightsteersensitivity, bool handbrakeaffect,
                       bool steerinvert, const char* wheelfact = 0, 
                       const char* wheelfile = 0,
                       csMatrix3 rotation = csMatrix3(0.0f,0.0f,0.0f,0.0f)) = 0;

  virtual size_t AddWheel(csVector3 position,
                       float turnspeed, float returnspeed,
                       float suspensionsoftness, float suspensiondamping,
                       float brakepower, float enginepower,
                       float leftsteersensitivity, float friction, float mass,
                       float rightsteersensitivity, bool handbrakeaffect,
                       bool steerinvert, const char* wheelfact = 0, 
                       const char* wheelfile = 0,
                       csMatrix3 rotation = csMatrix3(0.0f,0.0f,0.0f,0.0f)) = 0;

  virtual void DeleteWheel(size_t wheelnum) = 0;

  virtual void DeleteAllWheels() = 0;

  virtual void DestroyWheel(size_t wheelnum) = 0;

  virtual void DestroyAllWheels() = 0;

  virtual void RestoreWheel(size_t wheelnum) = 0;

  virtual void RestoreAllWheels() = 0;

  virtual void SetOuterWheelSteerPreset(float sensitivity) = 0;

  CS_DEPRECATED_METHOD virtual void SetFrontWheelPreset(float sensitivity,
     float power, float suspensionsoftness, float suspensiondamping) = 0;

  virtual void SetFrontWheelPreset(float sensitivity,float power,
     float suspensionsoftness, float suspensiondamping, float friction,
     float mass) = 0;

  CS_DEPRECATED_METHOD virtual void SetRearWheelPreset(float sensitivity,
     float power, float suspensionsoftness, float suspensiondamping) = 0;

  virtual void SetRearWheelPreset(float sensitivity,float power,
     float suspensionsoftness, float suspensiondamping, float friction,
     float mass) = 0;

  virtual void Accelerate(float amount =  1.0f) = 0;

  virtual float GetAcceleratorAmount() = 0;

  virtual void Brake(float amount =  1.0f) = 0;

  virtual float GetBrakeAmount() = 0;

  virtual void Handbrake(bool applied) = 0;

  virtual bool IsHandbraking() = 0;

  virtual void SetSteerAmount(float amount) = 0;

  virtual void SetBrakeForce(float force) = 0;

  virtual float GetSteerAmount() = 0;

  virtual float GetSpeed() = 0;

  virtual void SteerLeft(float amount = 1.0f) = 0;

  virtual void SteerRight(float amount = 1.0f) = 0;

  virtual void Steer(float amount) = 0;

  virtual void SteerStraight() = 0;

  virtual void Reverse() = 0;

  virtual void Neutral() = 0;

  virtual void SetAutoTransmission(bool autoTransmission) = 0;

  virtual void SetGear(int gear) = 0;

  virtual int GetGear() = 0;

  virtual void SetGearSettings(int gear,float velocity, float force) = 0;

  virtual float GetGearVelocity(int gear) = 0;

  virtual float GetGearForce(int gear) = 0;

  virtual int GetTopGear() = 0;

  virtual void SetAutoReverse(bool autoreverse) = 0;

  virtual iBodyGroup* GetBodyGroup() = 0;

  virtual void SetWheelPosition(size_t wheelnum, csVector3 position) = 0;

  virtual void SetWheelRotation(size_t wheelnum, csMatrix3 rotation) = 0;

  virtual void SetWheelSuspensionSoftness(size_t wheelnum, float softness) = 0;

  virtual void SetWheelSuspensionDamping(size_t wheelnum, float damping) = 0;

  virtual void SetWheelLeftSteerSensitivity(size_t wheelnum,
      float sensitivity) = 0;

  virtual void SetWheelRightSteerSensitivity(size_t wheelnum,
      float sensitivity) = 0;

  virtual void SetWheelFriction(size_t wheelnum,
      float friction) = 0;

  virtual void SetWheelMass(size_t wheelnum,
      float mass) = 0;

  virtual void SetWheelTurnSpeed(size_t wheelnum, float speed) = 0;

  virtual void SetWheelReturnSpeed(size_t wheelnum, float speed) = 0;

  virtual void SetWheelEnginePower(size_t wheelnum, float power) = 0;

  virtual void SetWheelBrakePower(size_t wheelnum, float power) = 0;

  virtual void SetWheelSteerInverted(size_t wheelnum, bool inverted) = 0;

  virtual void SetWheelHandbrakeAffected(size_t wheelnum,
      bool handbrakeaffected) = 0;

  virtual csVector3 GetWheelPosition(size_t wheelnum) = 0;

  virtual csMatrix3 GetWheelRotation(size_t wheelnum) = 0;

  virtual float GetWheelSuspensionSoftness(size_t wheelnum) = 0;

  virtual float GetWheelSuspensionDamping(size_t wheelnum) = 0;

  virtual float GetWheelLeftSteerSensitivity(size_t wheelnum) = 0;

  virtual float GetWheelRightSteerSensitivity(size_t wheelnum) = 0;

  virtual float GetWheelFriction(size_t wheelnum) = 0;

  virtual float GetWheelMass(size_t wheelnum) = 0;

  virtual float GetWheelTurnSpeed(size_t wheelnum) = 0;

  virtual float GetWheelReturnSpeed(size_t wheelnum) = 0;

  virtual float GetWheelEnginePower(size_t wheelnum) = 0;

  virtual float GetWheelBrakePower(size_t wheelnum) = 0;

  virtual bool GetWheelSteerInverted(size_t wheelnum) = 0;

  virtual bool GetWheelHandbrakeAffected(size_t wheelnum) = 0;

  virtual size_t GetWheelCount() = 0;

  virtual float GetWheelSpin(size_t wheelnum) = 0;

  virtual float GetAverageWheelSpin() = 0;

  virtual iRigidBody* GetWheelBody(size_t wheelnum) = 0;

  virtual iODEHinge2Joint* GetWheelJoint(size_t wheelnum) = 0;

  virtual iODEAMotorJoint* GetBrakeMotor(size_t wheelnum) = 0;

  virtual void SetCollisionCallbackEnabled (bool en) = 0;

  virtual bool IsCollisionCallbackEnabled () const = 0;
};

#endif // __CEL_PF_WHEELED__