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