Public API Reference

propclass/mechthruster.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_THRUSTER__
#define __CEL_PF_MECHANICS_THRUSTER__

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

#include "propclass/mechcommon.h"

class csVector3;
struct iPcMechanicsObject;
struct iPcMechanicsThrusterGroup;

SCF_VERSION (iPcMechanicsThruster, 0, 0, 1);

struct iPcMechanicsThruster : public iBase
{
  virtual void SetMechanicsObject (iPcMechanicsObject* mechsys) = 0;

  virtual iPcMechanicsObject* GetMechanicsObject () = 0;


  //Set thruster properties

  virtual void SetPosition (const csVector3& pos) = 0;

  virtual const csVector3& GetPosition () = 0;

  virtual void SetOrientation (const csVector3& orientation) = 0;

  virtual const csVector3& GetOrientation () = 0;

  virtual void SetMaxThrust (float maxthrust) = 0;

  virtual float GetMaxThrust () = 0;

  virtual float GetThrustForce (float thrust) = 0;

  virtual float AvailableThrust () = 0;


  //Applying thrust

  virtual void ThrustChange (float deltathrust) = 0;
};


SCF_VERSION (iPcMechanicsBalancedGroup, 0, 0, 1);

enum celAxisType
{
  CEL_AT_NONE,
  CEL_AT_ROTATION,
  CEL_AT_TRANSLATION
};

struct iPcMechanicsBalancedGroup : public iBase
{
  virtual void SetType (celAxisType type) = 0;

  virtual celAxisType GetType () = 0;


  virtual void AddThruster (iPcMechanicsThruster* thruster,
      float multiplier) = 0;

  virtual void RemoveThruster (const char* tag) = 0;

  virtual iPcMechanicsThruster* GetThruster (const char* tag) = 0;

  virtual float AvailableThrust () = 0;

  virtual float AvailableThrustForce () = 0;

  virtual void ChangeThrust (float deltathrust) = 0;
};


SCF_VERSION (iPcMechanicsThrusterController, 0, 0, 1);

struct iPcMechanicsThrusterController : public iBase
{
  virtual void SetMechanicsObject (iPcMechanicsObject* mechobj) = 0;

  virtual iPcMechanicsObject* GetMechanicsObject () = 0;

  virtual void AddAxis (const char* name, celAxisType type, const
        csVector3 axis) = 0;

  virtual const csVector3 GetAxis (const char* name) = 0;

  virtual const celAxisType GetAxisType (const char* name) = 0;

  virtual const float GetAxisVelocity (const char* name) = 0;

  virtual float GetAxisMaxForce (const char* name) = 0;

  virtual float GetAxisMaxThrust (const char* name) = 0;

  virtual void AddBalancedGroup (iPcMechanicsBalancedGroup* group,
        const char* axisname) = 0;

  virtual void RemoveBalancedGroup (const char* grouptag, const char*
        axisname) = 0;

  virtual void ApplyThrust (float thrust, const char* axisname,
        uint32& id) = 0;

  virtual void CancelThrust (uint32 id) = 0;
};

#endif //__CEL_PF_MECHANICS_THRUSTER__

---