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, 1999  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 <simgear/xgl/xgl.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
  53 #if defined( sgi )
  54 #include <strings.h>
  55 #endif
  56
  57 SG_USING_STD(string);
  58 SG_USING_STD(vector);
  59
  60
  61 typedef vector < Point3D > point_list;
  62 typedef point_list::iterator point_list_iterator;
  63 typedef point_list::const_iterator const_point_list_iterator;
  64
  65
  66 /**
  67  * A class to encapsulate everything we need to know about a scenery tile.
  68  */
  69 class FGTileEntry {
  70
  71 public:
  72
  73     typedef vector < sgVec3 * > free_vec3_list;
  74     typedef vector < sgVec2 * > free_vec2_list;
  75     typedef vector < unsigned short * > free_index_list;
  76
  77     // node list
  78     point_list nodes;
  79     int ncount;
  80
  81     // global tile culling data
  82     Point3D center;
  83     double bounding_radius;
  84     Point3D offset;
  85
  86     // this tile's official location in the world
  87     SGBucket tile_bucket;
  88
  89     // list of pointers to memory chunks that need to be freed when
  90     // tile entry goes away
  91     free_vec3_list vec3_ptrs;
  92     free_vec2_list vec2_ptrs;
  93     free_index_list index_ptrs;
  94
  95 private:
  96
  97     // ssg tree structure for this tile is as follows:
  98     // ssgRoot(scene)
  99     //     - ssgBranch(terrain)
 100     //        - ssgTransform(tile)
 101     //           - ssgRangeSelector(tile)
 102     //              - ssgEntity(tile)
 103     //                 - kid1(fan)
 104     //                 - kid2(fan)
 105     //                   ...
 106     //                 - kidn(fan)
 107
 108     // pointer to ssg transform for this tile
 109     ssgTransform *terra_transform;
 110     ssgTransform *lights_transform;
 111
 112     // pointer to ssg range selector for this tile
 113     ssgRangeSelector *terra_range;
 114     ssgRangeSelector *lights_range;
 115
 116     // we create several preset brightness and can choose which one we
 117     // want based on lighting conditions.
 118     ssgSelector *lights_brightness;
 119
 120     /**
 121      * Indicates this tile has been loaded from a file and connected
 122      * into the scene graph.  Note that this may be set asynchronously
 123      * by another thread.
 124      */
 125     volatile bool loaded;
 126
 127     ssgBranch* obj_load( const std::string& path,
 128                          ssgVertexArray* lights, bool is_base );
 129
 130     ssgLeaf* gen_lights( ssgVertexArray *lights, int inc, float bright );
 131
 132 public:
 133
 134     // Constructor
 135     FGTileEntry( const SGBucket& b );
 136
 137     // Destructor
 138     ~FGTileEntry();
 139
 140     // Clean up the memory used by this tile and delete the arrays
 141     // used by ssg as well as the whole ssg branch
 142     void free_tile();
 143
 144     // Calculate this tile's offset
 145     void SetOffset( const Point3D& p)
 146     {
 147         offset = center - p;
 148     }
 149
 150     // Return this tile's offset
 151     inline Point3D get_offset() const { return offset; }
 152
 153     // Update the ssg transform node for this tile so it can be
 154     // properly drawn relative to our (0,0,0) point
 155     void prep_ssg_node( const Point3D& p, float vis);
 156
 157     /**
 158      * Load tile data from a file.
 159      * @param base name of directory containing tile data file.
 160      * @param is_base is this a base terrain object for which we should generate
 161      *        random ground light points
 162      */
 163     void load( const SGPath& base, bool is_base );
 164
 165     /**
 166      * Return true if the tile entry is loaded, otherwise return false
 167      * indicating that the loading thread is still working on this.
 168      */
 169     inline bool is_loaded() const { return loaded; }
 170
 171     /**
 172      * Return the "bucket" for this tile
 173      */
 174     inline SGBucket get_tile_bucket() const { return tile_bucket; }
 175
 176     /**
 177      * Add terrain mesh and ground lighting to scene graph.
 178      */
 179     void add_ssg_nodes( ssgBranch* terrain, ssgBranch* ground );
 180 };
 181
 182
 183 #endif // _TILEENTRY_HXX