Subsurf: Support subdivision of loose elements
[blender.git] / intern / opensubdiv / opensubdiv_converter_capi.h
1 // Copyright 2015 Blender Foundation. All rights reserved.
2 //
3 // This program is free software; you can redistribute it and/or
4 // modify it under the terms of the GNU General Public License
5 // as published by the Free Software Foundation; either version 2
6 // of the License, or (at your option) any later version.
7 //
8 // This program is distributed in the hope that it will be useful,
9 // but WITHOUT ANY WARRANTY; without even the implied warranty of
10 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
11 // GNU General Public License for more details.
12 //
13 // You should have received a copy of the GNU General Public License
14 // along with this program; if not, write to the Free Software Foundation,
15 // Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
16 //
17 // Author: Sergey Sharybin
18
19 #ifndef OPENSUBDIV_CONVERTER_CAPI_H_
20 #define OPENSUBDIV_CONVERTER_CAPI_H_
21
22 #include <stdint.h>  // for bool
23
24 #include "opensubdiv_capi_type.h"
25
26 #ifdef __cplusplus
27 extern "C" {
28 #endif
29
30 typedef struct OpenSubdiv_Converter {
31   OpenSubdiv_SchemeType (*getSchemeType)(
32       const struct OpenSubdiv_Converter* converter);
33
34   OpenSubdiv_FVarLinearInterpolation (*getFVarLinearInterpolation)(
35       const struct OpenSubdiv_Converter* converter);
36
37   //////////////////////////////////////////////////////////////////////////////
38   // Global geometry counters.
39
40   // Number of faces/edges/vertices in the base mesh.
41   int (*getNumFaces)(const struct OpenSubdiv_Converter* converter);
42   int (*getNumEdges)(const struct OpenSubdiv_Converter* converter);
43   int (*getNumVertices)(const struct OpenSubdiv_Converter* converter);
44
45   //////////////////////////////////////////////////////////////////////////////
46   // Face relationships.
47
48   // Number of vertices the face consists of.
49   int (*getNumFaceVertices)(const struct OpenSubdiv_Converter* converter,
50                             const int face_index);
51   // Array of vertex indices the face consists of.
52   void (*getFaceVertices)(const struct OpenSubdiv_Converter* converter,
53                           const int face_index,
54                           int* face_vertices);
55   // Array of edge indices the face consists of.
56   // Aligned with the vertex indices array, edge i connects face vertex i
57   // with face index i+1.
58   void (*getFaceEdges)(const struct OpenSubdiv_Converter *converter,
59                        const int face_index,
60                        int *face_edges);
61
62   //////////////////////////////////////////////////////////////////////////////
63   // Edge relationships.
64
65   // Vertices the edge consists of.
66   void (*getEdgeVertices)(const struct OpenSubdiv_Converter* converter,
67                           const int edge_index,
68                           int edge_vertices[2]);
69   // Number of faces which are sharing the given edge.
70   int (*getNumEdgeFaces)(const struct OpenSubdiv_Converter* converter,
71                          const int edge_index);
72   // Array of face indices which are sharing the given edge.
73   void (*getEdgeFaces)(const struct OpenSubdiv_Converter* converter,
74                        const int edge,
75                        int* edge_faces);
76   // Edge sharpness (aka crease).
77   float (*getEdgeSharpness)(const struct OpenSubdiv_Converter* converter,
78                             const int edge_index);
79
80   //////////////////////////////////////////////////////////////////////////////
81   // Vertex relationships.
82
83   // Number of edges which are adjacent to the given vertex.
84   int (*getNumVertexEdges)(const struct OpenSubdiv_Converter* converter,
85                            const int vertex_index);
86   // Array fo edge indices which are adjacent to the given vertex.
87   void (*getVertexEdges)(const struct OpenSubdiv_Converter* converter,
88                          const int vertex_index,
89                          int* vertex_edges);
90   // Number of faces which are adjacent to the given vertex.
91   int (*getNumVertexFaces)(const struct OpenSubdiv_Converter* converter,
92                            const int vertex_index);
93   // Array fo face indices which are adjacent to the given vertex.
94   void (*getVertexFaces)(const struct OpenSubdiv_Converter* converter,
95                          const int vertex_index,
96                          int* vertex_faces);
97
98   // Check whether vertex is to be marked as an infinite sharp.
99   // This is a way to make sharp vertices which are adjacent to a loose edges.
100   bool (*isInfiniteSharpVertex)(const struct OpenSubdiv_Converter* converter,
101                                 const int vertex_index);
102
103   //////////////////////////////////////////////////////////////////////////////
104   // Face-varying data.
105
106   /////////////////////////////////////
107   // UV coordinates.
108
109   // Number of UV layers.
110   int (*getNumUVLayers)(const struct OpenSubdiv_Converter* converter);
111
112   // We need some corner connectivity information, which might not be trivial
113   // to be gathered (might require multiple matching calculations per corver
114   // query).
115   // precalc() is called before any corner connectivity or UV coordinate is
116   // queried from the given layer, allowing converter to calculate and cache
117   // complex complex-to-calculate information.
118   // finish() is called after converter is done porting UV layer to OpenSubdiv,
119   // allowing to free cached data.
120   void (*precalcUVLayer)(const struct OpenSubdiv_Converter* converter,
121                          const int layer_index);
122   void (*finishUVLayer)(const struct OpenSubdiv_Converter* converter);
123
124   // Get number of UV coordinates in the current layer (layer which was
125   // specified in precalcUVLayer().
126   int (*getNumUVCoordinates)(const struct OpenSubdiv_Converter* converter);
127   // For the given face index and its corner (known as loop in Blender)
128   // get corrsponding UV coordinate index.
129   int (*getFaceCornerUVIndex)(const struct OpenSubdiv_Converter* converter,
130                               const int face_index,
131                               const int corner_index);
132
133   //////////////////////////////////////////////////////////////////////////////
134   // User data associated with this converter.
135
136   void (*freeUserData)(const struct OpenSubdiv_Converter* converter);
137   void* user_data;
138 } OpenSubdiv_Converter;
139
140 #ifdef __cplusplus
141 }
142 #endif
143
144 #endif /* OPENSUBDIV_CONVERTER_CAPI_H_ */