aboutsummaryrefslogtreecommitdiffstats
path: root/src/jogl/classes/com/jogamp/graph/curve/Region.java
blob: e238889e098a101731559c958c64acb4877bae5c (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
/**
 * 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.curve;

import java.util.ArrayList;

import jogamp.opengl.Debug;

import com.jogamp.graph.curve.opengl.Renderer;
import com.jogamp.graph.geom.Triangle;
import com.jogamp.graph.geom.Vertex;
import com.jogamp.opengl.util.PMVMatrix;

/** A Region is the OGL binding of one or more OutlineShapes
 *  Defined by its vertices and generated triangles. The Region
 *  defines the final shape of the OutlineShape(s), which shall produced a shaded 
 *  region on the screen.
 *  
 *  Implementations of the Region shall take care of the OGL 
 *  binding of the depending on its context, profile.
 * 
 * @see RegionFactory, OutlineShape
 */
public interface Region {
    public static final boolean DEBUG = Debug.debug("graph.curve");
    
	/** The vertices index in an OGL object
	 */
	public static int VERTEX_ATTR_IDX = 0;
	public static String VERTEX_ATTR_NAME = "v_position";

	/** The Texture Coord index in an OGL object
	 */
	public static int TEXCOORD_ATTR_IDX = 1;
	public static String TEXCOORD_ATTR_NAME = "texCoord";
	
    /** The color index in an OGL object
     */
    public static int COLOR_ATTR_IDX = 2;
    public static String COLOR_ATTR_NAME = "v_color";
    
	/** single pass rendering, fast, but AA might not be perfect */
	public static int SINGLE_PASS = 1;
	
	/** two pass rendering, slower and more resource hungry (FBO), but AA is perfect */
	public static int TWO_PASS    = 2;
	
	/** Updates a graph region by updating the ogl related
	 *  objects for use in rendering. if called for the first time
	 *  it initialize the objects. 
	 */
	public void update();
	
	/** Renders the associated OGL objects specifying
	 * current width/hight of window for multi pass rendering
	 * of the region.
	 * @param matrix current {@link PMVMatrix}.
	 * @param vp_width current screen width
	 * @param vp_height current screen height
	 * @param width texture width for mp rendering
	 * 
	 * @see update()
	 */
	public void render(PMVMatrix matrix, int vp_width, int vp_height, int width);
	
	/** Adds a list of {@link Triangle} objects to the Region
	 * These triangles are to be binded to OGL objects 
	 * on the next call to {@code update}
	 * @param tris an arraylist of triangle objects
	 * 
	 * @see update()
	 */
	public void addTriangles(ArrayList<Triangle> tris);
	
	/** Get the current number of vertices associated
	 * with this region. This number is not necessary equal to 
	 * the OGL binded number of vertices.
	 * @return vertices count
	 * 
	 * @see isDirty()
	 */
	public int getNumVertices();
	
	/** Adds a list of {@link Vertex} objects to the Region
	 * These vertices are to be binded to OGL objects 
	 * on the next call to {@code update}
	 * @param verts an arraylist of vertex objects
	 * 
	 * @see update()
	 */
	public void addVertices(ArrayList<Vertex> verts);
	
	/** Check if this region is dirty. A region is marked dirty
	 * when new Vertices, Triangles, and or Lines are added after a 
	 * call to update()
	 * @return true if region is Dirty, false otherwise
	 * 
	 * @see update();
	 */
	public boolean isDirty();
	
	/** Delete and clean the associated OGL
	 *  objects
	 */
	public void destroy();
	
	public boolean isFlipped();
	
	/** Set if the y coordinate of the region should be flipped
	 *  {@code y=-y} used mainly for fonts since they use opposite vertex
	 *  as origion
	 * @param flipped flag if the coordinate is flipped defaults to false.
	 */
	public void setFlipped(boolean flipped);
}