1 /**
2  * Copyright 2011 JogAmp Community. All rights reserved.
3  *
4  * Redistribution and use in source and binary forms, with or without modification, are
5  * permitted provided that the following conditions are met:
6  *
7  *    1. Redistributions of source code must retain the above copyright notice, this list of
8  *       conditions and the following disclaimer.
9  *
10  *    2. Redistributions in binary form must reproduce the above copyright notice, this list
11  *       of conditions and the following disclaimer in the documentation and/or other materials
12  *       provided with the distribution.
13  *
14  * THIS SOFTWARE IS PROVIDED BY JogAmp Community ``AS IS'' AND ANY EXPRESS OR IMPLIED
15  * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND
16  * FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL JogAmp Community OR
17  * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
18  * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
19  * SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON
20  * ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
21  * NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF
22  * ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
23  *
24  * The views and conclusions contained in the software and documentation are those of the
25  * authors and should not be interpreted as representing official policies, either expressed
26  * or implied, of JogAmp Community.
27  */
28 
29 package com.jogamp.graph.curve.tess;
30 
31 import java.util.List;
32 
33 import com.jogamp.graph.geom.Outline;
34 import com.jogamp.graph.geom.Triangle;
35 
36 /** Interface to the triangulation algorithms provided
37  *  A triangulation of 2D outlines where you can
38  *  provides an easy one or more outlines to be triangulated
39  *
40  *  example usage:
41  *      addCurve(o1);
42  *      addCurve(o2);
43  *      addCurve(o3);
44  *      generate();
45  *      reset();
46  *
47  * @see Outline
48  * @see Triangulation
49  */
50 public interface Triangulator {
51 
52     /**
53      * Add a curve to the list of Outlines
54      * describing the shape
55      * @param sink list where the generated triangles will be added
56      * @param outline a bounding {@link Outline}
57      * @param sharpness TODO
58      */
addCurve(List<Triangle> sink, Outline outline, float sharpness)59     public void addCurve(List<Triangle> sink, Outline outline, float sharpness);
60 
61     /** Generate the triangulation of the provided
62      *  List of {@link Outline}s
63      * @param sink list where the generated triangles will be added
64      */
generate(List<Triangle> sink)65     public void generate(List<Triangle> sink);
66 
67     /**
68      * Reset the triangulation to initial state
69      * Clearing cached data
70      */
reset()71     public void reset();
72 
73     /**
74      * Return the number of newly added vertices during {@link #addCurve(List, Outline, float)}.
75      */
getAddedVerticeCount()76     public int getAddedVerticeCount();
77 }
78