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     /* CLO123 FROM HERE TO THE CORRESPONDING MARKER ARE THINGS THAT
 108        CAN BE DELETED AFTER WE DROP THE ASCII SCENERY FORMAT */
 109     typedef vector < sgVec3 * > free_vec3_list;
 110     typedef vector < sgVec2 * > free_vec2_list;
 111     typedef vector < unsigned short * > free_index_list;
 112
 113     // node list
 114     point_list nodes;
 115     int ncount;
 116     /* CLO123 MARKER */
 117
 118     // global tile culling data
 119     Point3D center;
 120     double bounding_radius;
 121     Point3D offset;
 122
 123     // this tile's official location in the world
 124     SGBucket tile_bucket;
 125
 126     // list of pointers to memory chunks that need to be freed when
 127     // tile entry goes away
 128     free_vec3_list vec3_ptrs;
 129     free_vec2_list vec2_ptrs;
 130     free_index_list index_ptrs;
 131
 132 private:
 133
 134     // ssg tree structure for this tile is as follows:
 135     // ssgRoot(scene)
 136     //     - ssgBranch(terrain)
 137     //        - ssgTransform(tile)
 138     //           - ssgRangeSelector(tile)
 139     //              - ssgEntity(tile)
 140     //                 - kid1(fan)
 141     //                 - kid2(fan)
 142     //                   ...
 143     //                 - kidn(fan)
 144
 145     // pointer to ssg transform for this tile
 146     ssgTransform *terra_transform;
 147     ssgTransform *rwy_lights_transform;
 148     ssgTransform *gnd_lights_transform;
 149
 150     // pointer to ssg range selector for this tile
 151     ssgRangeSelector *terra_range;
 152     ssgRangeSelector *gnd_lights_range;
 153
 154     // we create several preset brightness and can choose which one we
 155     // want based on lighting conditions.
 156     ssgSelector *gnd_lights_brightness;
 157
 158     // ADA --->
 159     // Runway centre coords.
 160     Point3D rway_center; // Reqd. for switching as function of distance from runway center
 161     //pointers for Runway lights
 162     ssgTransform *lightmaps_transform; // branch for runway lights
 163     ssgRangeSelector *lightmaps_range; // tried to maintain same structure as Curt's ground
 164     ssgSelector *lightmaps_brightness; // selector node for points/ lightmaps
 165
 166     ssgSimpleState *lightmap_state; // OpenGL state of the polygons that make up runway lights
 167     ssgVertexArray *light_points; // array of runway light coords.
 168     // <--- ADA
 169
 170     /**
 171      * Indicates this tile has been loaded from a file and connected
 172      * into the scene graph.  Note that this may be set asynchronously
 173      * by another thread.
 174      */
 175     volatile bool loaded;
 176
 177     /**
 178      * Count of pending models to load for this tile.  This tile
 179      * cannot be removed until this number reaches zero (i.e. no
 180      * pending models to load for this tile.)
 181      */
 182     volatile int pending_models;
 183
 184     bool obj_load( const std::string& path,
 185                          ssgBranch* geometry,
 186                          ssgBranch* rwy_lights,
 187                          ssgVertexArray* gound_lights,
 188                          bool is_base );
 189
 190     ssgLeaf* gen_lights( ssgVertexArray *lights, int inc, float bright );
 191
 192     double timestamp;
 193
 194
 195     // this variable tracks the status of the incremental memory freeing.
 196     enum {
 197         NODES = 0x01,
 198         VEC_PTRS = 0x02,
 199         TERRA_NODE = 0x04,
 200         GROUND_LIGHTS = 0x08,
 201         RWY_LIGHTS = 0x10,
 202         LIGHTMAPS = 0x20
 203     };
 204     int free_tracker;
 205
 206 public:
 207
 208     // ADA --->
 209     ssgTransform *ols_transform; // transform node for flols simulation
 210     ssgSelector *lightmaps_sequence; // selector node for points/ lightmaps
 211     ssgBranch* gen_runway_lights(ssgVertexArray *points,ssgVertexArray *normal, ssgVertexArray *dir, int *type);
 212     // <--- ADA
 213
 214     // Constructor
 215     FGTileEntry( const SGBucket& b );
 216
 217     // Destructor
 218     ~FGTileEntry();
 219
 220     // Clean up the memory used by this tile and delete the arrays
 221     // used by ssg as well as the whole ssg branch.  This does a
 222     // partial clean up and exits so we can spread the load across
 223     // multiple frames.  Returns false if work remaining to be done,
 224     // true if dynamically allocated memory used by this tile is
 225     // completely freed.
 226     bool free_tile();
 227
 228     // Calculate this tile's offset
 229     void SetOffset( const Point3D& p)
 230     {
 231         offset = center - p;
 232     }
 233
 234     // Return this tile's offset
 235     inline Point3D get_offset() const { return offset; }
 236
 237     // Update the ssg transform node for this tile so it can be
 238     // properly drawn relative to our (0,0,0) point
 239     void prep_ssg_node( const Point3D& p, sgVec3 up, float vis);
 240
 241     /**
 242      * Load tile data from a file.
 243      * @param base name of directory containing tile data file.
 244      * @param is_base is this a base terrain object for which we should generate
 245      *        random ground light points */
 246     void load( const SGPath& base, bool is_base );
 247
 248     /**
 249      * Return true if the tile entry is loaded, otherwise return false
 250      * indicating that the loading thread is still working on this.
 251      */
 252     inline bool is_loaded() const { return loaded; }
 253
 254     /**
 255      * decrement the pending models count
 256      */
 257     inline void dec_pending_models() { pending_models--; }
 258
 259     /**
 260      * return the number of remaining pending models for this tile
 261      */
 262     inline int get_pending_models() const { return pending_models; }
 263
 264     /**
 265      * Return the "bucket" for this tile
 266      */
 267     inline SGBucket get_tile_bucket() const { return tile_bucket; }
 268
 269     /**
 270      * Add terrain mesh and ground lighting to scene graph.
 271      */
 272     void add_ssg_nodes( ssgBranch* terrain_branch,
 273                         ssgBranch* gnd_lights_branch,
 274                         ssgBranch* rwy_lights_branch );
 275
 276     /**
 277      * disconnect terrain mesh and ground lighting nodes from scene
 278      * graph for this tile.
 279      */
 280     void disconnect_ssg_nodes();
 281
 282
 283     /**
 284      * return the SSG Transform node for the terrain
 285      */
 286     inline ssgTransform *get_terra_transform() { return terra_transform; }
 287
 288     void set_timestamp(double time_ms) { timestamp = time_ms; }
 289
 290     inline double get_timestamp() const { return timestamp; }
 291
 292 };
 293
 294
 295 #endif // _TILEENTRY_HXX