ClangFormat: apply to source, most of intern
[blender.git] / source / blender / blenkernel / BKE_multires.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) 2007 by Nicholas Bishop
17  * All rights reserved.
18  */
19
20 #ifndef __BKE_MULTIRES_H__
21 #define __BKE_MULTIRES_H__
22
23 /** \file
24  * \ingroup bke
25  */
26
27 #include "BLI_compiler_compat.h"
28
29 enum MultiresModifiedFlags;
30
31 struct Depsgraph;
32 struct DerivedMesh;
33 struct MDisps;
34 struct Mesh;
35 struct ModifierData;
36 struct Multires;
37 struct MultiresModifierData;
38 struct Object;
39 struct Scene;
40 struct SubdivCCG;
41
42 struct MLoop;
43 struct MLoopTri;
44 struct MPoly;
45 struct MVert;
46
47 /* Delete mesh mdisps and grid paint masks */
48 void multires_customdata_delete(struct Mesh *me);
49
50 void multires_set_tot_level(struct Object *ob, struct MultiresModifierData *mmd, int lvl);
51
52 void multires_mark_as_modified(struct Object *ob, enum MultiresModifiedFlags flags);
53
54 void multires_force_update(struct Object *ob);
55 void multires_force_render_update(struct Object *ob);
56 void multires_force_external_reload(struct Object *ob);
57
58 /* internal, only called in subsurf_ccg.c */
59 void multires_modifier_update_mdisps(struct DerivedMesh *dm, struct Scene *scene);
60 void multires_modifier_update_hidden(struct DerivedMesh *dm);
61
62 void multiresModifier_set_levels_from_disps(struct MultiresModifierData *mmd, struct Object *ob);
63
64 typedef enum {
65   MULTIRES_USE_LOCAL_MMD = 1,
66   MULTIRES_USE_RENDER_PARAMS = 2,
67   MULTIRES_ALLOC_PAINT_MASK = 4,
68   MULTIRES_IGNORE_SIMPLIFY = 8,
69 } MultiresFlags;
70
71 struct DerivedMesh *multires_make_derived_from_derived(struct DerivedMesh *dm,
72                                                        struct MultiresModifierData *mmd,
73                                                        struct Scene *scene,
74                                                        struct Object *ob,
75                                                        MultiresFlags flags);
76
77 struct MultiresModifierData *find_multires_modifier_before(struct Scene *scene,
78                                                            struct ModifierData *lastmd);
79 struct MultiresModifierData *get_multires_modifier(struct Scene *scene,
80                                                    struct Object *ob,
81                                                    bool use_first);
82 int multires_get_level(const struct Scene *scene,
83                        const struct Object *ob,
84                        const struct MultiresModifierData *mmd,
85                        bool render,
86                        bool ignore_simplify);
87 struct Mesh *BKE_multires_create_mesh(struct Depsgraph *depsgraph,
88                                       struct Scene *scene,
89                                       struct MultiresModifierData *mmd,
90                                       struct Object *ob);
91 void multiresModifier_del_levels(struct MultiresModifierData *mmd,
92                                  struct Scene *scene,
93                                  struct Object *object,
94                                  int direction);
95 void multiresModifier_base_apply(struct MultiresModifierData *mmd,
96                                  struct Scene *scene,
97                                  struct Object *ob);
98 void multiresModifier_subdivide(struct MultiresModifierData *mmd,
99                                 struct Scene *scene,
100                                 struct Object *ob,
101                                 int updateblock,
102                                 int simple);
103 void multiresModifier_sync_levels_ex(struct Scene *scene,
104                                      struct Object *ob_dst,
105                                      struct MultiresModifierData *mmd_src,
106                                      struct MultiresModifierData *mmd_dst);
107
108 void multires_stitch_grids(struct Object *);
109
110 /* Related to the old multires */
111 void multires_free(struct Multires *mr);
112 void multires_load_old(struct Object *ob, struct Mesh *me);
113 void multires_load_old_250(struct Mesh *);
114
115 void multiresModifier_scale_disp(struct Depsgraph *depsgraph,
116                                  struct Scene *scene,
117                                  struct Object *ob);
118 void multiresModifier_prepare_join(struct Depsgraph *depsgraph,
119                                    struct Scene *scene,
120                                    struct Object *ob,
121                                    struct Object *to_ob);
122
123 int multires_mdisp_corners(struct MDisps *s);
124
125 /* update multires data after topology changing */
126 void multires_topology_changed(struct Mesh *me);
127
128 /**** interpolation stuff ****/
129 void old_mdisps_bilinear(float out[3], float (*disps)[3], const int st, float u, float v);
130 int mdisp_rot_face_to_crn(struct MVert *mvert,
131                           struct MPoly *mpoly,
132                           struct MLoop *mloops,
133                           const struct MLoopTri *lt,
134                           const int face_side,
135                           const float u,
136                           const float v,
137                           float *x,
138                           float *y);
139
140 /* Reshaping, define in multires_reshape.c */
141
142 bool multiresModifier_reshapeFromObject(struct Depsgraph *depsgraph,
143                                         struct MultiresModifierData *mmd,
144                                         struct Object *dst,
145                                         struct Object *src);
146 bool multiresModifier_reshapeFromDeformModifier(struct Depsgraph *depsgraph,
147                                                 struct MultiresModifierData *mmd,
148                                                 struct Object *ob,
149                                                 struct ModifierData *md);
150 bool multiresModifier_reshapeFromCCG(const int tot_level,
151                                      struct Mesh *coarse_mesh,
152                                      struct SubdivCCG *subdiv_ccg);
153
154 /* Subdivision integration, defined in multires_subdiv.c */
155
156 struct SubdivSettings;
157 struct SubdivToMeshSettings;
158
159 void BKE_multires_subdiv_settings_init(struct SubdivSettings *settings,
160                                        const struct MultiresModifierData *mmd);
161
162 /* TODO(sergey): Replace this set of boolean flags with bitmask. */
163 void BKE_multires_subdiv_mesh_settings_init(struct SubdivToMeshSettings *mesh_settings,
164                                             const struct Scene *scene,
165                                             const struct Object *object,
166                                             const struct MultiresModifierData *mmd,
167                                             const bool use_render_params,
168                                             const bool ignore_simplify);
169
170 /* General helpers. */
171
172 /* For a given partial derivatives of a ptex face get tangent matrix for
173  * displacement.
174  *
175  * Corner needs to be known to properly "rotate" partial derivatives when the
176  * matrix is being constructed for quad. For non-quad the corner is to be set
177  * to 0. */
178 BLI_INLINE void BKE_multires_construct_tangent_matrix(float tangent_matrix[3][3],
179                                                       const float dPdu[3],
180                                                       const float dPdv[3],
181                                                       const int corner);
182
183 #include "intern/multires_inline.h"
184
185 #endif /* __BKE_MULTIRES_H__ */