1 // tileentry.hxx -- routines to handle an individual scenery tile
3 // Written by Curtis Olson, started May 1998.
5 // Copyright (C) 1998, 1999 Curtis L. Olson - curt@flightgear.org
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.
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.
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.
24 #ifndef _TILEENTRY_HXX
25 #define _TILEENTRY_HXX
29 # error This library requires C++
43 #include <simgear/compiler.h>
48 #include <plib/ssg.h> // plib includes
50 #include <simgear/bucket/newbucket.hxx>
51 #include <simgear/math/point3d.hxx>
61 typedef vector < Point3D > point_list;
62 typedef point_list::iterator point_list_iterator;
63 typedef point_list::const_iterator const_point_list_iterator;
67 * A class to encapsulate everything we need to know about a scenery tile.
73 typedef vector < sgVec3 * > free_vec3_list;
74 typedef vector < sgVec2 * > free_vec2_list;
75 typedef vector < unsigned short * > free_index_list;
81 // global tile culling data
83 double bounding_radius;
86 // this tile's official location in the world
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;
97 // ssg tree structure for this tile is as follows:
99 // - ssgBranch(terrain)
100 // - ssgTransform(tile)
101 // - ssgRangeSelector(tile)
108 // pointer to ssg transform for this tile
109 ssgTransform *terra_transform;
110 ssgTransform *lights_transform;
112 // pointer to ssg range selector for this tile
113 ssgRangeSelector *terra_range;
114 ssgRangeSelector *lights_range;
116 // we create several preset brightness and can choose which one we
117 // want based on lighting conditions.
118 ssgSelector *lights_brightness;
121 * Indicates this tile has been loaded from a file and connected
122 * into the scene graph. Note that this may be set asynchronously
125 volatile bool loaded;
127 ssgBranch* obj_load( const std::string& path,
128 ssgVertexArray* lights, bool is_base );
130 ssgLeaf* gen_lights( ssgVertexArray *lights, int inc, float bright );
135 FGTileEntry( const SGBucket& b );
140 // Clean up the memory used by this tile and delete the arrays
141 // used by ssg as well as the whole ssg branch
144 // Calculate this tile's offset
145 void SetOffset( const Point3D& p)
150 // Return this tile's offset
151 inline Point3D get_offset() const { return offset; }
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);
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
163 void load( const SGPath& base, bool is_base );
166 * Return true if the tile entry is loaded, otherwise return false
167 * indicating that the loading thread is still working on this.
169 inline bool is_loaded() const { return loaded; }
172 * Return the "bucket" for this tile
174 inline SGBucket get_tile_bucket() const { return tile_bucket; }
177 * Add terrain mesh and ground lighting to scene graph.
179 void add_ssg_nodes( ssgBranch* terrain, ssgBranch* ground );
183 #endif // _TILEENTRY_HXX