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
  28
  29 /*****************************************************************
  30 *
  31 *  FGAIEntity - this class implements the minimum requirement
  32 *  for any AI entity - a position, an orientation, an associated
  33 *  3D model, and the ability to be moved.  It does nothing useful
  34 *  and all AI entities are expected to be derived from it.
  35 *
  36 ******************************************************************/
  37 class FGAIEntity {
  38
  39 public:
  40
  41         FGAIEntity();
  42     virtual ~FGAIEntity();
  43
  44         // Set the 3D model to use (Must be called)
  45   void SetModel(osg::Node* model);
  46
  47     // Run the internal calculations
  48     virtual void Update(double dt)=0;
  49
  50     // Send a transmission *TO* the AIEntity.
  51     // FIXME int code is a hack - eventually this will receive Alexander's coded messages.
  52     virtual void RegisterTransmission(int code)=0;
  53
  54         inline const Point3D& GetPos() const { return(_pos); }
  55
  56         virtual const string& GetCallsign()=0;
  57
  58 protected:
  59
  60     Point3D _pos;       // WGS84 lat & lon in degrees, elev above sea-level in meters
  61     double _hdg;                //True heading in degrees
  62     double _roll;       //degrees
  63     double _pitch;      //degrees
  64
  65     char* _model_path;  //Path to the 3D model
  66     osg::ref_ptr<osg::Node> _model;     // Pointer to the model
  67     SGModelPlacement _aip;
  68
  69     void Transform();
  70 };
  71
  72 #endif  // _FG_AIEntity_HXX
  73