aboutsummaryrefslogtreecommitdiffstats
path: root/src/com/jogamp/graph/geom/Outline.java
blob: a805adf6c81e73628ea947beb84d9f19b78cab52 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
/**
 * Copyright 2010 JogAmp Community. All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without modification, are
 * permitted provided that the following conditions are met:
 *
 *    1. Redistributions of source code must retain the above copyright notice, this list of
 *       conditions and the following disclaimer.
 *
 *    2. Redistributions in binary form must reproduce the above copyright notice, this list
 *       of conditions and the following disclaimer in the documentation and/or other materials
 *       provided with the distribution.
 *
 * THIS SOFTWARE IS PROVIDED BY JogAmp Community ``AS IS'' AND ANY EXPRESS OR IMPLIED
 * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND
 * FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL JogAmp Community OR
 * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
 * SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON
 * ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
 * NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF
 * ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 *
 * The views and conclusions contained in the software and documentation are those of the
 * authors and should not be interpreted as representing official policies, either expressed
 * or implied, of JogAmp Community.
 */
package com.jogamp.graph.geom;

import java.util.ArrayList;

import com.jogamp.graph.geom.Vertex;
import com.jogamp.graph.math.VectorUtil;



/** Define a single continuous stroke by control vertices.
 *  The vertices define the shape of the region defined by this 
 *  outline. The Outline can contain a list of off-curve and on-curve
 *  vertices which define curved regions.
 *  
 *  Note: An outline should be closed to be rendered as a region.
 *  
 *  @see OutlineShape, Region
 */
public class Outline implements Comparable<Outline> {
	
	private ArrayList<Vertex> vertices = new ArrayList<Vertex>(3);
	private boolean closed = false;
	private AABBox box = new AABBox();
	
	/**Create an outline defined by control vertices.
	 * An outline can contain off Curve vertices which define curved
	 * regions in the outline.
	 */
	public Outline(){
		
	}
	
	/** Add a vertex to the outline. The {@link Vertex} is added at the 
	 * end of the outline loop/strip.
	 * @param vertex Vertex to be added
	 */
	public final void addVertex(Vertex vertex) {
		vertices.add(vertex);
		box.resize(vertex.getX(), vertex.getY(), vertex.getZ());
	}
	
	/**  Add a {@link Vertex} by specifying its 2D attributes to the outline. 
	 * The {@link Vertex} is added at the 
	 * end of the outline loop/strip. 
	 * @param factory a {@link Factory} to get the required Vertex impl
	 * @param x the x coordinate
	 * @param y the y coordinate
	 * @param onCurve flag if this vertex is on the final curve or defines a curved region
	 * of the shape around this vertex.
	 */
	public final void addVertex(Vertex.Factory<? extends Vertex> factory, float x, float y, boolean onCurve) {
		addVertex(factory, x, y, 0f, onCurve);
	}
	
	/** Add a {@link Vertex} by specifying its 3D attributes to the outline. 
	 * The {@link Vertex} is added at the 
	 * end of the outline loop/strip. 
	 * @param factory  a {@link Factory} to get the required Vertex impl
	 * @param x the x coordinate
	 * @param y the y coordinate
	 * @param z the z coordinate
	 * @param onCurve flag if this vertex is on the final curve or defines a curved region
	 * of the shape around this vertex.
	 */
	public final void addVertex(Vertex.Factory<? extends Vertex> factory, float x, float y, float z, boolean onCurve) {
		Vertex v = factory.create(x, y, z);
		v.setOnCurve(onCurve);
		addVertex(v);
	}
	
	/** Add a vertex to the outline by passing a float array and specifying the 
	 * offset and length in which. The attributes of the vertex are located. 
	 * The attributes should be continuous (stride = 0).
	 * Attributes which value are not set (when length less than 3) 
	 * are set implicitly to zero.
	 * @param factory  a {@link Factory} to get the required Vertex impl
	 * @param coordsBuffer the coordinate array where the vertex attributes are to be picked from
	 * @param offset the offset in the buffer to the x coordinate
	 * @param length the number of attributes to pick from the buffer (maximum 3)
	 * @param onCurve flag if this vertex is on the final curve or defines a curved region
	 * of the shape around this vertex.
	 */
	public final void addVertex(Vertex.Factory<? extends Vertex> factory, float[] coordsBuffer, int offset, int length, boolean onCurve) {
		Vertex v = factory.create(coordsBuffer, offset, length);
		v.setOnCurve(onCurve);
		addVertex(v);
	}
	
	public Vertex getVertex(int index){
		return vertices.get(index);
	}
	
	public boolean isEmpty(){
		return (vertices.size() == 0);
	}
	public Vertex getLastVertex(){
		if(isEmpty()){
			return null;
		}
		return vertices.get(vertices.size()-1);
	}
	
	public ArrayList<Vertex> getVertices() {
		return vertices;
	}
	public void setVertices(ArrayList<Vertex> vertices) {
		this.vertices = vertices;
	}
	public AABBox getBox() {
		return box;
	}
	public boolean isClosed() {
		return closed;
	}
	
	/** define if this outline is closed or not.
	 * if set to closed, checks if the last vertex is 
	 * equal to the first vertex. If not Equal adds a
	 * vertex at the end to the list.
	 * @param closed
	 */
	public void setClosed(boolean closed) {
		this.closed = closed;
		if(closed){
		    Vertex first = vertices.get(0);
		    Vertex last = getLastVertex();
			if(!VectorUtil.checkEquality(first.getCoord(), last.getCoord())){
				Vertex v = first.clone();
				vertices.add(v);
			}
		}
	}
	
	/** Compare two outlines with Bounding Box area
	 * as criteria. 
	 * @see java.lang.Comparable#compareTo(java.lang.Object)
	 */
	public int compareTo(Outline outline) {
		float size = box.getSize();
		float newSize = outline.getBox().getSize();
		if(size < newSize){
			return -1;
		}
		else if(size > newSize){
			return 1;
		}
		return 0;
	}
}