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++
41 #include <simgear/xgl/xgl.h>
43 #include <simgear/compiler.h>
48 #include <plib/ssg.h> // plib includes
50 #include <simgear/bucket/newbucket.hxx>
51 #include <simgear/math/point3d.hxx>
53 #include <Objects/fragment.hxx>
63 typedef vector < Point3D > point_list;
64 typedef point_list::iterator point_list_iterator;
65 typedef point_list::const_iterator const_point_list_iterator;
76 Scheduled_for_use = 1,
77 Scheduled_for_cache = 2,
84 typedef vector < fgFRAGMENT > container;
85 typedef container::iterator FragmentIterator;
86 typedef container::const_iterator FragmentConstIterator;
88 typedef vector < sgVec3 * > free_vec3_list;
89 typedef vector < sgVec2 * > free_vec2_list;
90 typedef vector < unsigned short * > free_index_list;
93 // node list (the per fragment face lists reference this node list)
97 // global tile culling data
99 double bounding_radius;
102 // this tile's official location in the world
103 FGBucket tile_bucket;
105 // the tile cache will keep track here if the tile is being used
108 container fragment_list;
110 // ssg related structures
115 // list of pointers to memory chunks that need to be freed when
116 // tile entry goes away
117 free_vec3_list vec3_ptrs;
118 free_vec2_list vec2_ptrs;
119 free_index_list index_ptrs;
121 // ssg tree structure for this tile is as follows:
123 // - ssgBranch(terrain)
124 // - ssgSelector(tile)
125 // - ssgTransform(tile)
126 // - ssgRangeSelector(tile)
133 // selector (turn tile on/off)
134 ssgSelector *select_ptr;
136 // pointer to ssg transform for this tile
137 ssgTransform *transform_ptr;
139 // pointer to ssg range selector for this tile
140 ssgRangeSelector *range_ptr;
145 FGTileEntry ( void );
148 ~FGTileEntry ( void );
150 FragmentIterator begin() { return fragment_list.begin(); }
151 FragmentConstIterator begin() const { return fragment_list.begin(); }
153 FragmentIterator end() { return fragment_list.end(); }
154 FragmentConstIterator end() const { return fragment_list.end(); }
156 void add_fragment( fgFRAGMENT& frag ) {
157 frag.tile_ptr = this;
158 fragment_list.push_back( frag );
161 size_t num_fragments() const {
162 return fragment_list.size();
165 // Step through the fragment list, deleting the display list, then
166 // the fragment, until the list is empty. Also delete the arrays
167 // used by ssg as well as the whole ssg branch
170 // Calculate this tile's offset
171 void SetOffset( const Point3D& p)
176 // Return this tile's offset
177 inline Point3D get_offset( void ) const { return offset; }
179 inline bool is_unused() const { return state == Unused; }
180 inline bool is_scheduled_for_use() const {
181 return state == Scheduled_for_use;
183 inline bool is_scheduled_for_cache() const {
184 return state == Scheduled_for_cache;
186 inline bool is_loaded() const { return state == Loaded; }
187 inline bool is_cached() const { return state == Cached; }
189 inline void mark_unused() { state = Unused; }
190 inline void mark_scheduled_for_use() { state = Scheduled_for_use; }
191 inline void mark_scheduled_for_cache() { state = Scheduled_for_use; }
192 inline void mark_loaded() { state = Loaded; }
195 // when a tile is still in the cache, but not in the immediate
196 // draw l ist, it can still remain in the scene graph, but we use
197 // a range selector to disable it from ever being drawn.
202 typedef vector < FGTileEntry > tile_list;
203 typedef tile_list::iterator tile_list_iterator;
204 typedef tile_list::const_iterator const_tile_list_iterator;
207 #endif // _TILEENTRY_HXX