src/Scenery/SceneryPager.hxx

   1 // SceneryPager.hxx -- Interface to OSG database pager
   2 //
   3 // Copyright (C) 2007 Tim Moore timoore@redhat.com
   4 //
   5 // This program is free software; you can redistribute it and/or
   6 // modify it under the terms of the GNU General Public License as
   7 // published by the Free Software Foundation; either version 2 of the
   8 // License, or (at your option) any later version.
   9 //
  10 // This program is distributed in the hope that it will be useful, but
  11 // WITHOUT ANY WARRANTY; without even the implied warranty of
  12 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  13 // General Public License for more details.
  14 //
  15 // You should have received a copy of the GNU General Public License
  16 // along with this program; if not, write to the Free Software
  17 // Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.
  18 //
  19 // $Id$
  20
  21 #ifndef FLIGHTGEAR_SCENERYPAGERHXX
  22 #define FLIGHTGEAR_SCENERYPAGERHXX 1
  23 #include <string>
  24 #include <vector>
  25
  26 #include <osg/FrameStamp>
  27 #include <osg/Group>
  28 #include <osgDB/DatabasePager>
  29
  30 #include <simgear/structure/OSGVersion.hxx>
  31
  32 namespace flightgear
  33 {
  34 class SceneryPager : public osgDB::DatabasePager
  35 {
  36 public:
  37     SceneryPager();
  38     SceneryPager(const SceneryPager& rhs);
  39     // Unhide DatabasePager::requestNodeFile
  40     using osgDB::DatabasePager::requestNodeFile;
  41     void queueRequest(const std::string& fileName, osg::Group* node,
  42                       float priority, osg::FrameStamp* frameStamp,
  43                       osg::ref_ptr<osg::Referenced>& databaseRequest,
  44                       osgDB::ReaderWriter::Options* options);
  45     // This is passed a ref_ptr so that it can "take ownership" of the
  46     // node to delete and decrement its refcount while holding the
  47     // lock on the delete list.
  48     void queueDeleteRequest(osg::ref_ptr<osg::Object>& objptr);
  49     virtual void signalEndFrame();
  50
  51     void clearRequests();
  52 protected:
  53     // Queue up file requests until the end of the frame
  54     struct PagerRequest
  55     {
  56         PagerRequest() : _priority(0.0f), _databaseRequest(0) {}
  57         PagerRequest(const PagerRequest& rhs) :
  58             _fileName(rhs._fileName), _group(rhs._group),
  59             _priority(rhs._priority), _frameStamp(rhs._frameStamp),
  60             _options(rhs._options), _databaseRequest(rhs._databaseRequest) {}
  61
  62         PagerRequest(const std::string& fileName, osg::Group* group,
  63                      float priority, osg::FrameStamp* frameStamp,
  64                      osg::ref_ptr<Referenced>& databaseRequest,
  65                      osgDB::ReaderWriter::Options* options):
  66             _fileName(fileName), _group(group), _priority(priority),
  67             _frameStamp(frameStamp), _options(options),
  68             _databaseRequest(&databaseRequest)
  69         {}
  70
  71         void doRequest(SceneryPager* pager);
  72         std::string _fileName;
  73         osg::ref_ptr<osg::Group> _group;
  74         float _priority;
  75         osg::ref_ptr<osg::FrameStamp> _frameStamp;
  76         osg::ref_ptr<osgDB::ReaderWriter::Options> _options;
  77         osg::ref_ptr<osg::Referenced>* _databaseRequest;
  78     };
  79     typedef std::vector<PagerRequest> PagerRequestList;
  80     PagerRequestList _pagerRequests;
  81     typedef std::vector<osg::ref_ptr<osg::Object> > DeleteRequestList;
  82     DeleteRequestList _deleteRequests;
  83     virtual ~SceneryPager();
  84 };
  85 }
  86 #endif