src/Scenery/tileentry.hxx

   1 // tileentry.hxx -- routines to handle an individual scenery tile
   2 //
   3 // Written by Curtis Olson, started May 1998.
   4 //
   5 // Copyright (C) 1998 - 2001  Curtis L. Olson  - curt@flightgear.org
   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., 675 Mass Ave, Cambridge, MA 02139, USA.
  20 //
  21 // $Id$
  22
  23
  24 #ifndef _TILEENTRY_HXX
  25 #define _TILEENTRY_HXX
  26
  27
  28 #ifndef __cplusplus
  29 # error This library requires C++
  30 #endif
  31
  32 #ifdef HAVE_CONFIG_H
  33 #  include <config.h>
  34 #endif
  35
  36 #ifdef HAVE_WINDOWS_H
  37 #  include <windows.h>
  38 #endif
  39
  40 #include <GL/glut.h>
  41 #include <GL/gl.h>
  42
  43 #include <simgear/compiler.h>
  44
  45 #include <vector>
  46 #include STL_STRING
  47
  48 #include <plib/ssg.h>           // plib includes
  49
  50 #include <simgear/bucket/newbucket.hxx>
  51 #include <simgear/math/point3d.hxx>
  52 #include <simgear/misc/sg_path.hxx>
  53
  54 #if defined( sgi )
  55 #include <strings.h>
  56 #endif
  57
  58 SG_USING_STD(string);
  59 SG_USING_STD(vector);
  60
  61
  62 typedef vector < Point3D > point_list;
  63 typedef point_list::iterator point_list_iterator;
  64 typedef point_list::const_iterator const_point_list_iterator;
  65
  66 class FGTileEntry;
  67
  68
  69 /**
  70  * A class to hold deferred model loading info
  71  */
  72 class FGDeferredModel {
  73
  74 private:
  75
  76     string model_path;
  77     string texture_path;
  78     FGTileEntry *tile;
  79     ssgTransform *obj_trans;
  80
  81 public:
  82
  83     inline FGDeferredModel() { }
  84     inline FGDeferredModel( const string mp, const string tp,
  85                      FGTileEntry *t, ssgTransform *ot )
  86     {
  87         model_path = mp;
  88         texture_path = tp;
  89         tile = t;
  90         obj_trans = ot;
  91     }
  92     inline ~FGDeferredModel() { }
  93     inline string get_model_path() const { return model_path; }
  94     inline string get_texture_path() const { return texture_path; }
  95     inline FGTileEntry *get_tile() const { return tile; }
  96     inline ssgTransform *get_obj_trans() const { return obj_trans; }
  97 };
  98
  99
 100 /**
 101  * A class to encapsulate everything we need to know about a scenery tile.
 102  */
 103 class FGTileEntry {
 104
 105 public:
 106
 107     typedef vector < sgVec3 * > free_vec3_list;
 108     typedef vector < sgVec2 * > free_vec2_list;
 109     typedef vector < unsigned short * > free_index_list;
 110
 111     // node list
 112     point_list nodes;
 113     int ncount;
 114
 115     // global tile culling data
 116     Point3D center;
 117     double bounding_radius;
 118     Point3D offset;
 119
 120     // this tile's official location in the world
 121     SGBucket tile_bucket;
 122
 123     // list of pointers to memory chunks that need to be freed when
 124     // tile entry goes away
 125     free_vec3_list vec3_ptrs;
 126     free_vec2_list vec2_ptrs;
 127     free_index_list index_ptrs;
 128
 129 private:
 130
 131     // ssg tree structure for this tile is as follows:
 132     // ssgRoot(scene)
 133     //     - ssgBranch(terrain)
 134     //        - ssgTransform(tile)
 135     //           - ssgRangeSelector(tile)
 136     //              - ssgEntity(tile)
 137     //                 - kid1(fan)
 138     //                 - kid2(fan)
 139     //                   ...
 140     //                 - kidn(fan)
 141
 142     // pointer to ssg transform for this tile
 143     ssgTransform *terra_transform;
 144     ssgTransform *lights_transform;
 145
 146     // pointer to ssg range selector for this tile
 147     ssgRangeSelector *terra_range;
 148     ssgRangeSelector *lights_range;
 149
 150     // we create several preset brightness and can choose which one we
 151     // want based on lighting conditions.
 152     ssgSelector *lights_brightness;
 153
 154     // ADA --->
 155     // Runway centre coords.
 156     Point3D rway_center; // Reqd. for switching as function of distance from runway center
 157     //pointers for Runway lights
 158     ssgTransform *lightmaps_transform; // branch for runway lights
 159     ssgRangeSelector *lightmaps_range; // tried to maintain same structure as Curt's ground
 160     ssgSelector *lightmaps_brightness; // selector node for points/ lightmaps
 161
 162     ssgSimpleState *lightmap_state; // OpenGL state of the polygons that make up runway lights
 163     ssgVertexArray *light_points; // array of runway light coords.
 164     // <--- ADA
 165
 166     /**
 167      * Indicates this tile has been loaded from a file and connected
 168      * into the scene graph.  Note that this may be set asynchronously
 169      * by another thread.
 170      */
 171     volatile bool loaded;
 172
 173     /**
 174      * Count of pending models to load for this tile.  This tile
 175      * cannot be removed until this number reaches zero (i.e. no
 176      * pending models to load for this tile.)
 177      */
 178     volatile int pending_models;
 179
 180     ssgBranch* obj_load( const std::string& path,
 181                          ssgVertexArray* lights, bool is_base );
 182
 183     ssgLeaf* gen_lights( ssgVertexArray *lights, int inc, float bright );
 184
 185 public:
 186
 187     // ADA --->
 188     ssgTransform *ols_transform; // transform node for flols simulation
 189     ssgSelector *lightmaps_sequence; // selector node for points/ lightmaps
 190     ssgBranch* gen_runway_lights(ssgVertexArray *points,ssgVertexArray *normal, ssgVertexArray *dir, int *type);
 191     // <--- ADA
 192
 193     // Constructor
 194     FGTileEntry( const SGBucket& b );
 195
 196     // Destructor
 197     ~FGTileEntry();
 198
 199 #ifdef WISH_PLIB_WAS_THREADED // but it isn't
 200     // Schedule tile to be freed/removed
 201     void sched_removal();
 202 #endif
 203
 204     // Clean up the memory used by this tile and delete the arrays
 205     // used by ssg as well as the whole ssg branch
 206     void free_tile();
 207
 208     // Calculate this tile's offset
 209     void SetOffset( const Point3D& p)
 210     {
 211         offset = center - p;
 212     }
 213
 214     // Return this tile's offset
 215     inline Point3D get_offset() const { return offset; }
 216
 217     // Update the ssg transform node for this tile so it can be
 218     // properly drawn relative to our (0,0,0) point
 219     void prep_ssg_node( const Point3D& p, float vis);
 220
 221     /**
 222      * Load tile data from a file.
 223      * @param base name of directory containing tile data file.
 224      * @param is_base is this a base terrain object for which we should generate
 225      *        random ground light points */
 226     void load( const SGPath& base, bool is_base );
 227
 228     /**
 229      * Return true if the tile entry is loaded, otherwise return false
 230      * indicating that the loading thread is still working on this.
 231      */
 232     inline bool is_loaded() const { return loaded; }
 233
 234     /**
 235      * decrement the pending models count
 236      */
 237     inline void dec_pending_models() { pending_models--; }
 238
 239     /**
 240      * return the number of remaining pending models for this tile
 241      */
 242     inline int get_pending_models() const { return pending_models; }
 243
 244     /**
 245      * Return the "bucket" for this tile
 246      */
 247     inline SGBucket get_tile_bucket() const { return tile_bucket; }
 248
 249     /**
 250      * Add terrain mesh and ground lighting to scene graph.
 251      */
 252     void add_ssg_nodes( ssgBranch* terrain, ssgBranch* ground );
 253
 254     /**
 255      * disconnect terrain mesh and ground lighting nodes from scene
 256      * graph for this tile.
 257      */
 258     void disconnect_ssg_nodes();
 259 };
 260
 261
 262 #endif // _TILEENTRY_HXX