view java/src/uk/ac/qmul/eecs/ccmi/haptics/Haptics.java @ 1:e3935c01cde2 tip

moved license of PdPersistenceManager to the beginning of the file

/*  
 CCmI Editor - A Collaborative Cross-Modal Diagram Editing Tool
  
 Copyright (C) 2011  Queen Mary University of London (http://ccmi.eecs.qmul.ac.uk/)

 This program is free software: you can redistribute it and/or modify
 it under the terms of the GNU General Public License as published by
 the Free Software Foundation, either version 3 of the License, or
 (at your option) any later version.

 This program is distributed in the hope that it will be useful,
 but WITHOUT ANY WARRANTY; without even the implied warranty of
 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 GNU General Public License for more details.

 You should have received a copy of the GNU General Public License
 along with this program.  If not, see <http://www.gnu.org/licenses/>.
*/  

package uk.ac.qmul.eecs.ccmi.haptics;

import java.awt.geom.Line2D;
import java.util.BitSet;

/**
 * 
 * An interface for rendering a visual diagram hapticly.   
 *
 */
public interface Haptics extends Runnable{

	public void addNewDiagram(String diagramName);

	public void switchDiagram(String diagramName);

	/**
	 * Removes a diagram from the collection of haptic diagrams.  
	 * 
	 * @param diagramNameToRemove the unique name of the diagram to remove
	 * @param diagramNameOfNext the name of the next diagram to render hapticly. If 
	 *        {@code null}, no diagram will be rendered.  
	 */
	public void removeDiagram(String diagramNameToRemove, String diagramNameOfNext);

	public void addNode(double x, double y, int nodeHashCode, String diagramName);

	public void removeNode(int nodeHashCode, String diagramName);

	public void moveNode(double x, double y, int nodeHashCode, String diagramName);

	public void addEdge(int edgeHashCode, double[] xs, double[] ys,
			BitSet[] adjMatrix, int nodeStart, int stipplePattern,
			Line2D attractLine, String diagramName);

	public void updateEdge(int edgeHashCode, double[] xs, double[] ys,
			BitSet[] adjMatrix, int nodeStart, Line2D attractLine, String diagramName);

	public void removeEdge(int edgeHashCode, String diagramName);

	public void attractTo(int elementHashCode);
	
	public void pickUp(int elementHashCode);
	
	public boolean isAlive();
	
	public void setVisible(boolean visible);

	public void dispose();
	
}