1 // newcache.cxx -- routines to handle scenery tile caching
3 // Written by Curtis Olson, started December 2000.
5 // Copyright (C) 2000 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.
33 #include <simgear/xgl/xgl.h>
35 #include <plib/ssg.h> // plib include
37 #include <simgear/bucket/newbucket.hxx>
38 #include <simgear/debug/logstream.hxx>
39 #include <simgear/math/sg_geodesy.hxx>
40 #include <simgear/math/sg_random.h>
41 #include <simgear/misc/fgstream.hxx>
42 #include <simgear/misc/fgpath.hxx>
44 #include <Main/globals.hxx>
45 #include <Objects/matlib.hxx>
46 #include <Objects/newmat.hxx>
47 #include <Objects/obj.hxx>
48 #include <Scenery/scenery.hxx> // for scenery.center
50 #include "newcache.hxx"
51 #include "tileentry.hxx"
52 #include "tilemgr.hxx" // temp, need to delete later
54 FG_USING_NAMESPACE(std);
56 // a cheesy hack (to be fixed later)
57 extern ssgBranch *terrain;
58 extern ssgBranch *ground;
62 FGNewCache global_tile_cache;
66 FGNewCache::FGNewCache( void ) {
72 FGNewCache::~FGNewCache( void ) {
76 // Free a tile cache entry
77 void FGNewCache::entry_free( long cache_index ) {
78 FG_LOG( FG_TERRAIN, FG_INFO, "FREEING CACHE ENTRY = " << cache_index );
79 FGTileEntry *e = tile_cache[cache_index];
82 tile_cache.erase( cache_index );
86 // Initialize the tile cache subsystem
87 void FGNewCache::init( void ) {
88 FG_LOG( FG_TERRAIN, FG_INFO, "Initializing the tile cache." );
90 // expand cache if needed. For best results ... i.e. to avoid
91 // tile load problems and blank areas:
92 max_cache_size = 50; // a random number to start with
93 FG_LOG( FG_TERRAIN, FG_INFO, " max cache size = "
95 FG_LOG( FG_TERRAIN, FG_INFO, " current cache size = "
96 << tile_cache.size() );
98 tile_map_iterator current = tile_cache.begin();
99 tile_map_iterator end = tile_cache.end();
101 for ( ; current != end; ++current ) {
102 long index = current->first;
103 cout << "clearing " << index << endl;
104 FGTileEntry *e = current->second;
105 e->tile_bucket.make_bad();
109 // and ... just in case we missed something ...
110 terrain->removeAllKids();
112 FG_LOG( FG_TERRAIN, FG_INFO, " done with init()" );
116 // Search for the specified "bucket" in the cache
117 bool FGNewCache::exists( const FGBucket& b ) {
118 long tile_index = b.gen_index();
119 tile_map_iterator it = tile_cache.find( tile_index );
121 return ( it != tile_cache.end() );
126 static void print_refs( ssgSelector *sel, ssgTransform *trans,
127 ssgRangeSelector *range)
129 cout << "selector -> " << sel->getRef()
130 << " transform -> " << trans->getRef()
131 << " range -> " << range->getRef() << endl;
136 static ssgLeaf *gen_lights( ssgVertexArray *lights, float bright ) {
137 // Allocate ssg structure
138 ssgNormalArray *nl = NULL;
139 ssgTexCoordArray *tl = NULL;
140 ssgColourArray *cl = new ssgColourArray( 1 );
142 // default to slightly yellow lights for now
144 sgSetVec4( color, 1.0 * bright, 1.0 * bright, 0.7 * bright, 1.0 );
149 new ssgVtxTable ( GL_POINTS, lights, nl, tl, cl );
152 FGNewMat *newmat = material_lib.find( "LIGHTS" );
153 leaf->setState( newmat->get_state() );
159 // Fill in a tile cache entry with real data for the specified bucket
160 void FGNewCache::fill_in( const FGBucket& b ) {
161 FG_LOG( FG_TERRAIN, FG_INFO, "FILL IN CACHE ENTRY = " << b.gen_index() );
163 // clear out a distant entry in the cache if needed.
167 FGTileEntry *e = new FGTileEntry;
169 // register it in the cache
170 long tile_index = b.gen_index();
171 tile_cache[tile_index] = e;
173 // update the contents
174 e->center = Point3D( 0.0 );
175 if ( e->vec3_ptrs.size() || e->vec2_ptrs.size() || e->index_ptrs.size() ) {
176 FG_LOG( FG_TERRAIN, FG_ALERT,
177 "Attempting to overwrite existing or"
178 << " not properly freed leaf data." );
182 e->terra_transform = new ssgTransform;
183 e->terra_range = new ssgRangeSelector;
187 if ( globals->get_options()->get_fg_scenery() != "" ) {
188 tile_path.set( globals->get_options()->get_fg_scenery() );
190 tile_path.set( globals->get_options()->get_fg_root() );
191 tile_path.append( "Scenery" );
193 tile_path.append( b.gen_base_path() );
195 // fgObjLoad will generate ground lighting for us ...
196 ssgVertexArray *light_pts = new ssgVertexArray( 100 );
198 // Load the appropriate data file
199 FGPath tile_base = tile_path;
200 tile_base.append( b.gen_index_str() );
201 ssgBranch *new_tile = fgObjLoad( tile_base.str(), e, light_pts, true );
203 if ( new_tile != NULL ) {
204 e->terra_range->addKid( new_tile );
207 // load custom objects
208 cout << "CUSTOM OBJECTS" << endl;
210 FGPath index_path = tile_path;
211 index_path.append( b.gen_index_str() );
212 index_path.concat( ".ind" );
214 cout << "Looking in " << index_path.str() << endl;
216 fg_gzifstream in( index_path.str() );
218 if ( in.is_open() ) {
221 while ( ! in.eof() ) {
224 #if defined ( macintosh ) || defined ( _MSC_VER )
229 cout << "token = " << token << " name = " << name << endl;
231 FGPath custom_path = tile_path;
232 custom_path.append( name );
233 ssgBranch *custom_obj =
234 fgObjLoad( custom_path.str(), e, NULL, false );
235 if ( (new_tile != NULL) && (custom_obj != NULL) ) {
236 new_tile -> addKid( custom_obj );
241 e->terra_transform->addKid( e->terra_range );
243 // calculate initial tile offset
244 e->SetOffset( scenery.center );
246 sgSetCoord( &sgcoord,
247 e->offset.x(), e->offset.y(), e->offset.z(),
249 e->terra_transform->setTransform( &sgcoord );
250 terrain->addKid( e->terra_transform );
252 e->lights_transform = NULL;
253 e->lights_range = NULL;
254 /* uncomment this section for testing ground lights */
255 if ( light_pts->getNum() ) {
256 cout << "generating lights" << endl;
257 e->lights_transform = new ssgTransform;
258 e->lights_range = new ssgRangeSelector;
259 e->lights_brightness = new ssgSelector;
262 lights = gen_lights( light_pts, 0.6 );
263 e->lights_brightness->addKid( lights );
265 lights = gen_lights( light_pts, 0.8 );
266 e->lights_brightness->addKid( lights );
268 lights = gen_lights( light_pts, 1.0 );
269 e->lights_brightness->addKid( lights );
271 e->lights_range->addKid( e->lights_brightness );
272 e->lights_transform->addKid( e->lights_range );
273 e->lights_transform->setTransform( &sgcoord );
274 ground->addKid( e->lights_transform );
276 /* end of ground light section */
280 // Ensure at least one entry is free in the cache
281 void FGNewCache::make_space() {
282 FG_LOG( FG_TERRAIN, FG_INFO, "Make space in cache" );
285 cout << "cache size = " << tile_cache.size() << endl;
286 cout << "max size = " << max_cache_size << endl;
288 if ( (int)tile_cache.size() < max_cache_size ) {
289 // space in the cache, return
293 while ( (int)tile_cache.size() >= max_cache_size ) {
294 sgdVec3 abs_view_pos;
296 float max_dist = 0.0;
299 // we need to free the furthest entry
300 tile_map_iterator current = tile_cache.begin();
301 tile_map_iterator end = tile_cache.end();
303 for ( ; current != end; ++current ) {
304 long index = current->first;
305 FGTileEntry *e = current->second;
307 // calculate approximate distance from view point
308 sgdCopyVec3( abs_view_pos,
309 globals->get_current_view()->get_abs_view_pos() );
311 FG_LOG( FG_TERRAIN, FG_DEBUG, "DIST Abs view pos = "
312 << abs_view_pos[0] << ","
313 << abs_view_pos[1] << ","
314 << abs_view_pos[2] );
315 FG_LOG( FG_TERRAIN, FG_DEBUG,
316 " ref point = " << e->center );
319 sgdSetVec3( center, e->center.x(), e->center.y(), e->center.z() );
320 dist = sgdDistanceVec3( center, abs_view_pos );
322 FG_LOG( FG_TERRAIN, FG_DEBUG, " distance = " << dist );
324 if ( dist > max_dist ) {
330 // If we made it this far, then there were no open cache entries.
331 // We will instead free the furthest cache entry and return it's
334 if ( max_index >= 0 ) {
335 FG_LOG( FG_TERRAIN, FG_DEBUG, " max_dist = " << max_dist );
336 FG_LOG( FG_TERRAIN, FG_DEBUG, " index = " << max_index );
337 entry_free( max_index );
339 FG_LOG( FG_TERRAIN, FG_ALERT, "WHOOPS!!! Dying in next_avail()" );