f@0: /*  
f@0:  CCmI Editor - A Collaborative Cross-Modal Diagram Editing Tool
f@0:   
f@0:  Copyright (C) 2011  Queen Mary University of London (http://ccmi.eecs.qmul.ac.uk/)
f@0: 
f@0:  This program is free software: you can redistribute it and/or modify
f@0:  it under the terms of the GNU General Public License as published by
f@0:  the Free Software Foundation, either version 3 of the License, or
f@0:  (at your option) any later version.
f@0: 
f@0:  This program is distributed in the hope that it will be useful,
f@0:  but WITHOUT ANY WARRANTY; without even the implied warranty of
f@0:  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
f@0:  GNU General Public License for more details.
f@0: 
f@0:  You should have received a copy of the GNU General Public License
f@0:  along with this program.  If not, see <http://www.gnu.org/licenses/>.
f@0: */
f@0: package uk.ac.qmul.eecs.ccmi.gui;
f@0: 
f@0: import java.awt.Graphics2D;
f@0: import java.awt.geom.Point2D;
f@0: import java.awt.geom.Rectangle2D;
f@0: 
f@0: 
f@0: /**
f@0:  * An interface implemented by {@code Node}, {@code Edge} and {@code Edge.InnerPoint}. It defines methods that 
f@0:  * all objects painted on a graph share. The interface is used mainly
f@0:  * for convenience in treating the different types of object in a uniformly.  
f@0:  *
f@0:  */
f@0: public interface GraphElement {
f@0: 	/**
f@0: 	 * Draw the graphic element on a canvas
f@0: 	 * 
f@0: 	 * @param g2 the graphics object. Use {@code g2.draw()} to get things painted on the graph. 
f@0: 	 */
f@0: 	public void draw(Graphics2D g2);
f@0: 
f@0: 	/**
f@0: 	 * Translates this graphic element on the graph 
f@0: 	 * 
f@0: 	 * @param p the starting point where the translation starts (normally where the user clicks
f@0: 	 * with their mouse)
f@0: 	 * @param dx the distance to translate along the x-axis
f@0: 	 * @param dy the distance to translate along the y-axis
f@0: 	 * @param source the source of the translate action
f@0: 	 */
f@0: 	public void translate(Point2D p, double dx, double dy, Object source);
f@0: 
f@0: 	/**
f@0: 	 * This method is to be called before translation or any other operation that changes the 
f@0: 	 * position of the graph element or any of its parts. 
f@0: 	 * 
f@0: 	 * @param p the starting point of the motion 
f@0: 	 * @param source the source of the motion action
f@0: 	 */
f@0: 	public void startMove(Point2D p, Object source);
f@0: 
f@0: 	/**
f@0: 	 * This method is to be called when the motion (e.g. a translation) is over. 
f@0: 	 * Note that for instance a translation might be composed on several calls to {@code translate}
f@0: 	 * 
f@0: 	 * @param source the source of the motion action
f@0: 	 */
f@0: 	public void stopMove(Object source);
f@0: 	
f@0: 	/**
f@0: 	 * Gets the bounding {@code Rectangle} of this graph element.
f@0: 	 * 
f@0: 	 * @return a new {@code Rectangle} equals to the bounding {@code Rectangle} of this graph element
f@0: 	 */
f@0: 	public Rectangle2D getBounds();
f@0: 	
f@0: 	/**
f@0: 	 * Returns the point where an line, with a specified direction, would come in contact with the outline of this 
f@0: 	 * graph element. 
f@0: 	 * 
f@0: 	 * @param d the direction of the line 
f@0: 	 * @return a new point on the outline if this graph element where the line comes in contact with it
f@0:  	 */
f@0: 	public Point2D getConnectionPoint(Direction d);
f@0: 	
f@0: 	/**
f@0: 	 * Tests if a specified {@code Point2D} is inside the boundary of this graph element.
f@0: 	 * 
f@0: 	 * @param p the point to be tested
f@0: 	 * @return {@code true} if the point is inside the boundary, {@code false} otherwise
f@0: 	 */
f@0: 	public boolean contains(Point2D p);
f@0: 	
f@0: }