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/misc/CSSBorder.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       static const std::string TYPE_NAME;
  38
  39       /**
  40        * @param node    Property node containing settings for this image:
  41        *                  rect/[left/right/top/bottom]  Dimensions of source
  42        *                                                rect
  43        *                  size[0-1]                     Dimensions of rectangle
  44        *                  [x,y]                         Position of rectangle
  45        */
  46       Image( const CanvasWeakPtr& canvas,
  47              const SGPropertyNode_ptr& node,
  48              const Style& parent_style = Style(),
  49              Element* parent = 0 );
  50       virtual ~Image();
  51
  52       virtual void update(double dt);
  53       virtual void valueChanged(SGPropertyNode* child);
  54
  55       void setSrcCanvas(CanvasPtr canvas);
  56       CanvasWeakPtr getSrcCanvas() const;
  57
  58       void setImage(osg::Image *img);
  59       void setFill(const std::string& fill);
  60
  61       /**
  62        * Set image slice (aka. 9-scale)
  63        *
  64        * @see http://www.w3.org/TR/css3-background/#border-image-slice
  65        */
  66       void setSlice(const std::string& slice);
  67
  68       /**
  69        * Set image slice width.
  70        *
  71        * By default the size of the 9-scale grid is the same as specified
  72        * with setSlice/"slice". Using this method allows setting values
  73        * different to the size in the source image.
  74        *
  75        * @see http://www.w3.org/TR/css3-background/#border-image-width
  76        */
  77       void setSliceWidth(const std::string& width);
  78
  79       /**
  80        * http://www.w3.org/TR/css3-background/#border-image-outset
  81        */
  82       void setOutset(const std::string& outset);
  83
  84       const SGRect<float>& getRegion() const;
  85
  86       bool handleEvent(EventPtr event);
  87
  88     protected:
  89
  90       enum ImageAttributes
  91       {
  92         SRC_RECT       = LAST_ATTRIBUTE << 1, // Source image rectangle
  93         DEST_SIZE      = SRC_RECT << 1,       // Element size
  94         SRC_CANVAS     = DEST_SIZE << 1
  95       };
  96
  97       virtual void childChanged(SGPropertyNode * child);
  98
  99       void setupDefaultDimensions();
 100       SGRect<int> getTextureDimensions() const;
 101
 102       void setQuad(size_t index, const SGVec2f& tl, const SGVec2f& br);
 103       void setQuadUV(size_t index, const SGVec2f& tl, const SGVec2f& br);
 104
 105       osg::ref_ptr<osg::Texture2D> _texture;
 106       // TODO optionally forward events to canvas
 107       CanvasWeakPtr _src_canvas;
 108
 109       osg::ref_ptr<osg::Geometry>  _geom;
 110       osg::ref_ptr<osg::DrawArrays>_prim;
 111       osg::ref_ptr<osg::Vec3Array> _vertices;
 112       osg::ref_ptr<osg::Vec2Array> _texCoords;
 113       osg::ref_ptr<osg::Vec4Array> _colors;
 114
 115       SGPropertyNode *_node_src_rect;
 116       SGRect<float>   _src_rect,
 117                       _region;
 118
 119       CSSBorder       _slice,
 120                       _slice_width,
 121                       _outset;
 122   };
 123
 124 } // namespace canvas
 125 } // namespace canvas
 126
 127 #endif /* CANVAS_IMAGE_HXX_ */