simgear/canvas/elements/CanvasPath.cxx

   1 // An OpenVG path 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 #include "CanvasPath.hxx"
  20 #include <simgear/scene/util/parse_color.hxx>
  21
  22 #include <osg/Drawable>
  23
  24 #include <vg/openvg.h>
  25 #include <cassert>
  26
  27 namespace simgear
  28 {
  29 namespace canvas
  30 {
  31   typedef std::vector<VGubyte>  CmdList;
  32   typedef std::vector<VGfloat>  CoordList;
  33
  34
  35   static const VGubyte shCoordsPerCommand[] = {
  36     0, /* VG_CLOSE_PATH */
  37     2, /* VG_MOVE_TO */
  38     2, /* VG_LINE_TO */
  39     1, /* VG_HLINE_TO */
  40     1, /* VG_VLINE_TO */
  41     4, /* VG_QUAD_TO */
  42     6, /* VG_CUBIC_TO */
  43     2, /* VG_SQUAD_TO */
  44     4, /* VG_SCUBIC_TO */
  45     5, /* VG_SCCWARC_TO */
  46     5, /* VG_SCWARC_TO */
  47     5, /* VG_LCCWARC_TO */
  48     5  /* VG_LCWARC_TO */
  49   };
  50   static const VGubyte shNumCommands = sizeof(shCoordsPerCommand)
  51                                      / sizeof(shCoordsPerCommand[0]);
  52
  53   /**
  54    * Helper to split and convert comma/whitespace separated floating point
  55    * values
  56    */
  57   std::vector<float> splitAndConvert(const char del[], const std::string& str);
  58
  59   class Path::PathDrawable:
  60     public osg::Drawable
  61   {
  62     public:
  63       PathDrawable(Path* path):
  64         _path_element(path),
  65         _path(VG_INVALID_HANDLE),
  66         _paint(VG_INVALID_HANDLE),
  67         _paint_fill(VG_INVALID_HANDLE),
  68         _attributes_dirty(~0),
  69         _mode(0),
  70         _fill_rule(VG_EVEN_ODD),
  71         _stroke_width(1),
  72         _stroke_linecap(VG_CAP_BUTT)
  73       {
  74         setSupportsDisplayList(false);
  75         setDataVariance(Object::DYNAMIC);
  76
  77         setUpdateCallback(new PathUpdateCallback());
  78       }
  79
  80       virtual ~PathDrawable()
  81       {
  82         if( _path != VG_INVALID_HANDLE )
  83           vgDestroyPath(_path);
  84         if( _paint != VG_INVALID_HANDLE )
  85           vgDestroyPaint(_paint);
  86         if( _paint_fill != VG_INVALID_HANDLE )
  87           vgDestroyPaint(_paint_fill);
  88       }
  89
  90       virtual const char* className() const { return "PathDrawable"; }
  91       virtual osg::Object* cloneType() const { return new PathDrawable(_path_element); }
  92       virtual osg::Object* clone(const osg::CopyOp&) const { return new PathDrawable(_path_element); }
  93
  94       /**
  95        * Replace the current path segments with the new ones
  96        *
  97        * @param cmds    List of OpenVG path commands
  98        * @param coords  List of coordinates/parameters used by #cmds
  99        */
 100       void setSegments(const CmdList& cmds, const CoordList& coords)
 101       {
 102         _cmds = cmds;
 103         _coords = coords;
 104
 105         _attributes_dirty |= (PATH | BOUNDING_BOX);
 106       }
 107
 108       /**
 109        * Set path fill paint ("none" if not filled)
 110        */
 111       void setFill(const std::string& fill)
 112       {
 113         if( fill.empty() || fill == "none" )
 114         {
 115           _mode &= ~VG_FILL_PATH;
 116         }
 117         else if( parseColor(fill, _fill_color) )
 118         {
 119           _mode |= VG_FILL_PATH;
 120           _attributes_dirty |= FILL_COLOR;
 121         }
 122         else
 123         {
 124           SG_LOG
 125           (
 126             SG_GENERAL,
 127             SG_WARN,
 128             "canvas::Path Unknown fill: " << fill
 129           );
 130         }
 131       }
 132
 133       /**
 134        * Set path fill rule ("pseudo-nonzero" or "evenodd")
 135        *
 136        * @warning As the current nonzero implementation causes sever artifacts
 137        *          for every concave path we call it pseudo-nonzero, so that
 138        *          everyone is warned that it won't work as expected :)
 139        */
 140       void setFillRule(const std::string& fill_rule)
 141       {
 142         if( fill_rule == "pseudo-nonzero" )
 143           _fill_rule = VG_NON_ZERO;
 144         else // if( fill_rule == "evenodd" )
 145           _fill_rule = VG_EVEN_ODD;
 146       }
 147
 148       /**
 149        * Set path stroke paint ("none" if no stroke)
 150        */
 151       void setStroke(const std::string& stroke)
 152       {
 153         if( stroke.empty() || stroke == "none" )
 154         {
 155           _mode &= ~VG_STROKE_PATH;
 156         }
 157         else if( parseColor(stroke, _stroke_color) )
 158         {
 159           _mode |= VG_STROKE_PATH;
 160                     _attributes_dirty |= STROKE_COLOR;
 161         }
 162         else
 163         {
 164           SG_LOG
 165           (
 166             SG_GENERAL,
 167             SG_WARN,
 168             "canvas::Path Unknown stroke: " << stroke
 169           );
 170         }
 171       }
 172
 173       /**
 174        * Set stroke width
 175        */
 176       void setStrokeWidth(float width)
 177       {
 178         _stroke_width = width;
 179         _attributes_dirty |= BOUNDING_BOX;
 180       }
 181
 182       /**
 183        * Set stroke dash (line stipple)
 184        */
 185       void setStrokeDashArray(const std::string& dash)
 186       {
 187         _stroke_dash = splitAndConvert(",\t\n ", dash);
 188       }
 189
 190       /**
 191        * Set stroke-linecap
 192        *
 193        * @see http://www.w3.org/TR/SVG/painting.html#StrokeLinecapProperty
 194        */
 195       void setStrokeLinecap(const std::string& linecap)
 196       {
 197         if( linecap == "round" )
 198           _stroke_linecap = VG_CAP_ROUND;
 199         else if( linecap == "square" )
 200           _stroke_linecap = VG_CAP_SQUARE;
 201         else
 202           _stroke_linecap = VG_CAP_BUTT;
 203       }
 204
 205       /**
 206        * Draw callback
 207        */
 208       virtual void drawImplementation(osg::RenderInfo& renderInfo) const
 209       {
 210         if( _attributes_dirty & PATH )
 211           return;
 212
 213         osg::State* state = renderInfo.getState();
 214         assert(state);
 215
 216         state->setActiveTextureUnit(0);
 217         state->setClientActiveTextureUnit(0);
 218         state->disableAllVertexArrays();
 219
 220         bool was_blend_enabled = state->getLastAppliedMode(GL_BLEND);
 221         bool was_stencil_enabled = state->getLastAppliedMode(GL_STENCIL_TEST);
 222
 223         // Initialize/Update the paint
 224         if( _attributes_dirty & STROKE_COLOR )
 225         {
 226           if( _paint == VG_INVALID_HANDLE )
 227             _paint = vgCreatePaint();
 228
 229           vgSetParameterfv(_paint, VG_PAINT_COLOR, 4, _stroke_color._v);
 230
 231           _attributes_dirty &= ~STROKE_COLOR;
 232         }
 233
 234         // Initialize/update fill paint
 235         if( _attributes_dirty & FILL_COLOR )
 236         {
 237           if( _paint_fill == VG_INVALID_HANDLE )
 238             _paint_fill = vgCreatePaint();
 239
 240           vgSetParameterfv(_paint_fill, VG_PAINT_COLOR, 4, _fill_color._v);
 241
 242           _attributes_dirty &= ~FILL_COLOR;
 243         }
 244
 245         // Setup paint
 246         if( _mode & VG_STROKE_PATH )
 247         {
 248           vgSetPaint(_paint, VG_STROKE_PATH);
 249
 250           vgSetf(VG_STROKE_LINE_WIDTH, _stroke_width);
 251           vgSeti(VG_STROKE_CAP_STYLE, _stroke_linecap);
 252           vgSetfv( VG_STROKE_DASH_PATTERN,
 253                    _stroke_dash.size(),
 254                    _stroke_dash.empty() ? 0 : &_stroke_dash[0] );
 255         }
 256         if( _mode & VG_FILL_PATH )
 257         {
 258           vgSetPaint(_paint_fill, VG_FILL_PATH);
 259
 260           vgSeti(VG_FILL_RULE, _fill_rule);
 261         }
 262
 263         // And finally draw the path
 264         if( _mode )
 265           vgDrawPath(_path, _mode);
 266
 267         VGErrorCode err = vgGetError();
 268         if( err != VG_NO_ERROR )
 269           SG_LOG(SG_GL, SG_ALERT, "vgError: " << err);
 270
 271         if( was_blend_enabled )   glEnable(GL_BLEND);
 272         if( was_stencil_enabled ) glEnable(GL_STENCIL_TEST);
 273       }
 274
 275       osg::BoundingBox getTransformedBounds(const osg::Matrix& mat) const
 276       {
 277         osg::BoundingBox bb;
 278
 279         osg::Vec2f cur(0, 0), // VG "Current point" (in local coordinates)
 280                    sub(0, 0); // beginning of current sub path
 281         VGubyte cmd_index = 0;
 282         for( size_t i = 0,              ci = 0;
 283                     i < _cmds.size() && ci < _coords.size();
 284                   ++i,                  ci += shCoordsPerCommand[cmd_index] )
 285         {
 286           VGubyte rel = _cmds[i] & 1,
 287                   cmd = _cmds[i] & ~1;
 288
 289           cmd_index = cmd / 2;
 290           if( cmd_index >= shNumCommands )
 291             return osg::BoundingBox();
 292
 293           const VGubyte max_coords = 3;
 294           osg::Vec2f points[max_coords];
 295           VGubyte num_coords = 0;
 296
 297           switch( cmd )
 298           {
 299             case VG_CLOSE_PATH:
 300               cur = sub;
 301               break;
 302             case VG_MOVE_TO:
 303             case VG_LINE_TO:
 304             case VG_SQUAD_TO:
 305               // x0, y0
 306               points[ num_coords++ ].set(_coords[ci], _coords[ci + 1]);
 307               break;
 308             case VG_HLINE_TO:
 309               // x0
 310               points[ num_coords++ ].set( _coords[ci] + (rel ? cur.x() : 0),
 311                                           cur.y() );
 312               // We have handled rel/abs already, so no need to do it again...
 313               rel = 0;
 314               break;
 315             case VG_VLINE_TO:
 316               // y0
 317               points[ num_coords++ ].set( cur.x(),
 318                                           _coords[ci] + (rel ? cur.y() : 0) );
 319               // We have handled rel/abs already, so no need to do it again...
 320               rel = 0;
 321               break;
 322             case VG_QUAD_TO:
 323             case VG_SCUBIC_TO:
 324               // x0,y0,x1,y1
 325               points[ num_coords++ ].set(_coords[ci    ], _coords[ci + 1]);
 326               points[ num_coords++ ].set(_coords[ci + 2], _coords[ci + 3]);
 327               break;
 328             case VG_CUBIC_TO:
 329               // x0,y0,x1,y1,x2,y2
 330               points[ num_coords++ ].set(_coords[ci    ], _coords[ci + 1]);
 331               points[ num_coords++ ].set(_coords[ci + 2], _coords[ci + 3]);
 332               points[ num_coords++ ].set(_coords[ci + 4], _coords[ci + 5]);
 333               break;
 334             case VG_SCCWARC_TO:
 335             case VG_SCWARC_TO:
 336             case VG_LCCWARC_TO:
 337             case VG_LCWARC_TO:
 338               // rh,rv,rot,x0,y0
 339               points[ num_coords++ ].set(_coords[ci + 3], _coords[ci + 4]);
 340               break;
 341             default:
 342               SG_LOG(SG_GL, SG_WARN, "Unknown VG command: " << (int)cmd);
 343               return osg::BoundingBox();
 344           }
 345
 346           assert(num_coords <= max_coords);
 347           for(VGubyte i = 0; i < num_coords; ++i)
 348           {
 349             if( rel )
 350               points[i] += cur;
 351
 352             bb.expandBy( transformPoint(mat, points[i]) );
 353           }
 354
 355           if( num_coords > 0 )
 356           {
 357             cur = points[ num_coords - 1 ];
 358
 359             if( cmd == VG_MOVE_TO )
 360               sub = cur;
 361           }
 362         }
 363
 364         return bb;
 365       }
 366
 367       /**
 368        * Compute the bounding box
 369        */
 370       virtual osg::BoundingBox computeBound() const
 371       {
 372         if( _path == VG_INVALID_HANDLE || (_attributes_dirty & PATH) )
 373           return osg::BoundingBox();
 374
 375         VGfloat min[2], size[2];
 376         vgPathBounds(_path, &min[0], &min[1], &size[0], &size[1]);
 377
 378         _attributes_dirty &= ~BOUNDING_BOX;
 379
 380         // vgPathBounds doesn't take stroke width into account
 381         float ext = 0.5 * _stroke_width;
 382
 383         return osg::BoundingBox
 384         (
 385           min[0] - ext,           min[1] - ext,           -0.1,
 386           min[0] + size[0] + ext, min[1] + size[1] + ext,  0.1
 387         );
 388       }
 389
 390     private:
 391
 392       enum Attributes
 393       {
 394         PATH            = 0x0001,
 395         STROKE_COLOR    = PATH << 1,
 396         FILL_COLOR      = STROKE_COLOR << 1,
 397         BOUNDING_BOX    = FILL_COLOR << 1
 398       };
 399
 400       Path *_path_element;
 401
 402       mutable VGPath    _path;
 403       mutable VGPaint   _paint;
 404       mutable VGPaint   _paint_fill;
 405       mutable uint32_t  _attributes_dirty;
 406
 407       CmdList   _cmds;
 408       CoordList _coords;
 409
 410       VGbitfield            _mode;
 411       osg::Vec4f            _fill_color;
 412       VGFillRule            _fill_rule;
 413       osg::Vec4f            _stroke_color;
 414       VGfloat               _stroke_width;
 415       std::vector<VGfloat>  _stroke_dash;
 416       VGCapStyle            _stroke_linecap;
 417
 418       osg::Vec3f transformPoint( const osg::Matrix& m,
 419                                  osg::Vec2f pos ) const
 420       {
 421         return osg::Vec3
 422         (
 423           m(0, 0) * pos[0] + m(1, 0) * pos[1] + m(3, 0),
 424           m(0, 1) * pos[0] + m(1, 1) * pos[1] + m(3, 1),
 425           0
 426         );
 427       }
 428
 429       /**
 430        * Initialize/Update the OpenVG path
 431        */
 432       void update()
 433       {
 434         if( !vgHasContextSH() )
 435           return;
 436
 437         if( _attributes_dirty & PATH )
 438         {
 439           const VGbitfield caps = VG_PATH_CAPABILITY_APPEND_TO
 440                                 | VG_PATH_CAPABILITY_MODIFY
 441                                 | VG_PATH_CAPABILITY_PATH_BOUNDS;
 442
 443           if( _path == VG_INVALID_HANDLE )
 444             _path = vgCreatePath(
 445               VG_PATH_FORMAT_STANDARD,
 446               VG_PATH_DATATYPE_F,
 447               1.f, 0.f, // scale,bias
 448               _cmds.size(), _coords.size(),
 449               caps
 450             );
 451           else
 452             vgClearPath(_path, caps);
 453
 454           if( !_cmds.empty() && !_coords.empty() )
 455             vgAppendPathData(_path, _cmds.size(), &_cmds[0], &_coords[0]);
 456
 457           _attributes_dirty &= ~PATH;
 458           _attributes_dirty |= BOUNDING_BOX;
 459         }
 460
 461         if( _attributes_dirty & BOUNDING_BOX )
 462         {
 463           dirtyBound();
 464
 465           // Recalculate bounding box now (prevent race condition)
 466           getBound();
 467         }
 468       }
 469
 470       struct PathUpdateCallback:
 471         public osg::Drawable::UpdateCallback
 472       {
 473         virtual void update(osg::NodeVisitor*, osg::Drawable* drawable)
 474         {
 475           static_cast<PathDrawable*>(drawable)->update();
 476         }
 477       };
 478   };
 479
 480   //----------------------------------------------------------------------------
 481   const std::string Path::TYPE_NAME = "path";
 482
 483   //----------------------------------------------------------------------------
 484   void Path::staticInit()
 485   {
 486     if( isInit<Path>() )
 487       return;
 488
 489     PathDrawableRef Path::*path = &Path::_path;
 490
 491     addStyle("fill", "color", &PathDrawable::setFill, path);
 492     addStyle("fill-rule", "", &PathDrawable::setFillRule, path);
 493     addStyle("stroke", "color", &PathDrawable::setStroke, path);
 494     addStyle("stroke-width", "numeric", &PathDrawable::setStrokeWidth, path);
 495     addStyle("stroke-dasharray", "", &PathDrawable::setStrokeDashArray, path);
 496     addStyle("stroke-linecap", "", &PathDrawable::setStrokeLinecap, path);
 497   }
 498
 499   //----------------------------------------------------------------------------
 500   Path::Path( const CanvasWeakPtr& canvas,
 501               const SGPropertyNode_ptr& node,
 502               const Style& parent_style,
 503               Element* parent ):
 504     Element(canvas, node, parent_style, parent),
 505     _path( new PathDrawable(this) )
 506   {
 507     staticInit();
 508
 509     setDrawable(_path);
 510     setupStyle();
 511   }
 512
 513   //----------------------------------------------------------------------------
 514   Path::~Path()
 515   {
 516
 517   }
 518
 519   //----------------------------------------------------------------------------
 520   void Path::update(double dt)
 521   {
 522     if( _attributes_dirty & (CMDS | COORDS) )
 523     {
 524       _path->setSegments
 525       (
 526         _node->getChildValues<VGubyte, int>("cmd"),
 527         _node->getChildValues<VGfloat, float>("coord")
 528       );
 529
 530       _attributes_dirty &= ~(CMDS | COORDS);
 531     }
 532
 533     Element::update(dt);
 534   }
 535
 536   //----------------------------------------------------------------------------
 537   osg::BoundingBox Path::getTransformedBounds(const osg::Matrix& m) const
 538   {
 539     return _path->getTransformedBounds(m);
 540   }
 541
 542   //----------------------------------------------------------------------------
 543   Path& Path::moveTo(float x_abs, float y_abs)
 544   {
 545     return addSegment(VG_MOVE_TO_ABS, x_abs, y_abs);
 546   }
 547
 548   //----------------------------------------------------------------------------
 549   Path& Path::move(float x_rel, float y_rel)
 550   {
 551     return addSegment(VG_MOVE_TO_REL, x_rel, y_rel);
 552   }
 553
 554   //----------------------------------------------------------------------------
 555   Path& Path::lineTo(float x_abs, float y_abs)
 556   {
 557     return addSegment(VG_LINE_TO_ABS, x_abs, y_abs);
 558   }
 559
 560   //----------------------------------------------------------------------------
 561   Path& Path::line(float x_rel, float y_rel)
 562   {
 563     return addSegment(VG_LINE_TO_REL, x_rel, y_rel);
 564   }
 565
 566   //----------------------------------------------------------------------------
 567   Path& Path::horizTo(float x_abs)
 568   {
 569     return addSegment(VG_HLINE_TO_ABS, x_abs);
 570   }
 571
 572   //----------------------------------------------------------------------------
 573   Path& Path::horiz(float x_rel)
 574   {
 575     return addSegment(VG_HLINE_TO_REL, x_rel);
 576   }
 577
 578   //----------------------------------------------------------------------------
 579   Path& Path::vertTo(float y_abs)
 580   {
 581     return addSegment(VG_VLINE_TO_ABS, y_abs);
 582   }
 583
 584   //----------------------------------------------------------------------------
 585   Path& Path::vert(float y_rel)
 586   {
 587     return addSegment(VG_VLINE_TO_REL, y_rel);
 588   }
 589
 590   //----------------------------------------------------------------------------
 591   Path& Path::close()
 592   {
 593     return addSegment(VG_CLOSE_PATH);
 594   }
 595
 596   //----------------------------------------------------------------------------
 597   void Path::childRemoved(SGPropertyNode* child)
 598   {
 599     childChanged(child);
 600   }
 601
 602   //----------------------------------------------------------------------------
 603   void Path::childChanged(SGPropertyNode* child)
 604   {
 605     if( child->getParent() != _node )
 606       return;
 607
 608     if( child->getNameString() == "cmd" )
 609       _attributes_dirty |= CMDS;
 610     else if( child->getNameString() == "coord" )
 611       _attributes_dirty |= COORDS;
 612   }
 613
 614   //----------------------------------------------------------------------------
 615   std::vector<float> splitAndConvert(const char del[], const std::string& str)
 616   {
 617     std::vector<float> values;
 618     size_t pos = 0;
 619     for(;;)
 620     {
 621       pos = str.find_first_not_of(del, pos);
 622       if( pos == std::string::npos )
 623         break;
 624
 625       char *end = 0;
 626       float val = strtod(&str[pos], &end);
 627       if( end == &str[pos] || !end )
 628         break;
 629
 630       values.push_back(val);
 631       pos = end - &str[0];
 632     }
 633     return values;
 634   }
 635
 636 } // namespace canvas
 637 } // namespace simgear