Cleanup: remove redundant doxygen \file argument
[blender.git] / source / blender / blenkernel / BKE_subdiv_eval.h
1 /*
2  * This program is free software; you can redistribute it and/or
3  * modify it under the terms of the GNU General Public License
4  * as published by the Free Software Foundation; either version 2
5  * of the License, or (at your option) any later version.
6  *
7  * This program is distributed in the hope that it will be useful,
8  * but WITHOUT ANY WARRANTY; without even the implied warranty of
9  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
10  * GNU General Public License for more details.
11  *
12  * You should have received a copy of the GNU General Public License
13  * along with this program; if not, write to the Free Software Foundation,
14  * Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
15  *
16  * The Original Code is Copyright (C) 2018 by Blender Foundation.
17  * All rights reserved.
18  */
19
20 /** \file \ingroup bke
21  */
22
23 #ifndef __BKE_SUBDIV_EVAL_H__
24 #define __BKE_SUBDIV_EVAL_H__
25
26 #include "BLI_sys_types.h"
27
28 struct Mesh;
29 struct Subdiv;
30
31 /* Returns true if evaluator is ready for use. */
32 bool BKE_subdiv_eval_begin(struct Subdiv *subdiv);
33 bool BKE_subdiv_eval_update_from_mesh(struct Subdiv *subdiv,
34                                       const struct Mesh *mesh);
35
36 /* Makes sure displacement evaluator is initialized.
37  *
38  * NOTE: This function must be called once before evaluating displacement or
39  * final surface position. */
40 void BKE_subdiv_eval_init_displacement(struct Subdiv *subdiv);
41
42 /* Single point queries. */
43
44 void BKE_subdiv_eval_limit_point(
45         struct Subdiv *subdiv,
46         const int ptex_face_index,
47         const float u, const float v,
48         float r_P[3]);
49 void BKE_subdiv_eval_limit_point_and_derivatives(
50         struct Subdiv *subdiv,
51         const int ptex_face_index,
52         const float u, const float v,
53         float r_P[3], float r_dPdu[3], float r_dPdv[3]);
54 void BKE_subdiv_eval_limit_point_and_normal(
55         struct Subdiv *subdiv,
56         const int ptex_face_index,
57         const float u, const float v,
58         float r_P[3], float r_N[3]);
59 void BKE_subdiv_eval_limit_point_and_short_normal(
60         struct Subdiv *subdiv,
61         const int ptex_face_index,
62         const float u, const float v,
63         float r_P[3], short r_N[3]);
64
65 void BKE_subdiv_eval_face_varying(
66         struct Subdiv *subdiv,
67         const int face_varying_channel,
68         const int ptex_face_index,
69         const float u, const float v,
70         float r_varying[2]);
71
72 /* NOTE: Expects derivatives to be correct.
73  *
74  * TODO(sergey): This is currently used together with
75  * BKE_subdiv_eval_final_point() which cas easily evaluate derivatives.
76  * Would be nice to have dispalcement evaluation function which does not require
77  * knowing derivatives ahead of a time. */
78 void BKE_subdiv_eval_displacement(
79         struct Subdiv *subdiv,
80         const int ptex_face_index,
81         const float u, const float v,
82         const float dPdu[3], const float dPdv[3],
83         float r_D[3]);
84
85 void BKE_subdiv_eval_final_point(
86         struct Subdiv *subdiv,
87         const int ptex_face_index,
88         const float u, const float v,
89         float r_P[3]);
90
91 /* Patch queries at given resolution.
92  *
93  * Will evaluate patch at uniformly distributed (u, v) coordinates on a grid
94  * of given resolution, producing resolution^2 evaluation points. The order
95  * goes as u in rows, v in columns. */
96
97 void BKE_subdiv_eval_limit_patch_resolution_point(
98         struct Subdiv *subdiv,
99         const int ptex_face_index,
100         const int resolution,
101         void *buffer, const int offset, const int stride);
102 void BKE_subdiv_eval_limit_patch_resolution_point_and_derivatives(
103         struct Subdiv *subdiv,
104         const int ptex_face_index,
105         const int resolution,
106         void *point_buffer, const int point_offset, const int point_stride,
107         void *du_buffer, const int du_offset, const int du_stride,
108         void *dv_buffer, const int dv_offset, const int dv_stride);
109 void BKE_subdiv_eval_limit_patch_resolution_point_and_normal(
110         struct Subdiv *subdiv,
111         const int ptex_face_index,
112         const int resolution,
113         void *point_buffer, const int point_offset, const int point_stride,
114         void *normal_buffer, const int normal_offset, const int normal_stride);
115 void BKE_subdiv_eval_limit_patch_resolution_point_and_short_normal(
116         struct Subdiv *subdiv,
117         const int ptex_face_index,
118         const int resolution,
119         void *point_buffer, const int point_offset, const int point_stride,
120         void *normal_buffer, const int normal_offset, const int normal_stride);
121
122 #endif  /* __BKE_SUBDIV_EVAL_H__ */