simgear/bvh/BVHPager.hxx

   1 // Copyright (C) 2008 - 2012  Mathias Froehlich - Mathias.Froehlich@web.de
   2 //
   3 // This library is free software; you can redistribute it and/or
   4 // modify it under the terms of the GNU Library General Public
   5 // License as published by the Free Software Foundation; either
   6 // version 2 of the License, or (at your option) any later version.
   7 //
   8 // This library is distributed in the hope that it will be useful,
   9 // but WITHOUT ANY WARRANTY; without even the implied warranty of
  10 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  11 // Library General Public License for more details.
  12 //
  13 // You should have received a copy of the GNU General Public License
  14 // along with this program; if not, write to the Free Software
  15 // Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.
  16 //
  17
  18 #ifndef BVHPager_hxx
  19 #define BVHPager_hxx
  20
  21 #include <simgear/structure/SGSharedPtr.hxx>
  22
  23 namespace simgear {
  24
  25 class BVHPageNode;
  26 class BVHPageRequest;
  27
  28 class BVHPager {
  29 public:
  30     BVHPager();
  31     ~BVHPager();
  32
  33     /// Starts the pager thread
  34     bool start();
  35
  36     /// Stops the pager thread
  37     void stop();
  38
  39     /// Use this page node, if loaded make it as used, if not loaded schedule
  40     void use(BVHPageNode& pageNode);
  41
  42     /// Call this from the main thread to incorporate the processed page
  43     /// requests into the bounding volume tree
  44     void update(unsigned expiry);
  45
  46     /// The usage stamp to mark usage of BVHPageNodes
  47     void setUseStamp(unsigned stamp);
  48     unsigned getUseStamp() const;
  49
  50 private:
  51     BVHPager(const BVHPager&);
  52     BVHPager& operator=(const BVHPager&);
  53
  54     struct _PrivateData;
  55     _PrivateData* _privateData;
  56 };
  57
  58 }
  59
  60 #endif