simgear/canvas/elements/CanvasImage.hxx

   1 // An image on the Canvas
   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 CANVAS_IMAGE_HXX_
  20 #define CANVAS_IMAGE_HXX_
  21
  22 #include "CanvasElement.hxx"
  23
  24 #include <simgear/canvas/canvas_fwd.hxx>
  25 #include <simgear/math/SGRect.hxx>
  26 #include <osg/Texture2D>
  27
  28 namespace simgear
  29 {
  30 namespace canvas
  31 {
  32
  33   class Image:
  34     public Element
  35   {
  36     public:
  37       /**
  38        * @param node    Property node containing settings for this image:
  39        *                  rect/[left/right/top/bottom]  Dimensions of source
  40        *                                                rect
  41        *                  size[0-1]                     Dimensions of rectangle
  42        *                  [x,y]                         Position of rectangle
  43        */
  44       Image( const CanvasWeakPtr& canvas,
  45              const SGPropertyNode_ptr& node,
  46              const Style& parent_style,
  47              Element* parent = 0 );
  48       virtual ~Image();
  49
  50       virtual void update(double dt);
  51
  52       void setSrcCanvas(CanvasPtr canvas);
  53       CanvasWeakPtr getSrcCanvas() const;
  54
  55       void setImage(osg::Image *img);
  56       void setFill(const std::string& fill);
  57
  58       /**
  59        * Set image slice (aka. 9-scale)
  60        *
  61        * @see http://www.w3.org/TR/css3-background/#border-image-slice
  62        */
  63       void setSlice(const std::string& slice);
  64
  65       /**
  66        * http://www.w3.org/TR/css3-background/#border-image-outset
  67        */
  68       void setOutset(const std::string& outset);
  69
  70       const SGRect<float>& getRegion() const;
  71
  72     protected:
  73
  74       enum ImageAttributes
  75       {
  76         SRC_RECT       = LAST_ATTRIBUTE << 1, // Source image rectangle
  77         DEST_SIZE      = SRC_RECT << 1        // Element size
  78       };
  79
  80       struct CSSOffsets
  81       {
  82         CSSOffsets():
  83           valid(false)
  84         {}
  85
  86         union
  87         {
  88           float          offsets[4];
  89           struct { float t, r, b, l; };
  90         };
  91
  92         std::string keyword;
  93         bool        valid;
  94       };
  95
  96       virtual void childChanged(SGPropertyNode * child);
  97
  98       void setupDefaultDimensions();
  99       SGRect<int> getTextureDimensions() const;
 100
 101       void setQuad(size_t index, const SGVec2f& tl, const SGVec2f& br);
 102       void setQuadUV(size_t index, const SGVec2f& tl, const SGVec2f& br);
 103
 104       CSSOffsets parseSideOffsets(const std::string& str) const;
 105
 106       osg::ref_ptr<osg::Texture2D> _texture;
 107       // TODO optionally forward events to canvas
 108       CanvasWeakPtr _src_canvas;
 109
 110       osg::ref_ptr<osg::Geometry>  _geom;
 111       osg::ref_ptr<osg::DrawArrays>_prim;
 112       osg::ref_ptr<osg::Vec3Array> _vertices;
 113       osg::ref_ptr<osg::Vec2Array> _texCoords;
 114       osg::ref_ptr<osg::Vec4Array> _colors;
 115
 116       SGPropertyNode *_node_src_rect;
 117       SGRect<float>   _src_rect,
 118                       _region;
 119
 120       CSSOffsets      _slice,
 121                       _outset;
 122   };
 123
 124 } // namespace canvas
 125 } // namespace canvas
 126
 127 #endif /* CANVAS_IMAGE_HXX_ */