src/ATC/AIEntity.hxx

   1 // FGAIEntity - abstract base class an artificial intelligence entity
   2 //
   3 // Written by David Luff, started March 2002.
   4 //
   5 // Copyright (C) 2002  David C. Luff - david.luff@nottingham.ac.uk
   6 //
   7 // This program is free software; you can redistribute it and/or
   8 // modify it under the terms of the GNU General Public License as
   9 // published by the Free Software Foundation; either version 2 of the
  10 // License, or (at your option) any later version.
  11 //
  12 // This program is distributed in the hope that it will be useful, but
  13 // WITHOUT ANY WARRANTY; without even the implied warranty of
  14 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  15 // General Public License for more details.
  16 //
  17 // You should have received a copy of the GNU General Public License
  18 // along with this program; if not, write to the Free Software
  19 // Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.
  20
  21 #ifndef _FG_AIEntity_HXX
  22 #define _FG_AIEntity_HXX
  23
  24 #include <simgear/math/point3d.hxx>
  25 #include <simgear/scene/model/model.hxx>
  26 #include <simgear/scene/model/placement.hxx>
  27 #include <simgear/structure/ssgSharedPtr.hxx>
  28
  29
  30 class ssgBase;
  31
  32
  33 /*****************************************************************
  34 *
  35 *  FGAIEntity - this class implements the minimum requirement
  36 *  for any AI entity - a position, an orientation, an associated
  37 *  3D model, and the ability to be moved.  It does nothing useful
  38 *  and all AI entities are expected to be derived from it.
  39 *
  40 ******************************************************************/
  41 class FGAIEntity {
  42
  43 public:
  44
  45         FGAIEntity();
  46     virtual ~FGAIEntity();
  47
  48         // Set the 3D model to use (Must be called)
  49         void SetModel(ssgBranch* model);
  50
  51     // Run the internal calculations
  52     virtual void Update(double dt)=0;
  53
  54     // Send a transmission *TO* the AIEntity.
  55     // FIXME int code is a hack - eventually this will receive Alexander's coded messages.
  56     virtual void RegisterTransmission(int code)=0;
  57
  58         inline const Point3D& GetPos() const { return(_pos); }
  59
  60         virtual const string& GetCallsign()=0;
  61
  62 protected:
  63
  64     Point3D _pos;       // WGS84 lat & lon in degrees, elev above sea-level in meters
  65     double _hdg;                //True heading in degrees
  66     double _roll;       //degrees
  67     double _pitch;      //degrees
  68
  69     char* _model_path;  //Path to the 3D model
  70     ssgSharedPtr<ssgBranch> _model;     // Pointer to the model
  71     SGModelPlacement _aip;
  72
  73     void Transform();
  74 };
  75
  76 #endif  // _FG_AIEntity_HXX
  77