libs/canvas/canvas/arrow.h

   1 /*
   2     Copyright (C) 2011 Paul Davis
   3     Author: Carl Hetherington <cth@carlh.net>
   4
   5     This program is free software; you can redistribute it and/or modify
   6     it under the terms of the GNU General Public License as published by
   7     the Free Software Foundation; either version 2 of the License, or
   8     (at your option) any later version.
   9
  10     This program 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
  13     GNU 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., 675 Mass Ave, Cambridge, MA 02139, USA.
  18
  19 */
  20
  21 /** @file  canvas/arrow.h
  22  *  @brief Declaration of the Arrow canvas object.
  23  */
  24
  25 #ifndef __CANVAS_ARROW_H__
  26 #define __CANVAS_ARROW_H__
  27
  28 #include "canvas/visibility.h"
  29
  30 #include "canvas/group.h"
  31
  32 namespace ArdourCanvas {
  33
  34 class Line;
  35 class Polygon;
  36
  37 /** A composite item which draws a line with arrow heads
  38  *  at either or both ends.
  39  *
  40  *  The arrow heads are identified by the indices 0 and 1;
  41  *  head 0 is at the (x0, y0) end of the line, and head 1
  42  *  at the (x1, y1) end.
  43  *
  44  *  @todo Draws vertical lines only; could be generalised
  45  *  to draw lines at any angle.
  46  */
  47
  48 class LIBCANVAS_API Arrow : public Group
  49 {
  50 public:
  51         Arrow (Group *);
  52
  53         void set_show_head (int, bool);
  54         void set_head_outward (int, bool);
  55         void set_head_height (int, Distance);
  56         void set_head_width (int, Distance);
  57         void set_outline_width (Distance);
  58         void set_color (Color);
  59
  60         Coord x () const;
  61         Coord y1 () const;
  62
  63         void set_x (Coord);
  64         void set_y0 (Coord);
  65         void set_y1 (Coord);
  66
  67         bool covers (Duple const &) const;
  68
  69 private:
  70         void setup_polygon (int);
  71
  72         /** Representation of a single arrow head */
  73         struct Head {
  74                 Polygon* polygon; ///< the polygon which represents its shape
  75                 bool show;        ///< true if this head should be visible
  76                 bool outward;     ///< true if this head points out from the line
  77                 Distance height;  ///< the height of the head
  78                 Distance width;   ///< the maximum width of the head
  79         };
  80
  81         /** our arrow heads; _heads[0] is at the (x0, y0) end of the line,
  82          *  and _heads[1] at the (x1, y1) end.
  83          */
  84         Head _heads[2];
  85
  86         /** our line */
  87         Line* _line;
  88 };
  89
  90 }
  91
  92 #endif