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         glPushAttrib(~0u); // Don't use GL_ALL_ATTRIB_BITS as on my machine it
 221                            // eg. doesn't include GL_MULTISAMPLE_BIT
 222         glPushClientAttrib(~0u);
 223
 224         // Initialize/Update the paint
 225         if( _attributes_dirty & STROKE_COLOR )
 226         {
 227           if( _paint == VG_INVALID_HANDLE )
 228             _paint = vgCreatePaint();
 229
 230           vgSetParameterfv(_paint, VG_PAINT_COLOR, 4, _stroke_color._v);
 231
 232           _attributes_dirty &= ~STROKE_COLOR;
 233         }
 234
 235         // Initialize/update fill paint
 236         if( _attributes_dirty & FILL_COLOR )
 237         {
 238           if( _paint_fill == VG_INVALID_HANDLE )
 239             _paint_fill = vgCreatePaint();
 240
 241           vgSetParameterfv(_paint_fill, VG_PAINT_COLOR, 4, _fill_color._v);
 242
 243           _attributes_dirty &= ~FILL_COLOR;
 244         }
 245
 246         // Setup paint
 247         if( _mode & VG_STROKE_PATH )
 248         {
 249           vgSetPaint(_paint, VG_STROKE_PATH);
 250
 251           vgSetf(VG_STROKE_LINE_WIDTH, _stroke_width);
 252           vgSeti(VG_STROKE_CAP_STYLE, _stroke_linecap);
 253           vgSetfv( VG_STROKE_DASH_PATTERN,
 254                    _stroke_dash.size(),
 255                    _stroke_dash.empty() ? 0 : &_stroke_dash[0] );
 256         }
 257         if( _mode & VG_FILL_PATH )
 258         {
 259           vgSetPaint(_paint_fill, VG_FILL_PATH);
 260
 261           vgSeti(VG_FILL_RULE, _fill_rule);
 262         }
 263
 264         // And finally draw the path
 265         if( _mode )
 266           vgDrawPath(_path, _mode);
 267
 268         VGErrorCode err = vgGetError();
 269         if( err != VG_NO_ERROR )
 270           SG_LOG(SG_GL, SG_ALERT, "vgError: " << err);
 271
 272         glPopAttrib();
 273         glPopClientAttrib();
 274       }
 275
 276       osg::BoundingBox getTransformedBounds(const osg::Matrix& mat) const
 277       {
 278         osg::BoundingBox bb;
 279
 280         osg::Vec2f cur(0, 0), // VG "Current point" (in local coordinates)
 281                    sub(0, 0); // beginning of current sub path
 282         VGubyte cmd_index = 0;
 283         for( size_t i = 0,              ci = 0;
 284                     i < _cmds.size() && ci < _coords.size();
 285                   ++i,                  ci += shCoordsPerCommand[cmd_index] )
 286         {
 287           VGubyte rel = _cmds[i] & 1,
 288                   cmd = _cmds[i] & ~1;
 289
 290           cmd_index = cmd / 2;
 291           if( cmd_index >= shNumCommands )
 292             return osg::BoundingBox();
 293
 294           const VGubyte max_coords = 3;
 295           osg::Vec2f points[max_coords];
 296           VGubyte num_coords = 0;
 297
 298           switch( cmd )
 299           {
 300             case VG_CLOSE_PATH:
 301               cur = sub;
 302               break;
 303             case VG_MOVE_TO:
 304             case VG_LINE_TO:
 305             case VG_SQUAD_TO:
 306               // x0, y0
 307               points[ num_coords++ ].set(_coords[ci], _coords[ci + 1]);
 308               break;
 309             case VG_HLINE_TO:
 310               // x0
 311               points[ num_coords++ ].set( _coords[ci] + (rel ? cur.x() : 0),
 312                                           cur.y() );
 313               // We have handled rel/abs already, so no need to do it again...
 314               rel = 0;
 315               break;
 316             case VG_VLINE_TO:
 317               // y0
 318               points[ num_coords++ ].set( cur.x(),
 319                                           _coords[ci] + (rel ? cur.y() : 0) );
 320               // We have handled rel/abs already, so no need to do it again...
 321               rel = 0;
 322               break;
 323             case VG_QUAD_TO:
 324             case VG_SCUBIC_TO:
 325               // x0,y0,x1,y1
 326               points[ num_coords++ ].set(_coords[ci    ], _coords[ci + 1]);
 327               points[ num_coords++ ].set(_coords[ci + 2], _coords[ci + 3]);
 328               break;
 329             case VG_CUBIC_TO:
 330               // x0,y0,x1,y1,x2,y2
 331               points[ num_coords++ ].set(_coords[ci    ], _coords[ci + 1]);
 332               points[ num_coords++ ].set(_coords[ci + 2], _coords[ci + 3]);
 333               points[ num_coords++ ].set(_coords[ci + 4], _coords[ci + 5]);
 334               break;
 335             case VG_SCCWARC_TO:
 336             case VG_SCWARC_TO:
 337             case VG_LCCWARC_TO:
 338             case VG_LCWARC_TO:
 339               // rh,rv,rot,x0,y0
 340               points[ num_coords++ ].set(_coords[ci + 3], _coords[ci + 4]);
 341               break;
 342             default:
 343               SG_LOG(SG_GL, SG_WARN, "Unknown VG command: " << (int)cmd);
 344               return osg::BoundingBox();
 345           }
 346
 347           assert(num_coords <= max_coords);
 348           for(VGubyte i = 0; i < num_coords; ++i)
 349           {
 350             if( rel )
 351               points[i] += cur;
 352
 353             bb.expandBy( transformPoint(mat, points[i]) );
 354           }
 355
 356           if( num_coords > 0 )
 357           {
 358             cur = points[ num_coords - 1 ];
 359
 360             if( cmd == VG_MOVE_TO )
 361               sub = cur;
 362           }
 363         }
 364
 365         return bb;
 366       }
 367
 368       /**
 369        * Compute the bounding box
 370        */
 371       virtual osg::BoundingBox computeBound() const
 372       {
 373         if( _path == VG_INVALID_HANDLE || (_attributes_dirty & PATH) )
 374           return osg::BoundingBox();
 375
 376         VGfloat min[2], size[2];
 377         vgPathBounds(_path, &min[0], &min[1], &size[0], &size[1]);
 378
 379         _attributes_dirty &= ~BOUNDING_BOX;
 380
 381         // vgPathBounds doesn't take stroke width into account
 382         float ext = 0.5 * _stroke_width;
 383
 384         osg::BoundingBox bb
 385         (
 386           min[0] - ext,           min[1] - ext,           -0.1,
 387           min[0] + size[0] + ext, min[1] + size[1] + ext,  0.1
 388         );
 389         _path_element->setBoundingBox(bb);
 390
 391         return bb;
 392       }
 393
 394     private:
 395
 396       enum Attributes
 397       {
 398         PATH            = 0x0001,
 399         STROKE_COLOR    = PATH << 1,
 400         FILL_COLOR      = STROKE_COLOR << 1,
 401         BOUNDING_BOX    = FILL_COLOR << 1
 402       };
 403
 404       Path *_path_element;
 405
 406       mutable VGPath    _path;
 407       mutable VGPaint   _paint;
 408       mutable VGPaint   _paint_fill;
 409       mutable uint32_t  _attributes_dirty;
 410
 411       CmdList   _cmds;
 412       CoordList _coords;
 413
 414       VGbitfield            _mode;
 415       osg::Vec4f            _fill_color;
 416       VGFillRule            _fill_rule;
 417       osg::Vec4f            _stroke_color;
 418       VGfloat               _stroke_width;
 419       std::vector<VGfloat>  _stroke_dash;
 420       VGCapStyle            _stroke_linecap;
 421
 422       osg::Vec3f transformPoint( const osg::Matrix& m,
 423                                  osg::Vec2f pos ) const
 424       {
 425         return osg::Vec3
 426         (
 427           m(0, 0) * pos[0] + m(1, 0) * pos[1] + m(3, 0),
 428           m(0, 1) * pos[0] + m(1, 1) * pos[1] + m(3, 1),
 429           0
 430         );
 431       }
 432
 433       /**
 434        * Initialize/Update the OpenVG path
 435        */
 436       void update()
 437       {
 438         if( !vgHasContextSH() )
 439           return;
 440
 441         if( _attributes_dirty & PATH )
 442         {
 443           const VGbitfield caps = VG_PATH_CAPABILITY_APPEND_TO
 444                                 | VG_PATH_CAPABILITY_MODIFY
 445                                 | VG_PATH_CAPABILITY_PATH_BOUNDS;
 446
 447           if( _path == VG_INVALID_HANDLE )
 448             _path = vgCreatePath(
 449               VG_PATH_FORMAT_STANDARD,
 450               VG_PATH_DATATYPE_F,
 451               1.f, 0.f, // scale,bias
 452               _cmds.size(), _coords.size(),
 453               caps
 454             );
 455           else
 456             vgClearPath(_path, caps);
 457
 458           if( !_cmds.empty() && !_coords.empty() )
 459             vgAppendPathData(_path, _cmds.size(), &_cmds[0], &_coords[0]);
 460
 461           _attributes_dirty &= ~PATH;
 462           _attributes_dirty |= BOUNDING_BOX;
 463         }
 464
 465         if( _attributes_dirty & BOUNDING_BOX )
 466           dirtyBound();
 467       }
 468
 469       struct PathUpdateCallback:
 470         public osg::Drawable::UpdateCallback
 471       {
 472         virtual void update(osg::NodeVisitor*, osg::Drawable* drawable)
 473         {
 474           static_cast<PathDrawable*>(drawable)->update();
 475         }
 476       };
 477   };
 478
 479   //----------------------------------------------------------------------------
 480   const std::string Path::TYPE_NAME = "path";
 481
 482   //----------------------------------------------------------------------------
 483   void Path::staticInit()
 484   {
 485     if( isInit<Path>() )
 486       return;
 487
 488     PathDrawableRef Path::*path = &Path::_path;
 489
 490     addStyle("fill", "color", &PathDrawable::setFill, path);
 491     addStyle("fill-rule", "", &PathDrawable::setFillRule, path);
 492     addStyle("stroke", "color", &PathDrawable::setStroke, path);
 493     addStyle("stroke-width", "numeric", &PathDrawable::setStrokeWidth, path);
 494     addStyle("stroke-dasharray", "", &PathDrawable::setStrokeDashArray, path);
 495     addStyle("stroke-linecap", "", &PathDrawable::setStrokeLinecap, path);
 496   }
 497
 498   //----------------------------------------------------------------------------
 499   Path::Path( const CanvasWeakPtr& canvas,
 500               const SGPropertyNode_ptr& node,
 501               const Style& parent_style,
 502               Element* parent ):
 503     Element(canvas, node, parent_style, parent),
 504     _path( new PathDrawable(this) )
 505   {
 506     staticInit();
 507
 508     setDrawable(_path);
 509     setupStyle();
 510   }
 511
 512   //----------------------------------------------------------------------------
 513   Path::~Path()
 514   {
 515
 516   }
 517
 518   //----------------------------------------------------------------------------
 519   void Path::update(double dt)
 520   {
 521     if( _attributes_dirty & (CMDS | COORDS) )
 522     {
 523       _path->setSegments
 524       (
 525         _node->getChildValues<VGubyte, int>("cmd"),
 526         _node->getChildValues<VGfloat, float>("coord")
 527       );
 528
 529       _attributes_dirty &= ~(CMDS | COORDS);
 530     }
 531
 532     Element::update(dt);
 533   }
 534
 535   //----------------------------------------------------------------------------
 536   osg::BoundingBox Path::getTransformedBounds(const osg::Matrix& m) const
 537   {
 538     return _path->getTransformedBounds(m);
 539   }
 540
 541   //----------------------------------------------------------------------------
 542   Path& Path::moveTo(float x_abs, float y_abs)
 543   {
 544     return addSegment(VG_MOVE_TO_ABS, x_abs, y_abs);
 545   }
 546
 547   //----------------------------------------------------------------------------
 548   Path& Path::move(float x_rel, float y_rel)
 549   {
 550     return addSegment(VG_MOVE_TO_REL, x_rel, y_rel);
 551   }
 552
 553   //----------------------------------------------------------------------------
 554   Path& Path::lineTo(float x_abs, float y_abs)
 555   {
 556     return addSegment(VG_LINE_TO_ABS, x_abs, y_abs);
 557   }
 558
 559   //----------------------------------------------------------------------------
 560   Path& Path::line(float x_rel, float y_rel)
 561   {
 562     return addSegment(VG_LINE_TO_REL, x_rel, y_rel);
 563   }
 564
 565   //----------------------------------------------------------------------------
 566   Path& Path::horizTo(float x_abs)
 567   {
 568     return addSegment(VG_HLINE_TO_ABS, x_abs);
 569   }
 570
 571   //----------------------------------------------------------------------------
 572   Path& Path::horiz(float x_rel)
 573   {
 574     return addSegment(VG_HLINE_TO_REL, x_rel);
 575   }
 576
 577   //----------------------------------------------------------------------------
 578   Path& Path::vertTo(float y_abs)
 579   {
 580     return addSegment(VG_VLINE_TO_ABS, y_abs);
 581   }
 582
 583   //----------------------------------------------------------------------------
 584   Path& Path::vert(float y_rel)
 585   {
 586     return addSegment(VG_VLINE_TO_REL, y_rel);
 587   }
 588
 589   //----------------------------------------------------------------------------
 590   Path& Path::close()
 591   {
 592     return addSegment(VG_CLOSE_PATH);
 593   }
 594
 595   //----------------------------------------------------------------------------
 596   void Path::childRemoved(SGPropertyNode* child)
 597   {
 598     childChanged(child);
 599   }
 600
 601   //----------------------------------------------------------------------------
 602   void Path::childChanged(SGPropertyNode* child)
 603   {
 604     if( child->getParent() != _node )
 605       return;
 606
 607     if( child->getNameString() == "cmd" )
 608       _attributes_dirty |= CMDS;
 609     else if( child->getNameString() == "coord" )
 610       _attributes_dirty |= COORDS;
 611   }
 612
 613   //----------------------------------------------------------------------------
 614   std::vector<float> splitAndConvert(const char del[], const std::string& str)
 615   {
 616     std::vector<float> values;
 617     size_t pos = 0;
 618     for(;;)
 619     {
 620       pos = str.find_first_not_of(del, pos);
 621       if( pos == std::string::npos )
 622         break;
 623
 624       char *end = 0;
 625       float val = strtod(&str[pos], &end);
 626       if( end == &str[pos] || !end )
 627         break;
 628
 629       values.push_back(val);
 630       pos = end - &str[0];
 631     }
 632     return values;
 633   }
 634
 635 } // namespace canvas
 636 } // namespace simgear