a939f1117e08f038e00dadc03de8736f354a21e4
[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 "opensubdiv_capi_type.h"
23
24 #ifdef __cplusplus
25 extern "C" {
26 #endif
27
28 typedef struct OpenSubdiv_Converter {
29   OpenSubdiv_SchemeType (*getSchemeType)(
30       const struct OpenSubdiv_Converter* converter);
31
32   OpenSubdiv_FVarLinearInterpolation (*getFVarLinearInterpolation)(
33       const struct OpenSubdiv_Converter* converter);
34
35   //////////////////////////////////////////////////////////////////////////////
36   // Global geometry counters.
37   // Number of faces/edges/vertices in the base mesh.
38   int (*getNumFaces)(const struct OpenSubdiv_Converter* converter);
39   int (*getNumEdges)(const struct OpenSubdiv_Converter* converter);
40   int (*getNumVertices)(const struct OpenSubdiv_Converter* converter);
41
42   //////////////////////////////////////////////////////////////////////////////
43   // Face relationships.
44
45   // Number of vertices the face consists of.
46   int (*getNumFaceVertices)(const struct OpenSubdiv_Converter* converter,
47                             const int face_index);
48   // Array of vertex indices the face consists of.
49   void (*getFaceVertices)(const struct OpenSubdiv_Converter* converter,
50                           const int face_index,
51                           int* face_vertices);
52   // Array of edge indices the face consists of.
53   // Aligned with the vertex indices array, edge i connects face vertex i
54   // with face index i+1.
55   void (*getFaceEdges)(const struct OpenSubdiv_Converter *converter,
56                        const int face_index,
57                        int *face_edges);
58
59   //////////////////////////////////////////////////////////////////////////////
60   // Edge relationships.
61
62   // Vertices the edge consists of.
63   void (*getEdgeVertices)(const struct OpenSubdiv_Converter* converter,
64                           const int edge_index,
65                           int edge_vertices[2]);
66   // Number of faces which are sharing the given edge.
67   int (*getNumEdgeFaces)(const struct OpenSubdiv_Converter* converter,
68                          const int edge_index);
69   // Array of face indices which are sharing the given edge.
70   void (*getEdgeFaces)(const struct OpenSubdiv_Converter* converter,
71                        const int edge,
72                        int* edge_faces);
73   // Edge sharpness (aka crease).
74   float (*getEdgeSharpness)(const struct OpenSubdiv_Converter* converter,
75                             const int edge_index);
76
77   //////////////////////////////////////////////////////////////////////////////
78   // Vertex relationships.
79
80   // Number of edges which are adjacent to the given vertex.
81   int (*getNumVertexEdges)(const struct OpenSubdiv_Converter* converter,
82                            const int vertex_index);
83   // Array fo edge indices which are adjacent to the given vertex.
84   void (*getVertexEdges)(const struct OpenSubdiv_Converter* converter,
85                          const int vertex_index,
86                          int* vertex_edges);
87   // Number of faces which are adjacent to the given vertex.
88   int (*getNumVertexFaces)(const struct OpenSubdiv_Converter* converter,
89                            const int vertex_index);
90   // Array fo face indices which are adjacent to the given vertex.
91   void (*getVertexFaces)(const struct OpenSubdiv_Converter* converter,
92                          const int vertex_index,
93                          int* vertex_faces);
94
95   //////////////////////////////////////////////////////////////////////////////
96   // Face-varying data.
97
98   /////////////////////////////////////
99   // UV coordinates.
100
101   // Number of UV layers.
102   int (*getNumUVLayers)(const struct OpenSubdiv_Converter* converter);
103
104   // We need some corner connectivity information, which might not be trivial
105   // to be gathered (might require multiple matching calculations per corver
106   // query).
107   // precalc() is called before any corner connectivity or UV coordinate is
108   // queried from the given layer, allowing converter to calculate and cache
109   // complex complex-to-calculate information.
110   // finish() is called after converter is done porting UV layer to OpenSubdiv,
111   // allowing to free cached data.
112   void (*precalcUVLayer)(const struct OpenSubdiv_Converter* converter,
113                          const int layer_index);
114   void (*finishUVLayer)(const struct OpenSubdiv_Converter* converter);
115
116   // Get number of UV coordinates in the current layer (layer which was
117   // specified in precalcUVLayer().
118   int (*getNumUVCoordinates)(const struct OpenSubdiv_Converter* converter);
119   // For the given face index and its corner (known as loop in Blender)
120   // get corrsponding UV coordinate index.
121   int (*getFaceCornerUVIndex)(const struct OpenSubdiv_Converter* converter,
122                               const int face_index,
123                               const int corner_index);
124
125   //////////////////////////////////////////////////////////////////////////////
126   // User data associated with this converter.
127
128   void (*freeUserData)(const struct OpenSubdiv_Converter* converter);
129   void* user_data;
130 } OpenSubdiv_Converter;
131
132 #ifdef __cplusplus
133 }
134 #endif
135
136 #endif /* OPENSUBDIV_CONVERTER_CAPI_H_ */