Public API Reference

propclass/mechsys.h

/*
    Crystal Space Entity Layer
    Copyright (C) 2005 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_MECHANICS_SYSTEM__
#define __CEL_PF_MECHANICS_SYSTEM__

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

#include "propclass/mechcommon.h"
#include "csgeom/vector3.h"
class csBox3;
class csOrthoTransform;
class csPlane3;
struct iDynamicSystem;
struct iRigidBody;
struct iSector;
struct iPcMesh;
struct iPcLight;
struct iPcCamera;
struct iPcMechanicsObject;
struct iJoint;

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

  virtual void SetDynamicSystem (iDynamicSystem* dynsys) = 0;

  virtual void SetDynamicSystem (const char *dynsysname) = 0;


  virtual iDynamicSystem* GetDynamicSystem () = 0;

  virtual void SetStepTime (float delta) = 0;

  virtual float GetStepTime () const = 0;
  
  virtual void SetSimulationSpeed (float simulationspeed) = 0;
  
  virtual float GetSimulationSpeed () = 0;
  
  virtual void SetGravity (const csVector3& grav) = 0;

  virtual const csVector3 GetGravity () = 0;

  virtual void AddForceDuration (iPcMechanicsObject* pcobject,
        const csVector3& force, bool relative, const csVector3& position,
        float seconds) = 0;

  virtual void AddForceFrame (iPcMechanicsObject* pcobject,
        const csVector3& force, bool relative, const csVector3& position) = 0;

  virtual void AddForceTagged (iPcMechanicsObject* pcobject,
        const csVector3& force, bool relative, const csVector3& position,
        uint32 forceid) = 0;

  virtual void RemoveForceTagged (iPcMechanicsObject* pcobject,
        uint32 forceid) = 0;

  virtual void ClearForces (iPcMechanicsObject* pcobject) = 0;

  virtual void ClearAllForces () = 0;

  virtual csPtr<iRigidBody> CreateBody () = 0;

  virtual void RemoveBody (iRigidBody* body) = 0;

  virtual void AddBodyToGroup (iRigidBody* body, const char* group) = 0;

  virtual void RemoveBodyFromGroup (iRigidBody* body, const char* group) = 0;

  virtual iJoint* CreateJoint (iRigidBody* body1, iRigidBody* body2) = 0;

  virtual void RemoveJoint (iJoint* joint) = 0;

  virtual void DisableStepFast () = 0;
  virtual void EnableStepFast () = 0;
  virtual void EnableQuickStep () = 0;
};

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

  virtual void SetMesh (iPcMesh* mesh) = 0;

  virtual iPcMesh* GetMesh () = 0;

  virtual void SetLight (iPcLight* light) = 0;

  virtual iPcLight* GetLight () = 0;

  virtual void SetCamera (iPcCamera* camera) = 0;

  virtual iPcCamera* GetCamera () = 0;

  virtual void SetMechanicsSystem (iPcMechanicsSystem* mechsys) = 0;

  virtual iPcMechanicsSystem* GetMechanicsSystem () = 0;

  virtual iRigidBody* GetBody () = 0;


  //Object properties.

  virtual void SetFriction (float friction) = 0;

  virtual void SetMass (float mass) = 0;

  virtual void SetElasticity (float elasticity) = 0;

  virtual void SetDensity (float density) = 0;

  virtual void SetSoftness (float softness) = 0;

  virtual void SetLift (const csVector3& lift) = 0;

  virtual void SetDrag (float drag) = 0;

  virtual float GetFriction () = 0;

  virtual float GetMass () = 0;

  virtual float GetElasticity () = 0;

  virtual float GetDensity () = 0;

  virtual float GetSoftness () = 0;

  virtual const csVector3& GetLift () = 0;

  virtual float GetDrag () = 0;


  //Initial velocities

  virtual void SetLinearVelocity (const csVector3& vel) = 0;

  virtual void SetAngularVelocity (const csVector3& vel) = 0;


  //Reading velocities

  virtual const csVector3 GetLinearVelocity () = 0;

  virtual const csVector3 GetAngularVelocity () = 0;

  virtual void MakeStatic (bool stat) = 0;
  
  virtual bool IsStatic () const = 0;

  virtual void SetCollisionCallbackEnabled (bool en) = 0;

  virtual bool IsCollisionCallbackEnabled () const = 0;

  //Colliders

  virtual void AttachColliderBoundingSphere (float radiusadjustment = 0.0f) = 0;

  virtual void AttachColliderSphere (float radius, const csVector3& offset) = 0;

  virtual void AttachColliderCylinder (float length, float radius,
        const csOrthoTransform& trans) = 0;

  virtual void AttachColliderBoundingBox (const csVector3& sizeadjustment = csVector3(0)) = 0;

  virtual void AttachColliderBox (const csVector3& size,
        const csOrthoTransform& trans) = 0;

  virtual void AttachColliderPlane (const csPlane3& plane) = 0;

  virtual void AttachColliderMesh () = 0;


  //Forces

  virtual void AddForceOnce (const csVector3& force, bool relative,
        const csVector3& position) = 0;

  virtual void AddForceDuration (const csVector3& force, bool relative,
        const csVector3& position, float seconds) = 0;

  virtual void AddForceFrame (const csVector3& force, bool relative,
        const csVector3& position) = 0;

  virtual uint32 AddForceTagged (const csVector3& force, bool relative, 
        const csVector3& position) = 0;

  virtual void RemoveForceTagged (uint32 forceid) = 0;

  virtual void ClearForces () = 0;


  //Groups and Joints

  virtual void AddToGroup (const char* group) = 0;

  virtual void RemoveFromGroup (const char* group) = 0;

  virtual iJoint* CreateJoint (iPcMechanicsObject* other) = 0;

  virtual csVector3 LocalToWorld(csVector3 local) = 0;
  virtual csVector3 WorldToLocal(csVector3 world) = 0;
};

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

  virtual iJoint* GetJoint () = 0;
};

#endif // __CEL_PF_MECHANICS_SYSTEM__

---