lib/connectionpoint.h

   1 /* Dia -- an diagram creation/manipulation program
   2  * Copyright (C) 1998 Alexander Larsson
   3  *
   4  * This program is free software; you can redistribute it and/or modify
   5  * it under the terms of the GNU General Public License as published by
   6  * the Free Software Foundation; either version 2 of the License, or
   7  * (at your option) any later version.
   8  *
   9  * This program is distributed in the hope that it will be useful,
  10  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  11  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  12  * GNU General Public License for more details.
  13  *
  14  * You should have received a copy of the GNU General Public License
  15  * along with this program; if not, write to the Free Software
  16  * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
  17  */
  18 #ifndef CONNECTIONPOINT_H
  19 #define CONNECTIONPOINT_H
  20
  21 #include "diatypes.h"
  22 #include <glib.h>
  23
  24 #define CONNECTIONPOINT_SIZE 5
  25 #define CHANGED_TRESHOLD 0.001
  26
  27 #include "geometry.h"
  28 #include "object.h"
  29
  30 /* Connections directions, used as hints to zigzaglines */
  31 /* Ordered this way to let *2 be rotate clockwise, /2 rotate counterclockwise.
  32  * Used as bits */
  33 #define DIR_NORTH 1
  34 #define DIR_EAST  2
  35 #define DIR_SOUTH 4
  36 #define DIR_WEST  8
  37
  38 /* Convenience directions */
  39 #define DIR_NORTHEAST (DIR_NORTH|DIR_EAST)
  40 #define DIR_SOUTHEAST (DIR_SOUTH|DIR_EAST)
  41 #define DIR_NORTHWEST (DIR_NORTH|DIR_WEST)
  42 #define DIR_SOUTHWEST (DIR_SOUTH|DIR_WEST)
  43 #define DIR_NONE      0
  44 #define DIR_ALL       (DIR_NORTH|DIR_SOUTH|DIR_EAST|DIR_WEST)
  45
  46 #define CP_FLAG_ANYPLACE        1 /* Set if this connpoint is the one that
  47                                      is connected to when a connection is
  48                                      dropped on an object. */
  49 #define CP_FLAG_AUTOGAP         2 /* Set if this connpoint is internal
  50                                      and so should force a gap on the lines. */
  51
  52 /* Most non-connection objects want exactly one CP with this, in the middle. */
  53 #define CP_FLAGS_MAIN           3 /* Use this for the central CP that
  54                                      takes connections from all over the
  55                                      object and has autogap. */
  56
  57 struct _ConnectionPoint {
  58   Point pos;         /* position of this connection point */
  59   Point last_pos;    /* Used by update_connections_xxx only. */
  60   DiaObject *object;    /* pointer to the object having this point */
  61   GList *connected;  /* list of 'DiaObject *' connected to this point*/
  62   gchar directions;  /* Directions that this connection point is open to */
  63   gchar *name;       /* Name of this connpoint, NULL means uses number only.*/
  64   guint8 flags;      /* Flags set for this connpoint.  See CP_FLAGS_* above. */
  65 };
  66
  67 /* Returns the available directions on a slope.
  68  * The right-hand side of the line is assumed to be within the object,
  69  * and thus not available. */
  70 gint find_slope_directions(Point from, Point to);
  71 /** Update the object-settable parts of a connectionpoints.
  72  * p: A ConnectionPoint pointer (non-NULL).
  73  * x: The x coordinate of the connectionpoint.
  74  * y: The y coordinate of the connectionpoint.
  75  * dirs: The directions that are open for connections on this point.
  76  */
  77 void connpoint_update(ConnectionPoint *p, real x, real y, gint dirs);
  78
  79 gboolean connpoint_is_autogap(ConnectionPoint *cp);
  80
  81
  82 #endif /* CONNECTIONPOINT_H */