src/FDM/groundcache.hxx

   1 // groundcache.hxx -- carries a small subset of the scenegraph near the vehicle
   2 //
   3 // Written by Mathias Froehlich, started Nov 2004.
   4 //
   5 // Copyright (C) 2004  Mathias Froehlich - Mathias.Froehlich@web.de
   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 // $Id$
  22
  23 #ifndef _GROUNDCACHE_HXX
  24 #define _GROUNDCACHE_HXX
  25
  26 #include <plib/sg.h>
  27 #include <plib/ssg.h>
  28 #include <simgear/compiler.h>
  29 #include <simgear/constants.h>
  30
  31 class FGGroundCache {
  32 public:
  33     FGGroundCache();
  34     ~FGGroundCache();
  35
  36     //////////////////////////////////////////////////////////////////////////
  37     // Ground handling routines
  38     //////////////////////////////////////////////////////////////////////////
  39
  40     // Prepare the ground cache for the wgs84 position pt_*.
  41     // That is take all vertices in the ball with radius rad around the
  42     // position given by the pt_* and store them in a local scene graph.
  43     bool prepare_ground_cache(double ref_time, const double pt[3],
  44                               double rad);
  45
  46     // Returns true if the cache is valid.
  47     // Also the reference time, point and radius values where the cache
  48     // is valid for are returned.
  49     bool is_valid(double *ref_time, double pt[3], double *rad);
  50
  51
  52     // Return the nearest catapult to the given point
  53     // pt in wgs84 coordinates.
  54     double get_cat(double t, const double pt[3],
  55                    double end[2][3], double vel[2][3]);
  56
  57
  58     // Return the altitude above ground below the wgs84 point pt
  59     // Search for the nearest triangle to pt.
  60     // Return ground properties like the ground type, the maximum load
  61     // this kind kind of ground can carry, the friction factor between
  62     // 0 and 1 which can be used to model lower friction with wet runways
  63     // and finally the altitude above ground.
  64     bool get_agl(double t, const double pt[3],
  65                  double contact[3], double normal[3], double vel[3],
  66                  int *type, double *loadCapacity,
  67                  double *frictionFactor, double *agl);
  68
  69
  70     // Return 1 if the hook intersects with a wire.
  71     // That test is done by checking if the quad spanned by the points pt*
  72     // intersects with the line representing the wire.
  73     // If the wire is caught, the cache will trace this wires endpoints until
  74     // the FDM calls release_wire().
  75     bool caught_wire(double t, const double pt[4][3]);
  76
  77     // Return the location and speed of the wire endpoints.
  78     bool get_wire_ends(double t, double end[2][3], double vel[2][3]);
  79
  80     // Tell the cache code that it does no longer need to care for
  81     // the wire end position.
  82     void release_wire(void);
  83
  84 private:
  85     struct Triangle {
  86       // The edge vertices.
  87       sgdVec3 vertices[3];
  88       // The surface normal.
  89       sgdVec4 plane;
  90       // The bounding shpere.
  91       sgdSphere sphere;
  92       // The linear velocity.
  93       sgdVec3 velocity;
  94       // Ground type
  95       int type;
  96     };
  97     struct Catapult {
  98       sgdVec3 start;
  99       sgdVec3 end;
 100       sgdVec3 velocity;
 101     };
 102     struct Wire {
 103       sgdVec3 ends[2];
 104       sgdVec3 velocity;
 105       int wire_id;
 106     };
 107
 108
 109     // The center of the cache.
 110     sgdVec3 cache_center;
 111     // Approximate ground radius.
 112     // In case the aircraft is too high above ground.
 113     double ground_radius;
 114     // The time reference for later call to intersection test routines.
 115     // Is required since we will have moving triangles in carriers.
 116     double cache_ref_time;
 117     // The wire identifier to track.
 118     int wire_id;
 119
 120     // Containers which hold all the essential information about this cache.
 121     std::vector<Triangle> triangles;
 122     std::vector<Catapult> catapults;
 123     std::vector<Wire> wires;
 124
 125     // The point and radius where the cache is built around.
 126     // That are the arguments that were given to prepare_ground_cache.
 127     sgdVec3 reference_wgs84_point;
 128     double reference_vehicle_radius;
 129     bool found_ground;
 130
 131
 132     // Fills the environment cache with everything inside the sphere sp.
 133     void cache_fill(ssgBranch *branch, sgdMat4 xform,
 134                     sgdSphere* sp, sgdVec3 down, sgdSphere* wsp);
 135
 136     // compute the ground property of this leaf.
 137     void putSurfaceLeafIntoCache(const sgdSphere *sp, const sgdMat4 xform,
 138                                  bool sphIsec, sgdVec3 down, ssgLeaf *l);
 139
 140     void putLineLeafIntoCache(const sgdSphere *wsp, const sgdMat4 xform,
 141                               ssgLeaf *l);
 142
 143     // Helper class to hold some properties of the ground triangle.
 144     struct GroundProperty {
 145       GroundProperty() : type(0) {}
 146       int type;
 147       int wire_id;
 148       sgVec3 vel;
 149       // not yet implemented ...
 150 //       double loadCapacity;
 151     };
 152
 153     // compute the ground property of this leaf.
 154     static GroundProperty extractGroundProperty( ssgLeaf* leaf );
 155
 156
 157     static void velocityTransformTriangle(double dt, Triangle& dst,
 158                                           const Triangle& src);
 159 };
 160
 161 #endif