simgear/canvas/CanvasMgr.hxx

   1 // Canvas with 2D rendering API
   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_MGR_H_
  20 #define SG_CANVAS_MGR_H_
  21
  22 #include "canvas_fwd.hxx"
  23 #include <simgear/props/PropertyBasedMgr.hxx>
  24
  25 namespace simgear
  26 {
  27 namespace canvas
  28 {
  29
  30   class CanvasMgr:
  31     public PropertyBasedMgr
  32   {
  33     public:
  34
  35       /**
  36        * @param node            Root node of branch used to control canvasses
  37        */
  38       CanvasMgr(SGPropertyNode_ptr node);
  39
  40       /**
  41        * Create a new canvas
  42        *
  43        * @param name    Name of the new canvas
  44        */
  45       CanvasPtr createCanvas(const std::string& name = "");
  46
  47       /**
  48        * Get ::Canvas by index
  49        *
  50        * @param index Index of texture node in /canvas/by-index/
  51        */
  52       CanvasPtr getCanvas(size_t index) const;
  53
  54       /**
  55        * Get ::Canvas by name
  56        *
  57        * @param name Value of child node "name" in
  58        *             /canvas/by-index/texture[i]/name
  59        */
  60       CanvasPtr getCanvas(const std::string& name) const;
  61
  62     protected:
  63
  64       virtual void elementCreated(PropertyBasedElementPtr element);
  65   };
  66
  67 } // namespace canvas
  68 } // namespace simgear
  69
  70 #endif /* SG_CANVAS_MGR_H_ */