]> git.mxchange.org Git - flightgear.git/blobdiff - src/Scenery/tileentry.hxx
initialize release_keys array
[flightgear.git] / src / Scenery / tileentry.hxx
index 1a80f53c7b91d5422d5150cdd54d9a160d02cb06..a296269647f08bd723d6b5994d9f85e12e89ce88 100644 (file)
@@ -2,7 +2,7 @@
 //
 // Written by Curtis Olson, started May 1998.
 //
-// Copyright (C) 1998, 1999  Curtis L. Olson  - curt@flightgear.org
+// Copyright (C) 1998 - 2001  Curtis L. Olson  - http://www.flightgear.org/~curt
 //
 // This program is free software; you can redistribute it and/or
 // modify it under the terms of the GNU General Public License as
@@ -16,7 +16,7 @@
 //
 // You should have received a copy of the GNU General Public License
 // along with this program; if not, write to the Free Software
-// Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
+// Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.
 //
 // $Id$
 
 #define _TILEENTRY_HXX
 
 
-#ifndef __cplusplus                                                          
+#ifndef __cplusplus
 # error This library requires C++
-#endif                                   
+#endif
 
 #ifdef HAVE_CONFIG_H
 #  include <config.h>
 #endif
 
-#ifdef HAVE_WINDOWS_H
-#  include <windows.h>
-#endif
-
-#include <GL/glut.h>
-#include <XGL/xgl.h>
-
-#include <Include/compiler.h>
+#include <simgear/compiler.h>
 
 #include <vector>
 #include STL_STRING
 
-#include <ssg.h>               // plib includes
+#include <simgear/bucket/newbucket.hxx>
+#include <simgear/math/point3d.hxx>
+#include <simgear/misc/sg_path.hxx>
+#include <simgear/scene/model/placementtrans.hxx>
 
-#include <Bucket/newbucket.hxx>
-#include <Math/mat3.h>
-#include <Math/point3d.hxx>
-#include <Objects/fragment.hxx>
+#include <osg/ref_ptr>
+#include <osg/Array>
+#include <osg/Group>
+#include <osg/LOD>
+#include <osg/MatrixTransform>
+#include <osg/Switch>
 
-#ifdef FG_HAVE_NATIVE_SGI_COMPILERS
+#if defined( sgi )
 #include <strings.h>
 #endif
 
-FG_USING_STD(string);
-FG_USING_STD(vector);
+SG_USING_STD(string);
+SG_USING_STD(vector);
 
 
 typedef vector < Point3D > point_list;
@@ -65,127 +63,180 @@ typedef point_list::iterator point_list_iterator;
 typedef point_list::const_iterator const_point_list_iterator;
 
 
-// Scenery tile class
-class FGTileEntry {
+class FGTileEntry;
 
-private:
 
-    // Tile state
-    enum tile_state {
-       Unused = 0,
-       Scheduled = 1,
-       Loaded = 2
-    };
+/**
+ * A class to hold deferred model loading info
+ */
+class FGDeferredModel {
 
-public:
+private:
 
-    typedef vector < fgFRAGMENT > container;
-    typedef container::iterator FragmentIterator;
-    typedef container::const_iterator FragmentConstIterator;
+    string model_path;
+    string texture_path;
+    FGTileEntry *tile;
+    osg::ref_ptr<osg::MatrixTransform> obj_trans;
+    SGBucket bucket;
+    bool cache_obj;
 
-public:
-    // node list (the per fragment face lists reference this node list)
-    point_list nodes;
-    int ncount;
 
-    // global tile culling data
-    Point3D center;
-    double bounding_radius;
-    Point3D offset;
+public:
 
-    // model view matrix for this tile
-    GLfloat model_view[16];
+    inline FGDeferredModel() { }
+    inline FGDeferredModel( const string& mp, const string& tp, SGBucket b,
+                            FGTileEntry *t, osg::MatrixTransform *ot, bool co )
+    {
+       model_path = mp;
+       texture_path = tp;
+        bucket = b;
+       tile = t;
+       obj_trans = ot;
+       cache_obj = co;
+    }
+    inline ~FGDeferredModel() { }
+    inline const string& get_model_path() const { return model_path; }
+    inline const string& get_texture_path() const { return texture_path; }
+    inline const SGBucket& get_bucket() const { return bucket; }
+    inline const bool get_cache_state() const { return cache_obj; }
+    inline FGTileEntry *get_tile() const { return tile; }
+    inline osg::MatrixTransform *get_obj_trans() const { return obj_trans.get(); }
+};
 
-    // this tile's official location in the world
-    FGBucket tile_bucket;
 
-    // the tile cache will keep track here if the tile is being used
-    tile_state state;
+/**
+ * A class to encapsulate everything we need to know about a scenery tile.
+ */
+class FGTileEntry {
 
-    container fragment_list;
+public:
+    // this tile's official location in the world
+    SGBucket tile_bucket;
 
-    // ssg related structures
-    sgVec3 *vtlist;
-    sgVec3 *vnlist;
-    sgVec2 *tclist;
+private:
 
-    // pointer to ssg branch;
-    ssgTransform *branch_ptr;
+    // pointer to ssg transform for this tile
+    osg::ref_ptr<osg::Group> terra_transform;
+
+    // pointer to ssg range selector for this tile
+    osg::ref_ptr<osg::LOD> terra_range;
+
+    /**
+     * Indicates this tile has been loaded from a file and connected
+     * into the scene graph.  Note that this may be set asynchronously
+     * by another thread.
+     */
+    volatile bool loaded;
+
+    /**
+     * Count of pending models to load for this tile.  This tile
+     * cannot be removed until this number reaches zero (i.e. no
+     * pending models to load for this tile.)
+     */
+    volatile int pending_models;
+
+    bool obj_load( const string& path,
+                   osg::Group* geometry,
+                   bool is_base );
+
+    double timestamp;
+
+    /**
+     * this value is used by the tile scheduler/loader to mark which
+     * tiles are in the primary ring (i.e. the current tile or the
+     * surrounding eight.)  Other routines then can use this as an
+     * optimization and not do some operation to tiles outside of this
+     * inner ring.  (For instance vasi color updating)
+     */
+    bool is_inner_ring;
+
+    /**
+     * this variable tracks the status of the incremental memory
+     * freeing.
+     */
+    enum {
+        NODES = 0x01,
+        VEC_PTRS = 0x02,
+        TERRA_NODE = 0x04,
+        GROUND_LIGHTS = 0x08,
+        VASI_LIGHTS = 0x10,
+        RWY_LIGHTS = 0x20,
+        TAXI_LIGHTS = 0x40,
+        LIGHTMAPS = 0x80
+    };
+    int free_tracker;
 
 public:
 
     // Constructor
-    FGTileEntry ( void );
+    FGTileEntry( const SGBucket& b );
 
     // Destructor
-    ~FGTileEntry ( void );
-
-    FragmentIterator begin() { return fragment_list.begin(); }
-    FragmentConstIterator begin() const { return fragment_list.begin(); }
-
-    FragmentIterator end() { return fragment_list.end(); }
-    FragmentConstIterator end() const { return fragment_list.end(); }
-
-    void add_fragment( fgFRAGMENT& frag ) {
-       frag.tile_ptr = this;
-       fragment_list.push_back( frag );
-    }
-
-    size_t num_fragments() const {
-       return fragment_list.size();
-    }
-
-    // Step through the fragment list, deleting the display list, then
-    // the fragment, until the list is empty.  Also delete the arrays
-    // used by ssg as well as the whole ssg branch
-    void free_tile();
-
-    // Calculate this tile's offset
-    void SetOffset( const Point3D& off)
-    {
-       offset = center - off;
-    }
-
-    // Return this tile's offset
-    inline Point3D get_offset( void ) const { return offset; }
-
-    // Calculate the model_view transformation matrix for this tile
-    inline void update_view_matrix(GLfloat *MODEL_VIEW)
-    {
+    ~FGTileEntry();
+
+    // Clean up the memory used by this tile and delete the arrays
+    // used by ssg as well as the whole ssg branch.  This does a
+    // partial clean up and exits so we can spread the load across
+    // multiple frames.  Returns false if work remaining to be done,
+    // true if dynamically allocated memory used by this tile is
+    // completely freed.
+    bool free_tile();
+
+    // Update the ssg transform node for this tile so it can be
+    // properly drawn relative to our (0,0,0) point
+    void prep_ssg_node(float vis);
+
+    /**
+     * Load tile data from a file.
+     * @param base name of directory containing tile data file.
+     * @param is_base is this a base terrain object for which we should generate
+     *        random ground light points */
+    void load( const string_list &base_path, bool is_base );
+
+    /**
+     * Return true if the tile entry is loaded, otherwise return false
+     * indicating that the loading thread is still working on this.
+     */
+    inline bool is_loaded() const { return loaded; }
+
+    /**
+     * decrement the pending models count
+     */
+    inline void dec_pending_models() { pending_models--; }
+
+    /**
+     * return the number of remaining pending models for this tile
+     */
+    inline int get_pending_models() const { return pending_models; }
+
+    /**
+     * Return the "bucket" for this tile
+     */
+    inline const SGBucket& get_tile_bucket() const { return tile_bucket; }
+
+    /**
+     * Add terrain mesh and ground lighting to scene graph.
+     */
+    void add_ssg_nodes( osg::Group *terrain_branch);
+
+    /**
+     * disconnect terrain mesh and ground lighting nodes from scene
+     * graph for this tile.
+     */
+    void disconnect_ssg_nodes();
 
-#if defined( USE_MEM ) || defined( WIN32 )
-       memcpy( model_view, MODEL_VIEW, 16*sizeof(GLfloat) );
-#else 
-       bcopy( MODEL_VIEW, model_view, 16*sizeof(GLfloat) );
-#endif
        
-       // This is equivalent to doing a glTranslatef(x, y, z);
-       model_view[12] += (model_view[0]*offset.x() +
-                          model_view[4]*offset.y() +
-                          model_view[8]*offset.z());
-       model_view[13] += (model_view[1]*offset.x() +
-                          model_view[5]*offset.y() +
-                          model_view[9]*offset.z());
-       model_view[14] += (model_view[2]*offset.x() +
-                          model_view[6]*offset.y() +
-                          model_view[10]*offset.z() );
-       // m[15] += (m[3]*x + m[7]*y + m[11]*z);
-       // m[3] m7[] m[11] are 0.0 see LookAt() in views.cxx
-       // so m[15] is unchanged
-    }
+    /**
+     * return the SSG Transform node for the terrain
+     */
+    osg::Group *get_terra_transform() const { return terra_transform.get(); }
 
-    inline bool is_unused() const { return state == Unused; }
-    inline bool is_loaded() const { return state == Loaded; }
+    inline double get_timestamp() const { return timestamp; }
+    inline void set_timestamp( double time_ms ) { timestamp = time_ms; }
 
-    inline void mark_unused() { state = Unused; }
-    inline void mark_scheduled() { state = Scheduled; }
-    inline void mark_loaded() { state = Loaded; }
+    inline bool get_inner_ring() const { return is_inner_ring; }
+    inline void set_inner_ring( bool val ) { is_inner_ring = val; }
 };
 
 
-typedef vector < FGTileEntry > tile_list;
-typedef tile_list::iterator tile_list_iterator;
-typedef tile_list::const_iterator const_tile_list_iterator;
-
-
 #endif // _TILEENTRY_HXX