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/scene/model/particles.hxx>
38 #include <simgear/structure/subsystem_mgr.hxx>
40 #include "SceneryPager.hxx"
46 // Define a structure containing global scenery parameters
47 class FGScenery : public SGSubsystem
49 class ScenerySwitchListener;
50 friend class ScenerySwitchListener;
54 osg::ref_ptr<osg::Switch> scene_graph;
55 osg::ref_ptr<osg::Group> terrain_branch;
56 osg::ref_ptr<osg::Group> models_branch;
57 osg::ref_ptr<osg::Group> aircraft_branch;
58 osg::ref_ptr<osg::Group> interior_branch;
59 osg::ref_ptr<osg::Group> particles_branch;
61 osg::ref_ptr<flightgear::SceneryPager> _pager;
62 ScenerySwitchListener* _listener;
68 // Implementation of SGSubsystem.
73 void update (double dt);
75 /// Compute the elevation of the scenery at geodetic latitude lat,
76 /// geodetic longitude lon and not higher than max_alt.
77 /// If the exact flag is set to true, the scenery center is moved to
78 /// gain a higher accuracy of that query. The center is restored past
79 /// that to the original value.
80 /// The altitude hit is returned in the alt argument.
81 /// The method returns true if the scenery is available for the given
82 /// lat/lon pair. If there is no scenery for that point, the altitude
83 /// value is undefined.
84 /// All values are meant to be in meters or degrees.
85 bool get_elevation_m(const SGGeod& geod, double& alt,
86 const simgear::BVHMaterial** material,
87 const osg::Node* butNotFrom = 0);
89 /// Compute the elevation of the scenery below the cartesian point pos.
90 /// you the returned scenery altitude is not higher than the position
91 /// pos plus an offset given with max_altoff.
92 /// If the exact flag is set to true, the scenery center is moved to
93 /// gain a higher accuracy of that query. The center is restored past
94 /// that to the original value.
95 /// The altitude hit is returned in the alt argument.
96 /// The method returns true if the scenery is available for the given
97 /// lat/lon pair. If there is no scenery for that point, the altitude
98 /// value is undefined.
99 /// All values are meant to be in meters.
100 bool get_cart_elevation_m(const SGVec3d& pos, double max_altoff,
102 const simgear::BVHMaterial** material,
103 const osg::Node* butNotFrom = 0);
105 /// Compute the nearest intersection point of the line starting from
106 /// start going in direction dir with the terrain.
107 /// The input and output values should be in cartesian coordinates in the
108 /// usual earth centered wgs84 coordinate system. Units are meters.
109 /// On success, true is returned.
110 bool get_cart_ground_intersection(const SGVec3d& start, const SGVec3d& dir,
112 const osg::Node* butNotFrom = 0);
114 osg::Group *get_scene_graph () const { return scene_graph.get(); }
115 osg::Group *get_terrain_branch () const { return terrain_branch.get(); }
116 osg::Group *get_models_branch () const { return models_branch.get(); }
117 osg::Group *get_aircraft_branch () const { return aircraft_branch.get(); }
118 osg::Group *get_interior_branch () const { return interior_branch.get(); }
119 osg::Group *get_particles_branch () const { return particles_branch.get(); }
121 /// Returns true if scenery is available for the given lat, lon position
122 /// within a range of range_m.
123 /// lat and lon are expected to be in degrees.
124 bool scenery_available(const SGGeod& position, double range_m);
126 // Static because access to the pager is needed before the rest of
127 // the scenery is initialized.
128 static flightgear::SceneryPager* getPagerSingleton();
129 static void resetPagerSingleton();
131 flightgear::SceneryPager* getPager() { return _pager.get(); }
133 static const char* subsystemName() { return "scenery"; }
137 #endif // _SCENERY_HXX