Revision 20098 trunk/libraries/libFMap/src/com/iver/cit/gvsig/fmap/tools/Events/MeasureEvent.java

View differences:

MeasureEvent.java
46 46

  
47 47

  
48 48
/**
49
 * DOCUMENT ME!
49
 * <p><code>MeasureEvent</code> is used to notify the selection of a polyline.</p>
50
 *  
51
 * <p>Stores the information about the 2D vertexes and the {@link GeneralPathX GeneralPathX}
52
 *  between them.</p>
50 53
 *
51 54
 * @author Vicente Caballero Navarro
52 55
 */
53 56
public class MeasureEvent {
57
	/**
58
	 * The polyline, broken down in straight lines, and quadratic and cubic (B?zier) curves.
59
	 */
54 60
	private GeneralPathX gp;
61
	
62
	/**
63
	 * Vector with the X coordinates.
64
	 */
55 65
	private Double[] x;
66
	
67
	/**
68
	 * Vector with the Y coordinates.
69
	 */
56 70
	private Double[] y;
71
	
72
	/**
73
	 * Mouse event that has been the cause of creating this event.
74
	 */
57 75
	private MouseEvent event;
58 76

  
59 77
	/**
60
	 * Crea un nuevo MeasureEvent.
78
	 * <p>Creates a new <code>MeasureEvent</code> with all necessary data.</p>
79
	 * <p>The general path is calculated according the enclosed regions of the path alternate between interior
80
	 *  and exterior areas are traversed from the outside of the path towards a point inside the region.</p>
61 81
	 *
62
	 * @param x Vector de coordenadas X.
63
	 * @param y Vector de coordenadas Y.
64
	 * @param e Evento que ocasion? el MeasureEvent
82
	 * @param x vector with the X coordinates
83
	 * @param y vector with the Y coordinates
84
	 * @param e event that has been the cause of creating this one
65 85
	 */
66 86
	public MeasureEvent(Double[] x, Double[] y, MouseEvent e) {
67 87
		this.x = x;
......
76 96
	}
77 97

  
78 98
	/**
79
	 * Devuelve el GeneralPathX de la medici?n.
99
	 * <p>Gets the {@link GeneralPathX GeneralPathX} of the measurement.</p>
80 100
	 *
81
	 * @return GeneralPathX.
101
	 * @see GeneralPathX
102
	 *
103
	 * @return geometric path constructed from straight lines, and quadratic and cubic (B?zier) curves
82 104
	 */
83 105
	public GeneralPathX getGP() {
84 106
		return gp;
85 107
	}
86 108

  
87 109
	/**
88
	 * Inserta un GeneralPathX
110
	 * <p>Sets the {@link GeneralPathX GeneralPathX} of the measurement.</p>
89 111
	 *
90
	 * @param gp GeneralPathX.
112
	 * @see GeneralPathX
113
	 *
114
	 * @param gP geometric path constructed from straight lines, and quadratic and cubic (B?zier) curves
91 115
	 */
92 116
	public void setGP(GeneralPathX gp) {
93 117
		this.gp = gp;
94 118
	}
95 119

  
96 120
	/**
97
	 * Devuelve el vector de X.
121
	 * <p>Gets a vector with the X coordinates.</p>
98 122
	 *
99
	 * @return Vector de X.
123
	 * @return vector with the X coordinates
100 124
	 */
101 125
	public Double[] getXs() {
102 126
		return x;
103 127
	}
104 128

  
105 129
	/**
106
	 * Devuelve el vector de Y.
130
	 * <p>Gets a vector with the Y coordinates.</p>
107 131
	 *
108
	 * @return Vector de Y.
132
	 * @return vector with the Y coordinates
109 133
	 */
110 134
	public Double[] getYs() {
111 135
		return y;
112 136
	}
113 137

  
114 138
	/**
115
	 * DOCUMENT ME!
116
	 *
117
	 * @return DOCUMENT ME!
139
	 * <p>Gets the event that has been the cause of creating this one.</p>
140
	 * 
141
	 * @return mouse event that has been the cause of creating this one
118 142
	 */
119 143
	public MouseEvent getEvent() {
120 144
		return event;

Also available in: Unified diff