]> git.mxchange.org Git - flightgear.git/blob - src/FDM/groundcache.hxx
14aeb171c1e34b8153dced6971e37d436f2b6022
[flightgear.git] / 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., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.
20 //
21 // $Id$
22
23 #ifndef _GROUNDCACHE_HXX
24 #define _GROUNDCACHE_HXX
25
26 #include <osg/Group>
27 #include <osg/ref_ptr>
28
29 #include <simgear/compiler.h>
30 #include <simgear/constants.h>
31 #include <simgear/math/SGMath.hxx>
32 #include <simgear/math/SGGeometry.hxx>
33 #include <simgear/scene/bvh/BVHNode.hxx>
34 #include <simgear/structure/SGSharedPtr.hxx>
35
36 class SGMaterial;
37 namespace simgear {
38 class BVHLineGeometry;
39 }
40
41 class FGGroundCache {
42 public:
43     FGGroundCache();
44     ~FGGroundCache();
45
46     //////////////////////////////////////////////////////////////////////////
47     // Ground handling routines
48     //////////////////////////////////////////////////////////////////////////
49
50     // Prepare the ground cache for the wgs84 position pt_*.
51     // That is take all vertices in the ball with radius rad around the
52     // position given by the pt_* and store them in a local scene graph.
53     bool prepare_ground_cache(double startSimTime, double endSimTime,
54                               const SGVec3d& pt, double rad);
55
56     // Returns true if the cache is valid.
57     // Also the reference time, point and radius values where the cache
58     // is valid for are returned.
59     bool is_valid(double& ref_time, SGVec3d& pt, double& rad);
60
61     // Returns the unit down vector at the ground cache
62     const SGVec3d& get_down() const
63     { return down; }
64
65
66     bool get_body(double t, SGMatrixd& bodyToWorld, SGVec3d& linearVel,
67                   SGVec3d& angularVel, simgear::BVHNode::Id id);
68
69     // Return the nearest catapult to the given point
70     // pt in wgs84 coordinates.
71     double get_cat(double t, const SGVec3d& pt,
72                    SGVec3d end[2], SGVec3d vel[2]);
73   
74
75     // Return the altitude above ground below the wgs84 point pt
76     // Search for highest triangle not higher than pt + max_altoff.
77     // Return ground properties like the maximum load
78     // this kind kind of ground can carry, the friction factor between
79     // 0 and 1 which can be used to model lower friction with wet runways.
80     bool get_agl(double t, const SGVec3d& pt, SGVec3d& contact,
81                  SGVec3d& normal, SGVec3d& linearVel, SGVec3d& angularVel,
82                  simgear::BVHNode::Id& id, const SGMaterial*& material);
83
84     bool get_nearest(double t, const SGVec3d& pt, double maxDist,
85                      SGVec3d& contact, SGVec3d& linearVel, SGVec3d& angularVel,
86                      simgear::BVHNode::Id& id, const SGMaterial*& material);
87
88     // Return 1 if the hook intersects with a wire.
89     // That test is done by checking if the quad spanned by the points pt*
90     // intersects with the line representing the wire.
91     // If the wire is caught, the cache will trace this wires endpoints until
92     // the FDM calls release_wire().
93     bool caught_wire(double t, const SGVec3d pt[4]);
94   
95     // Return the location and speed of the wire endpoints.
96     bool get_wire_ends(double t, SGVec3d end[2], SGVec3d vel[2]);
97
98     // Tell the cache code that it does no longer need to care for
99     // the wire end position.
100     void release_wire(void);
101
102 private:
103     class CacheFill;
104     class BodyFinder;
105     class CatapultFinder;
106     class WireIntersector;
107     class WireFinder;
108
109     // Approximate ground radius.
110     // In case the aircraft is too high above ground.
111     double _altitude;
112     // the simgear material reference, contains friction coeficients ...
113     const SGMaterial* _material;
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 to track.
118     const simgear::BVHLineGeometry* _wire;
119
120     // The point and radius where the cache is built around.
121     // That are the arguments that were given to prepare_ground_cache.
122     SGVec3d reference_wgs84_point;
123     double reference_vehicle_radius;
124     SGVec3d down;
125     bool found_ground;
126
127     SGSharedPtr<simgear::BVHNode> _localBvhTree;
128 };
129
130 #endif