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 Canvas;
  35 class Line;
  36 class Polygon;
  37
  38 /** A composite item which draws a line with arrow heads
  39  *  at either or both ends.
  40  *
  41  *  The arrow heads are identified by the indices 0 and 1;
  42  *  head 0 is at the (x0, y0) end of the line, and head 1
  43  *  at the (x1, y1) end.
  44  *
  45  *  @todo Draws vertical lines only; could be generalised
  46  *  to draw lines at any angle.
  47  */
  48
  49 class LIBCANVAS_API Arrow : public Group
  50 {
  51 public:
  52         Arrow (Canvas*);
  53         Arrow (Group*);
  54
  55         void set_show_head (int, bool);
  56         void set_head_outward (int, bool);
  57         void set_head_height (int, Distance);
  58         void set_head_width (int, Distance);
  59         void set_outline_width (Distance);
  60         void set_color (Color);
  61
  62         Coord x () const;
  63         Coord y1 () const;
  64
  65         void set_x (Coord);
  66         void set_y0 (Coord);
  67         void set_y1 (Coord);
  68
  69         bool covers (Duple const &) const;
  70
  71 private:
  72         void setup_polygon (int);
  73         void setup ();
  74
  75         /** Representation of a single arrow head */
  76         struct Head {
  77                 Polygon* polygon; ///< the polygon which represents its shape
  78                 bool outward;     ///< true if this head points out from the line
  79                 Distance height;  ///< the height of the head
  80                 Distance width;   ///< the maximum width of the head
  81         };
  82
  83         /** our arrow heads; _heads[0] is at the (x0, y0) end of the line,
  84          *  and _heads[1] at the (x1, y1) end.
  85          */
  86         Head _heads[2];
  87
  88         /** our line */
  89         Line* _line;
  90 };
  91
  92 }
  93
  94 #endif