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"
43 // Define a structure containing global scenery parameters
44 class FGScenery : public SGSubsystem {
47 osg::ref_ptr<osg::Group> scene_graph;
48 osg::ref_ptr<osg::Group> terrain_branch;
49 osg::ref_ptr<osg::Group> models_branch;
50 osg::ref_ptr<osg::Group> aircraft_branch;
57 // Implementation of SGSubsystem.
61 void update (double dt);
63 /// Compute the elevation of the scenery at geodetic latitude lat,
64 /// geodetic longitude lon and not higher than max_alt.
65 /// If the exact flag is set to true, the scenery center is moved to
66 /// gain a higher accuracy of that query. The center is restored past
67 /// that to the original value.
68 /// The altitude hit is returned in the alt argument.
69 /// The method returns true if the scenery is available for the given
70 /// lat/lon pair. If there is no scenery for that point, the altitude
71 /// value is undefined.
72 /// All values are meant to be in meters or degrees.
73 bool get_elevation_m(const SGGeod& geod, double& alt,
74 const SGMaterial** material,
75 const osg::Node* butNotFrom = 0);
77 /// Compute the elevation of the scenery beow the cartesian point pos.
78 /// you the returned scenery altitude is not higher than the position
79 /// pos plus an ofset given with max_altoff.
80 /// If the exact flag is set to true, the scenery center is moved to
81 /// gain a higher accuracy of that query. The center is restored past
82 /// that to the original value.
83 /// The altitude hit is returned in the alt argument.
84 /// The method returns true if the scenery is available for the given
85 /// lat/lon pair. If there is no scenery for that point, the altitude
86 /// value is undefined.
87 /// All values are meant to be in meters.
88 bool get_cart_elevation_m(const SGVec3d& pos, double max_altoff,
89 double& elevation, const SGMaterial** material,
90 const osg::Node* butNotFrom = 0);
92 /// Compute the nearest intersection point of the line starting from
93 /// start going in direction dir with the terrain.
94 /// The input and output values should be in cartesian coordinates in the
95 /// usual earth centered wgs84 coordiante system. Units are meters.
96 /// On success, true is returned.
97 bool get_cart_ground_intersection(const SGVec3d& start, const SGVec3d& dir,
99 const osg::Node* butNotFrom = 0);
101 osg::Group *get_scene_graph () const { return scene_graph.get(); }
102 osg::Group *get_terrain_branch () const { return terrain_branch.get(); }
103 osg::Group *get_models_branch () const { return models_branch.get(); }
104 osg::Group *get_aircraft_branch () const { return aircraft_branch.get(); }
106 /// Returns true if scenery is avaliable for the given lat, lon position
107 /// within a range of range_m.
108 /// lat and lon are expected to be in degrees.
109 bool scenery_available(const SGGeod& position, double range_m);
111 // Static because access to the pager is needed before the rest of
112 // the scenery is initialized.
113 static flightgear::SceneryPager* getPagerSingleton();
117 #endif // _SCENERY_HXX