fiore@0: /*  
fiore@0:  CCmI Editor - A Collaborative Cross-Modal Diagram Editing Tool
fiore@0:   
fiore@0:  Copyright (C) 2011  Queen Mary University of London (http://ccmi.eecs.qmul.ac.uk/)
fiore@0: 
fiore@0:  This program is free software: you can redistribute it and/or modify
fiore@0:  it under the terms of the GNU General Public License as published by
fiore@0:  the Free Software Foundation, either version 3 of the License, or
fiore@0:  (at your option) any later version.
fiore@0: 
fiore@0:  This program is distributed in the hope that it will be useful,
fiore@0:  but WITHOUT ANY WARRANTY; without even the implied warranty of
fiore@0:  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
fiore@0:  GNU General Public License for more details.
fiore@0: 
fiore@0:  You should have received a copy of the GNU General Public License
fiore@0:  along with this program.  If not, see <http://www.gnu.org/licenses/>.
fiore@0: */
fiore@0: package uk.ac.qmul.eecs.ccmi.gui;
fiore@0: 
fiore@0: import java.awt.BasicStroke;
fiore@0: import java.awt.Stroke;
fiore@0: 
fiore@0: /**
fiore@0:  * Defines the possible values for the stroke of lines painted on the graph when drawing an {@link Edge}. 
fiore@0:  * It can be <i>Solid</i>, <i>Dotted</i> or <i>Dashed</i>.
fiore@0:  *
fiore@0:  */
fiore@0: public enum LineStyle {
fiore@3: 	Solid(new BasicStroke(),0xFFFF),
fiore@0: 	Dotted(new BasicStroke(1.0f, 
fiore@0: 			BasicStroke.CAP_ROUND, 
fiore@0: 			BasicStroke.JOIN_ROUND, 
fiore@0: 			0.0f, 
fiore@0: 			new float[]{1.0f,3.0f}, 
fiore@7: 			0.0f),0xAAAA),
fiore@0: 	Dashed(new BasicStroke(1.0f, 
fiore@0: 			BasicStroke.CAP_ROUND, 
fiore@0: 			BasicStroke.JOIN_ROUND, 
fiore@0: 			0.0f, 
fiore@0: 			new float[]{5.0f,5.0f}, 
fiore@7: 			0.0f),0xF0F0);
fiore@0: 	
fiore@3: 	private LineStyle(BasicStroke stroke, int stipplePattern){
fiore@0: 		this.stroke = stroke;
fiore@3: 		this.stipplePattern = stipplePattern;
fiore@0: 	}
fiore@0: 
fiore@3: 	/**
fiore@3: 	 * returns the stroke of this line style. The stroke is used to paint 
fiore@3: 	 * the edge that has this line style on a graphics.  
fiore@3: 	 *  
fiore@3: 	 * @return the stroke for this line style
fiore@3: 	 */
fiore@0: 	public Stroke getStroke(){
fiore@0: 		return stroke;
fiore@0: 	}
fiore@0: 	
fiore@3: 	/**
fiore@3: 	 * Returns an a bit representation of the stippling of this edge. 
fiore@3: 	 * This value can be used by openGL like libraries to draw the edge and it's used by 
fiore@3: 	 * the OmniHaptic device native code to paint the edge visually and haptically.  
fiore@5: 	 * 
fiore@5: 	 * @see <a href="http://www.opengl.org/sdk/docs/man/xhtml/glLineStipple.xml">glLineStipple</a>
fiore@3: 	 * 
fiore@3: 	 * @return an int with the bit representation of the stipple pattern
fiore@3: 	 */
fiore@3: 	public int getStipplePattern(){
fiore@3: 		return stipplePattern;
fiore@3: 	}
fiore@3: 	
fiore@0: 	private Stroke stroke;
fiore@3: 	private int stipplePattern; 
fiore@0: }