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: 
f@0: package uk.ac.qmul.eecs.ccmi.haptics;
f@0: 
f@0: import java.awt.geom.Line2D;
f@0: import java.util.BitSet;
f@0: 
f@0: /**
f@0:  * 
f@0:  * An interface for rendering a visual diagram hapticly.   
f@0:  *
f@0:  */
f@0: public interface Haptics extends Runnable{
f@0: 
f@0: 	public void addNewDiagram(String diagramName);
f@0: 
f@0: 	public void switchDiagram(String diagramName);
f@0: 
f@0: 	/**
f@0: 	 * Removes a diagram from the collection of haptic diagrams.  
f@0: 	 * 
f@0: 	 * @param diagramNameToRemove the unique name of the diagram to remove
f@0: 	 * @param diagramNameOfNext the name of the next diagram to render hapticly. If 
f@0: 	 *        {@code null}, no diagram will be rendered.  
f@0: 	 */
f@0: 	public void removeDiagram(String diagramNameToRemove, String diagramNameOfNext);
f@0: 
f@0: 	public void addNode(double x, double y, int nodeHashCode, String diagramName);
f@0: 
f@0: 	public void removeNode(int nodeHashCode, String diagramName);
f@0: 
f@0: 	public void moveNode(double x, double y, int nodeHashCode, String diagramName);
f@0: 
f@0: 	public void addEdge(int edgeHashCode, double[] xs, double[] ys,
f@0: 			BitSet[] adjMatrix, int nodeStart, int stipplePattern,
f@0: 			Line2D attractLine, String diagramName);
f@0: 
f@0: 	public void updateEdge(int edgeHashCode, double[] xs, double[] ys,
f@0: 			BitSet[] adjMatrix, int nodeStart, Line2D attractLine, String diagramName);
f@0: 
f@0: 	public void removeEdge(int edgeHashCode, String diagramName);
f@0: 
f@0: 	public void attractTo(int elementHashCode);
f@0: 	
f@0: 	public void pickUp(int elementHashCode);
f@0: 	
f@0: 	public boolean isAlive();
f@0: 	
f@0: 	public void setVisible(boolean visible);
f@0: 
f@0: 	public void dispose();
f@0: 	
f@0: }