Force 32 bits depth on .ico - only for Windows
[fg:hoorays-flightgear.git] / 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  - http://www.flightgear.org/~curt
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., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, 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 #include <simgear/compiler.h>
33
34 #include <vector>
35 #include <string>
36
37 #include <simgear/bucket/newbucket.hxx>
38 #include <simgear/misc/sg_path.hxx>
39
40 #include <osg/ref_ptr>
41 #include <osgDB/ReaderWriter>
42 #include <osg/Group>
43 #include <osg/LOD>
44
45 /**
46  * A class to encapsulate everything we need to know about a scenery tile.
47  */
48 class TileEntry {
49
50 public:
51     // this tile's official location in the world
52     SGBucket tile_bucket;
53     std::string tileFileName;
54
55 private:
56
57     // pointer to ssg range selector for this tile
58     osg::ref_ptr<osg::LOD> _node;
59     // Reference to DatabaseRequest object set and used by the
60     // osgDB::DatabasePager.
61     osg::ref_ptr<osg::Referenced> _databaseRequest;
62
63     /**
64      * This value is used by the tile scheduler/loader to load tiles
65      * in a useful sequence. The priority is set to reflect the tiles
66      * distance from the center, so all tiles are loaded in an innermost
67      * to outermost sequence.
68      */
69     float _priority;
70     /** Flag indicating if tile belongs to current view. */ 
71     bool _current_view;
72     /** Time when tile expires. */ 
73     double _time_expired;
74
75 public:
76
77     // Constructor
78     TileEntry( const SGBucket& b );
79     TileEntry( const TileEntry& t );
80
81     // Destructor
82     ~TileEntry();
83
84     // Update the ssg transform node for this tile so it can be
85     // properly drawn relative to our (0,0,0) point
86     void prep_ssg_node(float vis);
87
88     /**
89      * Transition to OSG database pager
90      */
91     static osg::Node* loadTileByFileName(const std::string& index_str,
92                                          const osgDB::Options*);
93     /**
94      * Return true if the tile entry is loaded, otherwise return false
95      * indicating that the loading thread is still working on this.
96      */
97     inline bool is_loaded() const
98     {
99         return _node->getNumChildren() > 0;
100     }
101
102     /**
103      * Return the "bucket" for this tile
104      */
105     inline const SGBucket& get_tile_bucket() const { return tile_bucket; }
106
107     /**
108      * Add terrain mesh and ground lighting to scene graph.
109      */
110     void addToSceneGraph( osg::Group *terrain_branch);
111
112     /**
113      * disconnect terrain mesh and ground lighting nodes from scene
114      * graph for this tile.
115      */
116     void removeFromSceneGraph();
117
118     /**
119      * return the scenegraph node for the terrain
120      */
121     osg::LOD *getNode() const { return _node.get(); }
122
123     inline double get_time_expired() const { return _time_expired; }
124     inline void update_time_expired( double time_expired ) { if (_time_expired<time_expired) _time_expired = time_expired; }
125
126     inline void set_priority(float priority) { _priority=priority; }
127     inline float get_priority() const { return _priority; }
128     inline void set_current_view(bool current_view) { _current_view = current_view; }
129     inline bool is_current_view() const { return _current_view; }
130
131     /**
132      * Return true if the tile entry is still needed, otherwise return false
133      * indicating that the tile is no longer in active use.
134      */
135     inline bool is_expired(double current_time) const { return (_current_view) ? false : (current_time > _time_expired); }
136
137     // Get the ref_ptr to the DatabaseRequest object, in order to pass
138     // this to the pager.
139     osg::ref_ptr<osg::Referenced>& getDatabaseRequest()
140     {
141         return _databaseRequest;
142     }
143 };
144
145 #endif // _TILEENTRY_HXX