src/Scenery/scenery.hxx

   1 // scenery.hxx -- data structures and routines for managing scenery.
   2 //
   3 // Written by Curtis Olson, started May 1997.
   4 //
   5 // Copyright (C) 1997  Curtis L. Olson  - http://www.flightgear.org/~curt
   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
  24 #ifndef _SCENERY_HXX
  25 #define _SCENERY_HXX
  26
  27
  28 #ifndef __cplusplus
  29 # error This library requires C++
  30 #endif
  31
  32 #include <list>
  33
  34 #include <plib/sg.h>
  35
  36 #include <simgear/compiler.h>
  37 #include <simgear/structure/subsystem_mgr.hxx>
  38 #include <simgear/math/point3d.hxx>
  39 #include <simgear/scene/model/placementtrans.hxx>
  40 #include <simgear/structure/ssgSharedPtr.hxx>
  41
  42 SG_USING_STD(list);
  43
  44 class ssgRoot;
  45 class ssgBranch;
  46
  47
  48 // Define a structure containing global scenery parameters
  49 class FGScenery : public SGSubsystem {
  50     // center of current scenery chunk
  51     Point3D center;
  52
  53     // next center of current scenery chunk
  54     Point3D next_center;
  55
  56     // FIXME this should be a views property
  57     // angle of sun relative to current local horizontal
  58     double sun_angle;
  59
  60     // SSG scene graph
  61     ssgSharedPtr<ssgRoot> scene_graph;
  62     ssgSharedPtr<ssgBranch> terrain_branch;
  63     ssgSharedPtr<ssgRoot> gnd_lights_root;
  64     ssgSharedPtr<ssgRoot> vasi_lights_root;
  65     ssgSharedPtr<ssgRoot> rwy_lights_root;
  66     ssgSharedPtr<ssgRoot> taxi_lights_root;
  67     ssgSharedPtr<ssgBranch> models_branch;
  68     ssgSharedPtr<ssgBranch> aircraft_branch;
  69
  70     // list of all placement transform, used to move the scenery center on the fly.
  71     typedef list<ssgSharedPtr<ssgPlacementTransform> > placement_list_type;
  72     placement_list_type _placement_list;
  73
  74 public:
  75
  76     FGScenery();
  77     ~FGScenery();
  78
  79     // Implementation of SGSubsystem.
  80     void init ();
  81     void bind ();
  82     void unbind ();
  83     void update (double dt);
  84
  85     /// Compute the elevation of the scenery at geodetic latitude lat,
  86     /// geodetic longitude lon and not higher than max_alt.
  87     /// If the exact flag is set to true, the scenery center is moved to
  88     /// gain a higher accuracy of that query. The center is restored past
  89     /// that to the original value.
  90     /// The altitude hit is returned in the alt argument.
  91     /// The method returns true if the scenery is available for the given
  92     /// lat/lon pair. If there is no scenery for that point, the altitude
  93     /// value is undefined.
  94     /// All values are meant to be in meters or degrees.
  95     bool get_elevation_m(double lat, double lon, double max_alt,
  96                          double& alt, bool exact = false);
  97     bool get_material_m(double lat, double lon, double max_alt,
  98                         double& alt, string & material, bool exact = false);
  99
 100     /// Compute the elevation of the scenery beow the cartesian point pos.
 101     /// you the returned scenery altitude is not higher than the position
 102     /// pos plus an ofset given with max_altoff.
 103     /// If the exact flag is set to true, the scenery center is moved to
 104     /// gain a higher accuracy of that query. The center is restored past
 105     /// that to the original value.
 106     /// The altitude hit is returned in the alt argument.
 107     /// The method returns true if the scenery is available for the given
 108     /// lat/lon pair. If there is no scenery for that point, the altitude
 109     /// value is undefined.
 110     /// All values are meant to be in meters.
 111     bool get_cart_elevation_m(const sgdVec3& pos, double max_altoff,
 112                               double& radius, bool exact = false);
 113     bool get_cart_material_m(const sgdVec3& pos, double max_altoff,
 114                              double& radius, string& material, bool exact = false);
 115
 116     /// Compute the nearest intersection point of the line starting from
 117     /// start going in direction dir with the terrain.
 118     /// The input and output values should be in cartesian coordinates in the
 119     /// usual earth centered wgs84 coordiante system. Units are meters.
 120     /// On success, true is returned.
 121     bool get_cart_ground_intersection(const sgdVec3& start, const sgdVec3& dir,
 122                                       sgdVec3& nearestHit, bool exact = false);
 123
 124     inline const Point3D& get_center() const { return center; }
 125     void set_center( const Point3D& p );
 126
 127     inline const Point3D& get_next_center() const { return next_center; }
 128     inline void set_next_center( const Point3D& p ) { next_center = p; }
 129
 130     inline ssgRoot *get_scene_graph () const { return scene_graph; }
 131     inline void set_scene_graph (ssgRoot * s) { scene_graph = s; }
 132
 133     inline ssgBranch *get_terrain_branch () const { return terrain_branch; }
 134     inline void set_terrain_branch (ssgBranch * t) { terrain_branch = t; }
 135
 136     inline ssgRoot *get_gnd_lights_root () const {
 137         return gnd_lights_root;
 138     }
 139     inline void set_gnd_lights_root (ssgRoot *r) {
 140         gnd_lights_root = r;
 141     }
 142
 143     inline ssgRoot *get_vasi_lights_root () const {
 144         return vasi_lights_root;
 145     }
 146     inline void set_vasi_lights_root (ssgRoot *r) {
 147         vasi_lights_root = r;
 148     }
 149
 150     inline ssgRoot *get_rwy_lights_root () const {
 151         return rwy_lights_root;
 152     }
 153     inline void set_rwy_lights_root (ssgRoot *r) {
 154         rwy_lights_root = r;
 155     }
 156
 157     inline ssgRoot *get_taxi_lights_root () const {
 158         return taxi_lights_root;
 159     }
 160     inline void set_taxi_lights_root (ssgRoot *r) {
 161         taxi_lights_root = r;
 162     }
 163
 164     inline ssgBranch *get_models_branch () const {
 165         return models_branch;
 166     }
 167     inline void set_models_branch (ssgBranch *t) {
 168         models_branch = t;
 169     }
 170
 171     inline ssgBranch *get_aircraft_branch () const {
 172         return aircraft_branch;
 173     }
 174     inline void set_aircraft_branch (ssgBranch *t) {
 175         aircraft_branch = t;
 176     }
 177
 178     void register_placement_transform(ssgPlacementTransform *trans);
 179     void unregister_placement_transform(ssgPlacementTransform *trans);
 180 };
 181
 182
 183 #endif // _SCENERY_HXX
 184
 185