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 /*! \file connectionpoint.h -- Connection Points together with Handles allow to connect objects */
  19 #ifndef CONNECTIONPOINT_H
  20 #define CONNECTIONPOINT_H
  21
  22 #include "diatypes.h"
  23 #include <glib.h>
  24 #include "geometry.h"
  25
  26 #define CONNECTIONPOINT_SIZE 5
  27 #define CHANGED_TRESHOLD 0.001
  28
  29 /* Connections directions, used as hints to zigzaglines */
  30 /* Ordered this way to let *2 be rotate clockwise, /2 rotate counterclockwise.
  31  * Used as bits */
  32 #define DIR_NORTH 1
  33 #define DIR_EAST  2
  34 #define DIR_SOUTH 4
  35 #define DIR_WEST  8
  36
  37 /* Convenience directions */
  38 #define DIR_NORTHEAST (DIR_NORTH|DIR_EAST)
  39 #define DIR_SOUTHEAST (DIR_SOUTH|DIR_EAST)
  40 #define DIR_NORTHWEST (DIR_NORTH|DIR_WEST)
  41 #define DIR_SOUTHWEST (DIR_SOUTH|DIR_WEST)
  42 #define DIR_NONE      0
  43 #define DIR_ALL       (DIR_NORTH|DIR_SOUTH|DIR_EAST|DIR_WEST)
  44
  45 #define CP_FLAG_ANYPLACE        1 /*!< Set if this connpoint is the one that
  46                                      is connected to when a connection is
  47                                      dropped on an object. */
  48 #define CP_FLAG_AUTOGAP         2 /*!< Set if this connpoint is internal
  49                                      and so should force a gap on the lines. */
  50
  51 /*! Most non-connection objects want exactly one CP with this, in the middle. */
  52 #define CP_FLAGS_MAIN           3 /*!< Use this for the central CP that
  53                                      takes connections from all over the
  54                                      object and has autogap. */
  55
  56 /*!
  57  * \brief To connect object with other objects handles
  58  */
  59 struct _ConnectionPoint {
  60   Point pos;         /*!< position of this connection point */
  61   Point last_pos;    /*!< Used by update_connections_xxx only. */
  62   DiaObject *object; /*!< pointer to the object having this point */
  63   GList *connected;  /*!< list of 'DiaObject *' connected to this point*/
  64   gchar directions;  /*!< Directions that this connection point is open to */
  65   gchar *name;       /*!< Name of this connpoint, NULL means uses number only.*/
  66   guint8 flags;      /*!< Flags set for this connpoint.  See CP_FLAGS_* above. */
  67 };
  68
  69 /**
  70  * Returns the available directions on a slope.
  71  * The right-hand side of the line is assumed to be within the object,
  72  * and thus not available.
  73  */
  74 gint find_slope_directions(Point from, Point to);
  75 /** Update the object-settable parts of a connectionpoints.
  76  * p: A ConnectionPoint pointer (non-NULL).
  77  * x: The x coordinate of the connectionpoint.
  78  * y: The y coordinate of the connectionpoint.
  79  * dirs: The directions that are open for connections on this point.
  80  */
  81 void connpoint_update(ConnectionPoint *p, real x, real y, gint dirs);
  82
  83 gboolean connpoint_is_autogap(ConnectionPoint *cp);
  84
  85
  86 #endif /* CONNECTIONPOINT_H */