simgear/canvas/CanvasSystemAdapter.hxx

   1 // Adapter for using the canvas with different applications
   2 //
   3 // Copyright (C) 2012  Thomas Geymayer <tomgey@gmail.com>
   4 //
   5 // This library is free software; you can redistribute it and/or
   6 // modify it under the terms of the GNU Library General Public
   7 // License as published by the Free Software Foundation; either
   8 // version 2 of the License, or (at your option) any later version.
   9 //
  10 // This library is distributed in the hope that it will be useful,
  11 // but WITHOUT ANY WARRANTY; without even the implied warranty of
  12 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  13 // Library General Public License for more details.
  14 //
  15 // You should have received a copy of the GNU Library General Public
  16 // License along with this library; if not, write to the Free Software
  17 // Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301, USA
  18
  19 #ifndef SG_CANVAS_SYSTEM_ADAPTER_HXX_
  20 #define SG_CANVAS_SYSTEM_ADAPTER_HXX_
  21
  22 #include "canvas_fwd.hxx"
  23 #include <simgear/nasal/naref.h>
  24
  25 namespace simgear
  26 {
  27 namespace canvas
  28 {
  29
  30   class SystemAdapter
  31   {
  32     public:
  33
  34       virtual ~SystemAdapter() {}
  35       virtual FontPtr getFont(const std::string& name) const = 0;
  36       virtual void addCamera(osg::Camera* camera) const = 0;
  37       virtual void removeCamera(osg::Camera* camera) const = 0;
  38       virtual osg::Image* getImage(const std::string& path) const = 0;
  39
  40       /**
  41        * Save passed reference to Nasal object from being deleted by the
  42        * garbage collector.
  43        */
  44       virtual int gcSave(naRef r) = 0;
  45
  46       /**
  47        * Release an object previously passed to ::gcSave to allow it being
  48        * cleaned up by the garbage collector.
  49        */
  50       virtual void gcRelease(int key) = 0;
  51
  52       /**
  53        * Call a Nasal function with the given environment and arguments.
  54        */
  55       virtual naRef callMethod( naRef code,
  56                                 naRef self,
  57                                 int argc,
  58                                 naRef* args,
  59                                 naRef locals ) = 0;
  60   };
  61
  62 } // namespace canvas
  63 } // namespace simgear
  64
  65 #endif /* SG_CANVAS_SYSTEM_ADAPTER_HXX_ */