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 *rwy_lights_range;
 153     ssgRangeSelector *gnd_lights_range;
 154
 155     // we create several preset brightness and can choose which one we
 156     // want based on lighting conditions.
 157     ssgSelector *gnd_lights_brightness;
 158
 159     // ADA --->
 160     // Runway centre coords.
 161     Point3D rway_center; // Reqd. for switching as function of distance from runway center
 162     //pointers for Runway lights
 163     ssgTransform *lightmaps_transform; // branch for runway lights
 164     ssgRangeSelector *lightmaps_range; // tried to maintain same structure as Curt's ground
 165     ssgSelector *lightmaps_brightness; // selector node for points/ lightmaps
 166
 167     ssgSimpleState *lightmap_state; // OpenGL state of the polygons that make up runway lights
 168     ssgVertexArray *light_points; // array of runway light coords.
 169     // <--- ADA
 170
 171     /**
 172      * Indicates this tile has been loaded from a file and connected
 173      * into the scene graph.  Note that this may be set asynchronously
 174      * by another thread.
 175      */
 176     volatile bool loaded;
 177
 178     /**
 179      * Count of pending models to load for this tile.  This tile
 180      * cannot be removed until this number reaches zero (i.e. no
 181      * pending models to load for this tile.)
 182      */
 183     volatile int pending_models;
 184
 185     bool obj_load( const std::string& path,
 186                          ssgBranch* geometry,
 187                          ssgBranch* rwy_lights,
 188                          ssgVertexArray* gound_lights,
 189                          bool is_base );
 190
 191     ssgLeaf* gen_lights( ssgVertexArray *lights, int inc, float bright );
 192
 193     double timestamp;
 194
 195
 196     // this variable tracks the status of the incremental memory freeing.
 197     enum {
 198         NODES = 0x01,
 199         VEC_PTRS = 0x02,
 200         TERRA_NODE = 0x04,
 201         GROUND_LIGHTS = 0x08,
 202         RWY_LIGHTS = 0x10,
 203         LIGHTMAPS = 0x20
 204     };
 205     int free_tracker;
 206
 207 public:
 208
 209     // ADA --->
 210     ssgTransform *ols_transform; // transform node for flols simulation
 211     ssgSelector *lightmaps_sequence; // selector node for points/ lightmaps
 212     ssgBranch* gen_runway_lights(ssgVertexArray *points,ssgVertexArray *normal, ssgVertexArray *dir, int *type);
 213     // <--- ADA
 214
 215     // Constructor
 216     FGTileEntry( const SGBucket& b );
 217
 218     // Destructor
 219     ~FGTileEntry();
 220
 221     // Clean up the memory used by this tile and delete the arrays
 222     // used by ssg as well as the whole ssg branch.  This does a
 223     // partial clean up and exits so we can spread the load across
 224     // multiple frames.  Returns false if work remaining to be done,
 225     // true if dynamically allocated memory used by this tile is
 226     // completely freed.
 227     bool free_tile();
 228
 229     // Calculate this tile's offset
 230     void SetOffset( const Point3D& p)
 231     {
 232         offset = center - p;
 233     }
 234
 235     // Return this tile's offset
 236     inline Point3D get_offset() const { return offset; }
 237
 238     // Update the ssg transform node for this tile so it can be
 239     // properly drawn relative to our (0,0,0) point
 240     void prep_ssg_node( const Point3D& p, sgVec3 up, float vis);
 241
 242     /**
 243      * Load tile data from a file.
 244      * @param base name of directory containing tile data file.
 245      * @param is_base is this a base terrain object for which we should generate
 246      *        random ground light points */
 247     void load( const SGPath& base, bool is_base );
 248
 249     /**
 250      * Return true if the tile entry is loaded, otherwise return false
 251      * indicating that the loading thread is still working on this.
 252      */
 253     inline bool is_loaded() const { return loaded; }
 254
 255     /**
 256      * decrement the pending models count
 257      */
 258     inline void dec_pending_models() { pending_models--; }
 259
 260     /**
 261      * return the number of remaining pending models for this tile
 262      */
 263     inline int get_pending_models() const { return pending_models; }
 264
 265     /**
 266      * Return the "bucket" for this tile
 267      */
 268     inline SGBucket get_tile_bucket() const { return tile_bucket; }
 269
 270     /**
 271      * Add terrain mesh and ground lighting to scene graph.
 272      */
 273     void add_ssg_nodes( ssgBranch* terrain_branch,
 274                         ssgBranch* gnd_lights_branch,
 275                         ssgBranch* rwy_lights_branch );
 276
 277     /**
 278      * disconnect terrain mesh and ground lighting nodes from scene
 279      * graph for this tile.
 280      */
 281     void disconnect_ssg_nodes();
 282
 283
 284     /**
 285      * return the SSG Transform node for the terrain
 286      */
 287     inline ssgTransform *get_terra_transform() { return terra_transform; }
 288
 289     void set_timestamp(double time_ms) { timestamp = time_ms; }
 290
 291     inline double get_timestamp() const { return timestamp; }
 292
 293 };
 294
 295
 296 #endif // _TILEENTRY_HXX