]> git.mxchange.org Git - flightgear.git/blob - src/Scenery/tileentry.hxx
Multiplayer client/server system -- Message base class, "hello" message, and message...
[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  - 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 #include <simgear/compiler.h>
37
38 #include <vector>
39 #include STL_STRING
40
41 #include <plib/ssg.h>           // plib includes
42
43 #include <simgear/bucket/newbucket.hxx>
44 #include <simgear/math/point3d.hxx>
45 #include <simgear/misc/sg_path.hxx>
46
47 #if defined( sgi )
48 #include <strings.h>
49 #endif
50
51 SG_USING_STD(string);
52 SG_USING_STD(vector);
53
54
55 typedef vector < Point3D > point_list;
56 typedef point_list::iterator point_list_iterator;
57 typedef point_list::const_iterator const_point_list_iterator;
58
59 class FGTileEntry;
60
61
62 /**
63  * A class to hold deferred model loading info
64  */
65 class FGDeferredModel {
66
67 private:
68
69     string model_path;
70     string texture_path;
71     FGTileEntry *tile;
72     ssgTransform *obj_trans;
73
74 public:
75
76     inline FGDeferredModel() { }
77     inline FGDeferredModel( const string mp, const string tp,
78                      FGTileEntry *t, ssgTransform *ot )
79     {
80         model_path = mp;
81         texture_path = tp;
82         tile = t;
83         obj_trans = ot;
84     }
85     inline ~FGDeferredModel() { }
86     inline string get_model_path() const { return model_path; }
87     inline string get_texture_path() const { return texture_path; }
88     inline FGTileEntry *get_tile() const { return tile; }
89     inline ssgTransform *get_obj_trans() const { return obj_trans; }
90 };
91
92
93 /**
94  * A class to encapsulate everything we need to know about a scenery tile.
95  */
96 class FGTileEntry {
97
98 public:
99
100     // global tile culling data
101     Point3D center;
102     double bounding_radius;
103     Point3D offset;
104
105     // this tile's official location in the world
106     SGBucket tile_bucket;
107
108 private:
109
110     // ssg tree structure for this tile is as follows:
111     // ssgRoot(scene)
112     //     - ssgBranch(terrain)
113     //        - ssgTransform(tile)
114     //           - ssgRangeSelector(tile)
115     //              - ssgEntity(tile)
116     //                 - kid1(fan)
117     //                 - kid2(fan)
118     //                   ...
119     //                 - kidn(fan)
120
121     // pointer to ssg transform for this tile
122     ssgTransform *terra_transform;
123     ssgTransform *vasi_lights_transform;
124     ssgTransform *rwy_lights_transform;
125     ssgTransform *taxi_lights_transform;
126     ssgTransform *gnd_lights_transform;
127
128     // pointer to ssg range selector for this tile
129     ssgRangeSelector *terra_range;
130     ssgRangeSelector *gnd_lights_range;
131
132     // we create several preset brightness and can choose which one we
133     // want based on lighting conditions.
134     ssgSelector *gnd_lights_brightness;
135
136     // we need to be able to turn runway lights on or off (doing this
137     // via a call back would be nifty, but then the call back needs to
138     // know about the higher level application's global state which is
139     // a problem if we move the code into simgear.)
140     ssgSelector *vasi_lights_selector;
141     ssgSelector *rwy_lights_selector;
142     ssgSelector *taxi_lights_selector;
143
144     /**
145      * Indicates this tile has been loaded from a file and connected
146      * into the scene graph.  Note that this may be set asynchronously
147      * by another thread.
148      */
149     volatile bool loaded;
150
151     /**
152      * Count of pending models to load for this tile.  This tile
153      * cannot be removed until this number reaches zero (i.e. no
154      * pending models to load for this tile.)
155      */
156     volatile int pending_models;
157
158     bool obj_load( const string& path,
159                    ssgBranch* geometry,
160                    ssgBranch* vasi_lights,
161                    ssgBranch* rwy_lights,
162                    ssgBranch* taxi_lights,
163                    ssgVertexArray* gound_lights,
164                    bool is_base );
165
166     ssgLeaf* gen_lights( SGMaterialLib *matlib, ssgVertexArray *lights,
167                          int inc, float bright );
168
169     double timestamp;
170
171
172     // this variable tracks the status of the incremental memory freeing.
173     enum {
174         NODES = 0x01,
175         VEC_PTRS = 0x02,
176         TERRA_NODE = 0x04,
177         GROUND_LIGHTS = 0x08,
178         VASI_LIGHTS = 0x10,
179         RWY_LIGHTS = 0x20,
180         TAXI_LIGHTS = 0x40,
181         LIGHTMAPS = 0x80
182     };
183     int free_tracker;
184
185 public:
186
187     // Constructor
188     FGTileEntry( const SGBucket& b );
189
190     // Destructor
191     ~FGTileEntry();
192
193     // Clean up the memory used by this tile and delete the arrays
194     // used by ssg as well as the whole ssg branch.  This does a
195     // partial clean up and exits so we can spread the load across
196     // multiple frames.  Returns false if work remaining to be done,
197     // true if dynamically allocated memory used by this tile is
198     // completely freed.
199     bool free_tile();
200
201     // Calculate this tile's offset
202     void SetOffset( const Point3D& p)
203     {
204         offset = center - p;
205     }
206
207     // Return this tile's offset
208     inline Point3D get_offset() const { return offset; }
209
210     // Update the ssg transform node for this tile so it can be
211     // properly drawn relative to our (0,0,0) point
212     void prep_ssg_node( const Point3D& p, sgVec3 up, float vis);
213
214     /**
215      * Load tile data from a file.
216      * @param base name of directory containing tile data file.
217      * @param is_base is this a base terrain object for which we should generate
218      *        random ground light points */
219     void load( const string &base_path, bool is_base );
220
221     /**
222      * Return true if the tile entry is loaded, otherwise return false
223      * indicating that the loading thread is still working on this.
224      */
225     inline bool is_loaded() const { return loaded; }
226
227     /**
228      * decrement the pending models count
229      */
230     inline void dec_pending_models() { pending_models--; }
231
232     /**
233      * return the number of remaining pending models for this tile
234      */
235     inline int get_pending_models() const { return pending_models; }
236
237     /**
238      * Return the "bucket" for this tile
239      */
240     inline SGBucket get_tile_bucket() const { return tile_bucket; }
241
242     /**
243      * Add terrain mesh and ground lighting to scene graph.
244      */
245     void add_ssg_nodes( ssgBranch *terrain_branch,
246                         ssgBranch *gnd_lights_branch,
247                         ssgBranch *vasi_lights_branch,
248                         ssgBranch *rwy_lights_branch,
249                         ssgBranch *taxi_lights_branch );
250
251     /**
252      * disconnect terrain mesh and ground lighting nodes from scene
253      * graph for this tile.
254      */
255     void disconnect_ssg_nodes();
256
257         
258     /**
259      * return the SSG Transform node for the terrain
260      */
261     inline ssgTransform *get_terra_transform() { return terra_transform; }
262
263     void set_timestamp(double time_ms) { timestamp = time_ms; }
264
265     inline double get_timestamp() const { return timestamp; }
266
267 };
268
269
270 #endif // _TILEENTRY_HXX