annotate java/src/uk/ac/qmul/eecs/ccmi/gui/LineStyle.java @ 1:e3935c01cde2 tip

moved license of PdPersistenceManager to the beginning of the file
author Fiore Martin <f.martin@qmul.ac.uk>
date Tue, 08 Jul 2014 19:52:03 +0100
parents 78b7fc5391a2
children
rev   line source
f@0 1 /*
f@0 2 CCmI Editor - A Collaborative Cross-Modal Diagram Editing Tool
f@0 3
f@0 4 Copyright (C) 2011 Queen Mary University of London (http://ccmi.eecs.qmul.ac.uk/)
f@0 5
f@0 6 This program is free software: you can redistribute it and/or modify
f@0 7 it under the terms of the GNU General Public License as published by
f@0 8 the Free Software Foundation, either version 3 of the License, or
f@0 9 (at your option) any later version.
f@0 10
f@0 11 This program is distributed in the hope that it will be useful,
f@0 12 but WITHOUT ANY WARRANTY; without even the implied warranty of
f@0 13 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
f@0 14 GNU General Public License for more details.
f@0 15
f@0 16 You should have received a copy of the GNU General Public License
f@0 17 along with this program. If not, see <http://www.gnu.org/licenses/>.
f@0 18 */
f@0 19 package uk.ac.qmul.eecs.ccmi.gui;
f@0 20
f@0 21 import java.awt.BasicStroke;
f@0 22 import java.awt.Stroke;
f@0 23
f@0 24 /**
f@0 25 * Defines the possible values for the stroke of lines painted on the graph when drawing an {@link Edge}.
f@0 26 * It can be <i>Solid</i>, <i>Dotted</i> or <i>Dashed</i>.
f@0 27 *
f@0 28 */
f@0 29 public enum LineStyle {
f@0 30 Solid(new BasicStroke(),0xFFFF),
f@0 31 Dotted(new BasicStroke(1.0f,
f@0 32 BasicStroke.CAP_ROUND,
f@0 33 BasicStroke.JOIN_ROUND,
f@0 34 0.0f,
f@0 35 new float[]{1.0f,3.0f},
f@0 36 0.0f),0xAAAA),
f@0 37 Dashed(new BasicStroke(1.0f,
f@0 38 BasicStroke.CAP_ROUND,
f@0 39 BasicStroke.JOIN_ROUND,
f@0 40 0.0f,
f@0 41 new float[]{5.0f,5.0f},
f@0 42 0.0f),0xF0F0);
f@0 43
f@0 44 private LineStyle(BasicStroke stroke, int stipplePattern){
f@0 45 this.stroke = stroke;
f@0 46 this.stipplePattern = stipplePattern;
f@0 47 }
f@0 48
f@0 49 /**
f@0 50 * returns the stroke of this line style. The stroke is used to paint
f@0 51 * the edge that has this line style on a graphics.
f@0 52 *
f@0 53 * @return the stroke for this line style
f@0 54 */
f@0 55 public Stroke getStroke(){
f@0 56 return stroke;
f@0 57 }
f@0 58
f@0 59 /**
f@0 60 * Returns an a bit representation of the stippling of this edge.
f@0 61 * This value can be used by openGL like libraries to draw the edge and it's used by
f@0 62 * the OmniHaptic device native code to paint the edge visually and haptically.
f@0 63 *
f@0 64 * @see <a href="http://www.opengl.org/sdk/docs/man/xhtml/glLineStipple.xml">glLineStipple</a>
f@0 65 *
f@0 66 * @return an int with the bit representation of the stipple pattern
f@0 67 */
f@0 68 public int getStipplePattern(){
f@0 69 return stipplePattern;
f@0 70 }
f@0 71
f@0 72 private Stroke stroke;
f@0 73 private int stipplePattern;
f@0 74 }