|
f@0
|
1 /*
|
|
f@0
|
2 CCmI Editor - A Collaborative Cross-Modal Diagram Editing Tool
|
|
f@0
|
3
|
|
f@0
|
4 Copyright (C) 2011 Queen Mary University of London (http://ccmi.eecs.qmul.ac.uk/)
|
|
f@0
|
5
|
|
f@0
|
6 This program is free software: you can redistribute it and/or modify
|
|
f@0
|
7 it under the terms of the GNU General Public License as published by
|
|
f@0
|
8 the Free Software Foundation, either version 3 of the License, or
|
|
f@0
|
9 (at your option) any later version.
|
|
f@0
|
10
|
|
f@0
|
11 This program is distributed in the hope that it will be useful,
|
|
f@0
|
12 but WITHOUT ANY WARRANTY; without even the implied warranty of
|
|
f@0
|
13 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
|
f@0
|
14 GNU General Public License for more details.
|
|
f@0
|
15
|
|
f@0
|
16 You should have received a copy of the GNU General Public License
|
|
f@0
|
17 along with this program. If not, see <http://www.gnu.org/licenses/>.
|
|
f@0
|
18 */
|
|
f@0
|
19 package uk.ac.qmul.eecs.ccmi.gui;
|
|
f@0
|
20
|
|
f@0
|
21 import java.awt.Graphics2D;
|
|
f@0
|
22 import java.awt.geom.Point2D;
|
|
f@0
|
23 import java.awt.geom.Rectangle2D;
|
|
f@0
|
24
|
|
f@0
|
25
|
|
f@0
|
26 /**
|
|
f@0
|
27 * An interface implemented by {@code Node}, {@code Edge} and {@code Edge.InnerPoint}. It defines methods that
|
|
f@0
|
28 * all objects painted on a graph share. The interface is used mainly
|
|
f@0
|
29 * for convenience in treating the different types of object in a uniformly.
|
|
f@0
|
30 *
|
|
f@0
|
31 */
|
|
f@0
|
32 public interface GraphElement {
|
|
f@0
|
33 /**
|
|
f@0
|
34 * Draw the graphic element on a canvas
|
|
f@0
|
35 *
|
|
f@0
|
36 * @param g2 the graphics object. Use {@code g2.draw()} to get things painted on the graph.
|
|
f@0
|
37 */
|
|
f@0
|
38 public void draw(Graphics2D g2);
|
|
f@0
|
39
|
|
f@0
|
40 /**
|
|
f@0
|
41 * Translates this graphic element on the graph
|
|
f@0
|
42 *
|
|
f@0
|
43 * @param p the starting point where the translation starts (normally where the user clicks
|
|
f@0
|
44 * with their mouse)
|
|
f@0
|
45 * @param dx the distance to translate along the x-axis
|
|
f@0
|
46 * @param dy the distance to translate along the y-axis
|
|
f@0
|
47 * @param source the source of the translate action
|
|
f@0
|
48 */
|
|
f@0
|
49 public void translate(Point2D p, double dx, double dy, Object source);
|
|
f@0
|
50
|
|
f@0
|
51 /**
|
|
f@0
|
52 * This method is to be called before translation or any other operation that changes the
|
|
f@0
|
53 * position of the graph element or any of its parts.
|
|
f@0
|
54 *
|
|
f@0
|
55 * @param p the starting point of the motion
|
|
f@0
|
56 * @param source the source of the motion action
|
|
f@0
|
57 */
|
|
f@0
|
58 public void startMove(Point2D p, Object source);
|
|
f@0
|
59
|
|
f@0
|
60 /**
|
|
f@0
|
61 * This method is to be called when the motion (e.g. a translation) is over.
|
|
f@0
|
62 * Note that for instance a translation might be composed on several calls to {@code translate}
|
|
f@0
|
63 *
|
|
f@0
|
64 * @param source the source of the motion action
|
|
f@0
|
65 */
|
|
f@0
|
66 public void stopMove(Object source);
|
|
f@0
|
67
|
|
f@0
|
68 /**
|
|
f@0
|
69 * Gets the bounding {@code Rectangle} of this graph element.
|
|
f@0
|
70 *
|
|
f@0
|
71 * @return a new {@code Rectangle} equals to the bounding {@code Rectangle} of this graph element
|
|
f@0
|
72 */
|
|
f@0
|
73 public Rectangle2D getBounds();
|
|
f@0
|
74
|
|
f@0
|
75 /**
|
|
f@0
|
76 * Returns the point where an line, with a specified direction, would come in contact with the outline of this
|
|
f@0
|
77 * graph element.
|
|
f@0
|
78 *
|
|
f@0
|
79 * @param d the direction of the line
|
|
f@0
|
80 * @return a new point on the outline if this graph element where the line comes in contact with it
|
|
f@0
|
81 */
|
|
f@0
|
82 public Point2D getConnectionPoint(Direction d);
|
|
f@0
|
83
|
|
f@0
|
84 /**
|
|
f@0
|
85 * Tests if a specified {@code Point2D} is inside the boundary of this graph element.
|
|
f@0
|
86 *
|
|
f@0
|
87 * @param p the point to be tested
|
|
f@0
|
88 * @return {@code true} if the point is inside the boundary, {@code false} otherwise
|
|
f@0
|
89 */
|
|
f@0
|
90 public boolean contains(Point2D p);
|
|
f@0
|
91
|
|
f@0
|
92 }
|
