1 // scenery.hxx -- data structures and routines for managing scenery.
3 // Written by Curtis Olson, started May 1997.
5 // Copyright (C) 1997 Curtis L. Olson - http://www.flightgear.org/~curt
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.
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.
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.
29 # error This library requires C++
32 #include <osg/ref_ptr>
35 #include <simgear/compiler.h>
36 #include <simgear/math/SGMath.hxx>
37 #include <simgear/structure/subsystem_mgr.hxx>
39 #include "SceneryPager.hxx"
45 // Define a structure containing global scenery parameters
46 class FGScenery : public SGSubsystem {
49 osg::ref_ptr<osg::Group> scene_graph;
50 osg::ref_ptr<osg::Group> terrain_branch;
51 osg::ref_ptr<osg::Group> models_branch;
52 osg::ref_ptr<osg::Group> aircraft_branch;
53 osg::ref_ptr<osg::Group> interior_branch;
55 osg::ref_ptr<flightgear::SceneryPager> _pager;
62 // Implementation of SGSubsystem.
67 void update (double dt);
69 /// Compute the elevation of the scenery at geodetic latitude lat,
70 /// geodetic longitude lon and not higher than max_alt.
71 /// If the exact flag is set to true, the scenery center is moved to
72 /// gain a higher accuracy of that query. The center is restored past
73 /// that to the original value.
74 /// The altitude hit is returned in the alt argument.
75 /// The method returns true if the scenery is available for the given
76 /// lat/lon pair. If there is no scenery for that point, the altitude
77 /// value is undefined.
78 /// All values are meant to be in meters or degrees.
79 bool get_elevation_m(const SGGeod& geod, double& alt,
80 const simgear::BVHMaterial** material,
81 const osg::Node* butNotFrom = 0);
83 /// Compute the elevation of the scenery below the cartesian point pos.
84 /// you the returned scenery altitude is not higher than the position
85 /// pos plus an offset given with max_altoff.
86 /// If the exact flag is set to true, the scenery center is moved to
87 /// gain a higher accuracy of that query. The center is restored past
88 /// that to the original value.
89 /// The altitude hit is returned in the alt argument.
90 /// The method returns true if the scenery is available for the given
91 /// lat/lon pair. If there is no scenery for that point, the altitude
92 /// value is undefined.
93 /// All values are meant to be in meters.
94 bool get_cart_elevation_m(const SGVec3d& pos, double max_altoff,
96 const simgear::BVHMaterial** material,
97 const osg::Node* butNotFrom = 0);
99 /// Compute the nearest intersection point of the line starting from
100 /// start going in direction dir with the terrain.
101 /// The input and output values should be in cartesian coordinates in the
102 /// usual earth centered wgs84 coordinate system. Units are meters.
103 /// On success, true is returned.
104 bool get_cart_ground_intersection(const SGVec3d& start, const SGVec3d& dir,
106 const osg::Node* butNotFrom = 0);
108 osg::Group *get_scene_graph () const { return scene_graph.get(); }
109 osg::Group *get_terrain_branch () const { return terrain_branch.get(); }
110 osg::Group *get_models_branch () const { return models_branch.get(); }
111 osg::Group *get_aircraft_branch () const { return aircraft_branch.get(); }
112 osg::Group *get_interior_branch () const { return interior_branch.get(); }
114 /// Returns true if scenery is available for the given lat, lon position
115 /// within a range of range_m.
116 /// lat and lon are expected to be in degrees.
117 bool scenery_available(const SGGeod& position, double range_m);
119 // Static because access to the pager is needed before the rest of
120 // the scenery is initialized.
121 static flightgear::SceneryPager* getPagerSingleton();
122 static void resetPagerSingleton();
124 flightgear::SceneryPager* getPager() { return _pager.get(); }
128 #endif // _SCENERY_HXX