9f559ee208b67c8eaff144b52950b131cd8673e7
[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   // Denotes whether this converter specifies full topology, which includes
38   // vertices, edges, faces, vertices+edges of a face and edges/faces of a
39   // vertex.
40   // Otherwise this converter will only provide number of vertices and faces,
41   // and vertices of faces. The rest of topology will be created by OpenSubdiv.
42   //
43   // NOTE: Even if converter does not provide full topology, it still needs
44   // to provide number of edges and vertices-of-edge. Those are used to assign
45   // topology tags.
46   bool (*specifiesFullTopology)(const struct OpenSubdiv_Converter* converter);
47
48   //////////////////////////////////////////////////////////////////////////////
49   // Global geometry counters.
50
51   // Number of faces/edges/vertices in the base mesh.
52   int (*getNumFaces)(const struct OpenSubdiv_Converter* converter);
53   int (*getNumEdges)(const struct OpenSubdiv_Converter* converter);
54   int (*getNumVertices)(const struct OpenSubdiv_Converter* converter);
55
56   //////////////////////////////////////////////////////////////////////////////
57   // Face relationships.
58
59   // Number of vertices the face consists of.
60   int (*getNumFaceVertices)(const struct OpenSubdiv_Converter* converter,
61                             const int face_index);
62   // Array of vertex indices the face consists of.
63   void (*getFaceVertices)(const struct OpenSubdiv_Converter* converter,
64                           const int face_index,
65                           int* face_vertices);
66   // Array of edge indices the face consists of.
67   // Aligned with the vertex indices array, edge i connects face vertex i
68   // with face index i+1.
69   void (*getFaceEdges)(const struct OpenSubdiv_Converter *converter,
70                        const int face_index,
71                        int *face_edges);
72
73   //////////////////////////////////////////////////////////////////////////////
74   // Edge relationships.
75
76   // Vertices the edge consists of.
77   void (*getEdgeVertices)(const struct OpenSubdiv_Converter* converter,
78                           const int edge_index,
79                           int edge_vertices[2]);
80   // Number of faces which are sharing the given edge.
81   int (*getNumEdgeFaces)(const struct OpenSubdiv_Converter* converter,
82                          const int edge_index);
83   // Array of face indices which are sharing the given edge.
84   void (*getEdgeFaces)(const struct OpenSubdiv_Converter* converter,
85                        const int edge,
86                        int* edge_faces);
87   // Edge sharpness (aka crease).
88   float (*getEdgeSharpness)(const struct OpenSubdiv_Converter* converter,
89                             const int edge_index);
90
91   //////////////////////////////////////////////////////////////////////////////
92   // Vertex relationships.
93
94   // Number of edges which are adjacent to the given vertex.
95   int (*getNumVertexEdges)(const struct OpenSubdiv_Converter* converter,
96                            const int vertex_index);
97   // Array fo edge indices which are adjacent to the given vertex.
98   void (*getVertexEdges)(const struct OpenSubdiv_Converter* converter,
99                          const int vertex_index,
100                          int* vertex_edges);
101   // Number of faces which are adjacent to the given vertex.
102   int (*getNumVertexFaces)(const struct OpenSubdiv_Converter* converter,
103                            const int vertex_index);
104   // Array fo face indices which are adjacent to the given vertex.
105   void (*getVertexFaces)(const struct OpenSubdiv_Converter* converter,
106                          const int vertex_index,
107                          int* vertex_faces);
108
109   // Check whether vertex is to be marked as an infinite sharp.
110   // This is a way to make sharp vertices which are adjacent to a loose edges.
111   bool (*isInfiniteSharpVertex)(const struct OpenSubdiv_Converter* converter,
112                                 const int vertex_index);
113
114   // If vertex is not infinitely sharp, this is it's actual sharpness.
115   float (*getVertexSharpness)(const struct OpenSubdiv_Converter* converter,
116                               const int vertex_index);
117
118   //////////////////////////////////////////////////////////////////////////////
119   // Face-varying data.
120
121   /////////////////////////////////////
122   // UV coordinates.
123
124   // Number of UV layers.
125   int (*getNumUVLayers)(const struct OpenSubdiv_Converter* converter);
126
127   // We need some corner connectivity information, which might not be trivial
128   // to be gathered (might require multiple matching calculations per corver
129   // query).
130   // precalc() is called before any corner connectivity or UV coordinate is
131   // queried from the given layer, allowing converter to calculate and cache
132   // complex complex-to-calculate information.
133   // finish() is called after converter is done porting UV layer to OpenSubdiv,
134   // allowing to free cached data.
135   void (*precalcUVLayer)(const struct OpenSubdiv_Converter* converter,
136                          const int layer_index);
137   void (*finishUVLayer)(const struct OpenSubdiv_Converter* converter);
138
139   // Get number of UV coordinates in the current layer (layer which was
140   // specified in precalcUVLayer().
141   int (*getNumUVCoordinates)(const struct OpenSubdiv_Converter* converter);
142   // For the given face index and its corner (known as loop in Blender)
143   // get corrsponding UV coordinate index.
144   int (*getFaceCornerUVIndex)(const struct OpenSubdiv_Converter* converter,
145                               const int face_index,
146                               const int corner_index);
147
148   //////////////////////////////////////////////////////////////////////////////
149   // User data associated with this converter.
150
151   void (*freeUserData)(const struct OpenSubdiv_Converter* converter);
152   void* user_data;
153 } OpenSubdiv_Converter;
154
155 #ifdef __cplusplus
156 }
157 #endif
158
159 #endif /* OPENSUBDIV_CONVERTER_CAPI_H_ */