comparison java/src/uk/ac/qmul/eecs/ccmi/gui/LineStyle.java @ 3:9e67171477bc

PHANTOM Omni Heptic device release

  * Defines the possible values for the stroke of lines painted on the graph when drawing an {@link Edge}. 
  * It can be <i>Solid</i>, <i>Dotted</i> or <i>Dashed</i>.
  *
  */
 public enum LineStyle {
-	Solid(new BasicStroke()),
+	Solid(new BasicStroke(),0xFFFF),
 	Dotted(new BasicStroke(1.0f, 
 			BasicStroke.CAP_ROUND, 
 			BasicStroke.JOIN_ROUND, 
 			0.0f, 
 			new float[]{1.0f,3.0f}, 
-			0.0f)),
+			0.0f),0xF0F0),
 	Dashed(new BasicStroke(1.0f, 
 			BasicStroke.CAP_ROUND, 
 			BasicStroke.JOIN_ROUND, 
 			0.0f, 
 			new float[]{5.0f,5.0f}, 
-			0.0f));
+			0.0f),0xAAAA);
 	
-	private LineStyle(BasicStroke stroke){
+	private LineStyle(BasicStroke stroke, int stipplePattern){
 		this.stroke = stroke;
+		this.stipplePattern = stipplePattern;
 	}
 
+	/**
+	 * returns the stroke of this line style. The stroke is used to paint 
+	 * the edge that has this line style on a graphics.  
+	 *  
+	 * @return the stroke for this line style
+	 */
 	public Stroke getStroke(){
 		return stroke;
 	}
 	
+	/**
+	 * Returns an a bit representation of the stippling of this edge. 
+	 * This value can be used by openGL like libraries to draw the edge and it's used by 
+	 * the OmniHaptic device native code to paint the edge visually and haptically.  
+	 * See also {@link http://www.opengl.org/sdk/docs/man/xhtml/glLineStipple.xml}
+	 *
+	 * 
+	 * @return an int with the bit representation of the stipple pattern
+	 */
+	public int getStipplePattern(){
+		return stipplePattern;
+	}
+	
 	private Stroke stroke;
+	private int stipplePattern; 
 }