src/Canvas/elements/CanvasImage.cxx

   1 // An image on the canvas
   2 //
   3 // Copyright (C) 2012  Thomas Geymayer <tomgey@gmail.com>
   4 //
   5 // This program is free software; you can redistribute it and/or
   6 // modify it under the terms of the GNU General Public License as
   7 // published by the Free Software Foundation; either version 2 of the
   8 // License, or (at your option) any later version.
   9 //
  10 // This program is distributed in the hope that it will be useful, but
  11 // WITHOUT ANY WARRANTY; without even the implied warranty of
  12 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  13 // General Public License for more details.
  14 //
  15 // You should have received a copy of the GNU General Public License
  16 // along with this program; if not, write to the Free Software
  17 // Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.
  18
  19 #include "CanvasImage.hxx"
  20
  21 #include <osgDB/ReadFile>
  22
  23 #include <Canvas/canvas.hxx>
  24 #include <Canvas/canvas_mgr.hxx>
  25 #include <Canvas/property_helper.hxx>
  26 #include <osg/Array>
  27 #include <osg/Geometry>
  28 #include <osg/PrimitiveSet>
  29
  30 #include <Main/globals.hxx>
  31 #include <Main/fg_props.hxx>
  32
  33 #include <boost/algorithm/string/predicate.hpp>
  34
  35 /**
  36  * Callback to enable/disable rendering of canvas displayed inside windows or
  37  * other canvases.
  38  */
  39 class CullCallback:
  40   public osg::Drawable::CullCallback
  41 {
  42   public:
  43     CullCallback(Canvas::CameraCullCallback* camera_cull);
  44
  45   private:
  46     Canvas::CameraCullCallbackWeakPtr _camera_cull;
  47
  48     virtual bool cull( osg::NodeVisitor* nv,
  49                        osg::Drawable* drawable,
  50                        osg::RenderInfo* renderInfo ) const;
  51 };
  52
  53 //------------------------------------------------------------------------------
  54 CullCallback::CullCallback(Canvas::CameraCullCallback* camera_cull):
  55   _camera_cull( camera_cull )
  56 {
  57
  58 }
  59
  60 //------------------------------------------------------------------------------
  61 bool CullCallback::cull( osg::NodeVisitor* nv,
  62                          osg::Drawable* drawable,
  63                          osg::RenderInfo* renderInfo ) const
  64 {
  65   if( _camera_cull.valid() )
  66     _camera_cull->enableRendering();
  67
  68   // TODO check if window/image should be culled
  69   return false;
  70 }
  71
  72 namespace canvas
  73 {
  74   //----------------------------------------------------------------------------
  75   Image::Image(SGPropertyNode_ptr node, const Style& parent_style):
  76     Element(node, parent_style, BOUNDING_BOX),
  77     _texture(new osg::Texture2D),
  78     _node_src_rect( node->getNode("source", 0, true) )
  79   {
  80     _geom = new osg::Geometry;
  81     _geom->setUseDisplayList(false);
  82
  83     osg::StateSet *stateSet = _geom->getOrCreateStateSet();
  84     stateSet->setTextureAttributeAndModes(0, _texture.get());
  85     stateSet->setDataVariance(osg::Object::STATIC);
  86
  87     // allocate arrays for the image
  88     _vertices = new osg::Vec3Array(4);
  89     _vertices->setDataVariance(osg::Object::STATIC);
  90     _geom->setVertexArray(_vertices);
  91
  92     _texCoords = new osg::Vec2Array(4);
  93     _texCoords->setDataVariance(osg::Object::STATIC);
  94     _geom->setTexCoordArray(0, _texCoords);
  95
  96     _colors = new osg::Vec4Array(4);
  97     _colors->setDataVariance(osg::Object::STATIC);
  98     _geom->setColorBinding(osg::Geometry::BIND_PER_VERTEX);
  99     _geom->setColorArray(_colors);
 100
 101     osg::DrawArrays* prim = new osg::DrawArrays(osg::PrimitiveSet::QUADS);
 102     prim->set(osg::PrimitiveSet::QUADS, 0, 4);
 103     prim->setDataVariance(osg::Object::STATIC);
 104     _geom->addPrimitiveSet(prim);
 105
 106     setDrawable(_geom);
 107
 108     addStyle("fill", &Image::setFill, this);
 109     setFill("#ffffff"); // TODO how should we handle default values?
 110
 111     setupStyle();
 112   }
 113
 114   //----------------------------------------------------------------------------
 115   Image::~Image()
 116   {
 117
 118   }
 119
 120   //----------------------------------------------------------------------------
 121   void Image::update(double dt)
 122   {
 123     Element::update(dt);
 124
 125     if( _attributes_dirty & DEST_SIZE )
 126     {
 127       (*_vertices)[0].set(_region.l(), _region.t(), 0);
 128       (*_vertices)[1].set(_region.r(), _region.t(), 0);
 129       (*_vertices)[2].set(_region.r(), _region.b(), 0);
 130       (*_vertices)[3].set(_region.l(), _region.b(), 0);
 131       _vertices->dirty();
 132
 133       _attributes_dirty &= ~DEST_SIZE;
 134       _geom->dirtyBound();
 135     }
 136
 137     if( _attributes_dirty & SRC_RECT )
 138     {
 139       double u0 = _src_rect.l(),
 140              u1 = _src_rect.r(),
 141              v0 = _src_rect.b(),
 142              v1 = _src_rect.t();
 143
 144       if( !_node_src_rect->getBoolValue("normalized", true) )
 145       {
 146         const Rect<int>& tex_dim = getTextureDimensions();
 147
 148         u0 /= tex_dim.width();
 149         u1 /= tex_dim.width();
 150         v0 /= tex_dim.height();
 151         v1 /= tex_dim.height();
 152       }
 153
 154       (*_texCoords)[0].set(u0, v0);
 155       (*_texCoords)[1].set(u1, v0);
 156       (*_texCoords)[2].set(u1, v1);
 157       (*_texCoords)[3].set(u0, v1);
 158       _texCoords->dirty();
 159
 160       _attributes_dirty &= ~SRC_RECT;
 161     }
 162   }
 163
 164   //----------------------------------------------------------------------------
 165   void Image::setCanvas(CanvasPtr canvas)
 166   {
 167     _canvas = canvas;
 168     _geom->getOrCreateStateSet()
 169          ->setTextureAttribute(0, canvas ? canvas->getTexture() : 0);
 170     _geom->setCullCallback(
 171       canvas ? new CullCallback(canvas->getCameraCullCallback()) : 0
 172     );
 173
 174     if( !_canvas.expired() )
 175       setupDefaultDimensions();
 176   }
 177
 178   //----------------------------------------------------------------------------
 179   CanvasWeakPtr Image::getCanvas() const
 180   {
 181     return _canvas;
 182   }
 183
 184   //----------------------------------------------------------------------------
 185   void Image::setImage(osg::Image *img)
 186   {
 187     // remove canvas...
 188     setCanvas( CanvasPtr() );
 189
 190     _texture->setImage(img);
 191     _geom->getOrCreateStateSet()
 192          ->setTextureAttributeAndModes(0, _texture);
 193
 194     if( img )
 195       setupDefaultDimensions();
 196   }
 197
 198   //----------------------------------------------------------------------------
 199   void Image::setFill(const std::string& fill)
 200   {
 201     osg::Vec4 color = parseColor(fill);
 202     for( int i = 0; i < 4; ++i )
 203       (*_colors)[i] = color;
 204     _colors->dirty();
 205   }
 206
 207   //----------------------------------------------------------------------------
 208   const Rect<float>& Image::getRegion() const
 209   {
 210     return _region;
 211   }
 212
 213   //----------------------------------------------------------------------------
 214   void Image::childChanged(SGPropertyNode* child)
 215   {
 216     const std::string& name = child->getNameString();
 217
 218     if( child->getParent() == _node_src_rect )
 219     {
 220       _attributes_dirty |= SRC_RECT;
 221
 222       if(      name == "left" )
 223         _src_rect.setLeft( child->getFloatValue() );
 224       else if( name == "right" )
 225         _src_rect.setRight( child->getFloatValue() );
 226       else if( name == "top" )
 227         _src_rect.setTop( child->getFloatValue() );
 228       else if( name == "bottom" )
 229         _src_rect.setBottom( child->getFloatValue() );
 230
 231       return;
 232     }
 233     else if( child->getParent() != _node )
 234       return;
 235
 236     if( name == "x" )
 237     {
 238       _region.setX( child->getFloatValue() );
 239       _attributes_dirty |= DEST_SIZE;
 240     }
 241     else if( name == "y" )
 242     {
 243       _region.setY( child->getFloatValue() );
 244       _attributes_dirty |= DEST_SIZE;
 245     }
 246     else if( name == "size" )
 247     {
 248       if( child->getIndex() == 0 )
 249         _region.setWidth( child->getFloatValue() );
 250       else
 251         _region.setHeight( child->getFloatValue() );
 252
 253       _attributes_dirty |= DEST_SIZE;
 254     }
 255     else if( name == "file" )
 256     {
 257       static const std::string CANVAS_PROTOCOL = "canvas://";
 258       const std::string& path = child->getStringValue();
 259
 260       if( boost::starts_with(path, CANVAS_PROTOCOL) )
 261       {
 262         CanvasMgr* canvas_mgr =
 263           dynamic_cast<CanvasMgr*>(globals->get_subsystem("Canvas"));
 264         if( !canvas_mgr )
 265         {
 266           SG_LOG(SG_GL, SG_ALERT, "canvas::Image: Failed to get CanvasMgr");
 267           return;
 268         }
 269
 270         const SGPropertyNode* canvas_node =
 271           canvas_mgr->getPropertyRoot()
 272                     ->getParent()
 273                     ->getNode( path.substr(CANVAS_PROTOCOL.size()) );
 274         if( !canvas_node )
 275         {
 276           SG_LOG(SG_GL, SG_ALERT, "canvas::Image: No such canvas: " << path);
 277           return;
 278         }
 279
 280         // TODO add support for other means of addressing canvases (eg. by
 281         // name)
 282         CanvasPtr canvas = canvas_mgr->getCanvas( canvas_node->getIndex() );
 283         if( !canvas )
 284         {
 285           SG_LOG(SG_GL, SG_ALERT, "canvas::Image: Invalid canvas: " << path);
 286           return;
 287         }
 288
 289         setCanvas(canvas);
 290       }
 291       else
 292       {
 293         SGPath tpath = globals->resolve_ressource_path(path);
 294         if( tpath.isNull() || !tpath.exists() )
 295         {
 296           SG_LOG(SG_GL, SG_ALERT, "canvas::Image: No such image: " << path);
 297           return;
 298         }
 299
 300         setImage( osgDB::readImageFile(tpath.c_str()) );
 301       }
 302     }
 303   }
 304
 305   //----------------------------------------------------------------------------
 306   void Image::setupDefaultDimensions()
 307   {
 308     if( !_src_rect.width() || !_src_rect.height() )
 309     {
 310       const Rect<int>& tex_dim = getTextureDimensions();
 311
 312       _node_src_rect->setBoolValue("normalized", false);
 313       _node_src_rect->setFloatValue("right", tex_dim.width());
 314       _node_src_rect->setFloatValue("bottom", tex_dim.height());
 315     }
 316
 317     if( !_region.width() || !_region.height() )
 318     {
 319       _node->setFloatValue("size[0]", _src_rect.width());
 320       _node->setFloatValue("size[1]", _src_rect.height());
 321     }
 322   }
 323
 324   //----------------------------------------------------------------------------
 325   Rect<int> Image::getTextureDimensions() const
 326   {
 327     osg::Texture2D *texture = !_canvas.expired()
 328                               ? _canvas.lock()->getTexture()
 329                               : _texture.get();
 330
 331     if( !texture )
 332       return Rect<int>();
 333
 334     return Rect<int>
 335     (
 336       0,0,
 337       texture->getTextureWidth(),
 338       texture->getTextureHeight()
 339     );
 340   }
 341
 342 } // namespace canvas