Merge branch 'master' into blender2.8
[blender.git] / source / blender / editors / sculpt_paint / sculpt_intern.h
1 /*
2  * ***** BEGIN GPL LICENSE BLOCK *****
3  *
4  * This program is free software; you can redistribute it and/or
5  * modify it under the terms of the GNU General Public License
6  * as published by the Free Software Foundation; either version 2
7  * of the License, or (at your option) any later version.
8  *
9  * This program is distributed in the hope that it will be useful,
10  * but WITHOUT ANY WARRANTY; without even the implied warranty of
11  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
12  * GNU General Public License for more details.
13  *
14  * You should have received a copy of the GNU General Public License
15  * along with this program; if not, write to the Free Software  Foundation,
16  * Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
17  *
18  * The Original Code is Copyright (C) 2006 by Nicholas Bishop
19  * All rights reserved.
20  *
21  * The Original Code is: all of this file.
22  *
23  * Contributor(s): none yet.
24  *
25  * ***** END GPL LICENSE BLOCK *****
26  */
27
28 /** \file blender/editors/sculpt_paint/sculpt_intern.h
29  *  \ingroup edsculpt
30  */
31
32
33 #ifndef __SCULPT_INTERN_H__
34 #define __SCULPT_INTERN_H__
35
36 #include "DNA_listBase.h"
37 #include "DNA_vec_types.h"
38 #include "DNA_key_types.h"
39
40 #include "BLI_bitmap.h"
41 #include "BLI_threads.h"
42
43 #include "BKE_pbvh.h"
44
45 struct bContext;
46 struct KeyBlock;
47 struct Object;
48 struct SculptUndoNode;
49 struct SculptOrigVertData;
50
51 int sculpt_mode_poll(struct bContext *C);
52 int sculpt_mode_poll_view3d(struct bContext *C);
53 /* checks for a brush, not just sculpt mode */
54 int sculpt_poll(struct bContext *C);
55 int sculpt_poll_view3d(struct bContext *C);
56
57 /* Stroke */
58 bool sculpt_stroke_get_location(struct bContext *C, float out[3], const float mouse[2]);
59
60 /* Dynamic topology */
61 void sculpt_pbvh_clear(Object *ob);
62 void sculpt_dyntopo_node_layers_add(struct SculptSession *ss);
63 void sculpt_update_after_dynamic_topology_toggle(
64         struct Depsgraph *depsgraph,
65         struct Scene *scene, struct Object *ob);
66 void sculpt_dynamic_topology_enable_ex(
67         struct Depsgraph *depsgraph,
68         struct Scene *scene, struct Object *ob);
69 void sculpt_dynamic_topology_enable(bContext *C);
70
71 void sculpt_dynamic_topology_disable_ex(
72         struct Depsgraph *depsgraph,
73         struct Scene *scene, struct Object *ob,
74         struct SculptUndoNode *unode);
75 void sculpt_dynamic_topology_disable(bContext *C, struct SculptUndoNode *unode);
76
77 /* Undo */
78
79 typedef enum {
80         SCULPT_UNDO_COORDS,
81         SCULPT_UNDO_HIDDEN,
82         SCULPT_UNDO_MASK,
83         SCULPT_UNDO_DYNTOPO_BEGIN,
84         SCULPT_UNDO_DYNTOPO_END,
85         SCULPT_UNDO_DYNTOPO_SYMMETRIZE,
86 } SculptUndoType;
87
88 typedef struct SculptUndoNode {
89         struct SculptUndoNode *next, *prev;
90
91         SculptUndoType type;
92
93         char idname[MAX_ID_NAME];   /* name instead of pointer*/
94         void *node;                 /* only during push, not valid afterwards! */
95
96         float (*co)[3];
97         float (*orig_co)[3];
98         short (*no)[3];
99         float *mask;
100         int totvert;
101
102         /* non-multires */
103         int maxvert;                /* to verify if totvert it still the same */
104         int *index;                 /* to restore into right location */
105         BLI_bitmap *vert_hidden;
106
107         /* multires */
108         int maxgrid;                /* same for grid */
109         int gridsize;               /* same for grid */
110         int totgrid;                /* to restore into right location */
111         int *grids;                 /* to restore into right location */
112         BLI_bitmap **grid_hidden;
113
114         /* bmesh */
115         struct BMLogEntry *bm_entry;
116         bool applied;
117         CustomData bm_enter_vdata;
118         CustomData bm_enter_edata;
119         CustomData bm_enter_ldata;
120         CustomData bm_enter_pdata;
121         int bm_enter_totvert;
122         int bm_enter_totedge;
123         int bm_enter_totloop;
124         int bm_enter_totpoly;
125
126         /* shape keys */
127         char shapeName[sizeof(((KeyBlock *)0))->name];
128
129         size_t undo_size;
130 } SculptUndoNode;
131
132 /* Factor of brush to have rake point following behind
133  * (could be configurable but this is reasonable default). */
134 #define SCULPT_RAKE_BRUSH_FACTOR 0.25f
135
136 struct SculptRakeData {
137         float follow_dist;
138         float follow_co[3];
139 };
140
141 /* Single struct used by all BLI_task threaded callbacks, let's avoid adding 10's of those... */
142 typedef struct SculptThreadedTaskData {
143         struct bContext *C;
144         struct Sculpt *sd;
145         struct Object *ob;
146         const struct Brush *brush;
147         struct PBVHNode **nodes;
148         int totnode;
149
150         struct VPaint *vp;
151         struct VPaintData *vpd;
152         struct WPaintData *wpd;
153         struct WeightPaintInfo *wpi;
154         unsigned int *lcol;
155         struct Mesh *me;
156         /* For passing generic params. */
157         void *custom_data;
158
159
160         /* Data specific to some callbacks. */
161         /* Note: even if only one or two of those are used at a time, keeping them separated, names help figuring out
162          *       what it is, and memory overhead is ridiculous anyway... */
163         float flippedbstrength;
164         float angle;
165         float strength;
166         bool smooth_mask;
167         bool has_bm_orco;
168
169         struct SculptProjectVector *spvc;
170         float *offset;
171         float *grab_delta;
172         float *cono;
173         float *area_no;
174         float *area_no_sp;
175         float *area_co;
176         float(*mat)[4];
177         float(*vertCos)[3];
178
179         /* 0=towards view, 1=flipped */
180         float(*area_cos)[3];
181         float(*area_nos)[3];
182         int *count;
183
184         ThreadMutex mutex;
185
186 } SculptThreadedTaskData;
187
188 /*************** Brush testing declarations ****************/
189 typedef struct SculptBrushTest {
190         float radius_squared;
191         float location[3];
192         float dist;
193         int mirror_symmetry_pass;
194
195         /* For circle (not sphere) projection. */
196         float plane_view[4];
197
198         /* Some tool code uses a plane for it's calculateions. */
199         float plane_tool[4];
200
201         /* View3d clipping - only set rv3d for clipping */
202         struct RegionView3D *clip_rv3d;
203 } SculptBrushTest;
204
205 typedef bool (*SculptBrushTestFn)(SculptBrushTest *test, const float co[3]);
206
207 typedef struct {
208         struct Sculpt *sd;
209         struct SculptSession *ss;
210         float radius_squared;
211         bool original;
212 } SculptSearchSphereData;
213
214 typedef struct {
215         struct Sculpt *sd;
216         struct SculptSession *ss;
217         float radius_squared;
218         bool original;
219         struct DistRayAABB_Precalc *dist_ray_to_aabb_precalc;
220 } SculptSearchCircleData;
221
222 void sculpt_brush_test_init(struct SculptSession *ss, SculptBrushTest *test);
223 bool sculpt_brush_test_sphere(SculptBrushTest *test, const float co[3]);
224 bool sculpt_brush_test_sphere_sq(SculptBrushTest *test, const float co[3]);
225 bool sculpt_brush_test_sphere_fast(const SculptBrushTest *test, const float co[3]);
226 bool sculpt_brush_test_cube(SculptBrushTest *test, const float co[3], float local[4][4]);
227 bool sculpt_brush_test_circle_sq(SculptBrushTest *test, const float co[3]);
228 bool sculpt_search_sphere_cb(PBVHNode *node, void *data_v);
229 bool sculpt_search_circle_cb(PBVHNode *node, void *data_v);
230
231 SculptBrushTestFn sculpt_brush_test_init_with_falloff_shape(
232         SculptSession *ss, SculptBrushTest *test, char falloff_shape);
233 const float *sculpt_brush_frontface_normal_from_falloff_shape(
234         SculptSession *ss, char falloff_shape);
235
236 float tex_strength(
237         struct SculptSession *ss, const struct Brush *br,
238         const float point[3],
239         const float len,
240         const short vno[3],
241         const float fno[3],
242         const float mask,
243         const int thread_id);
244
245 /* just for vertex paint. */
246 void sculpt_pbvh_calc_area_normal(
247         const struct Brush *brush, Object *ob,
248         PBVHNode **nodes, int totnode,
249         bool use_threading,
250         float r_area_no[3]);
251
252 /* Cache stroke properties. Used because
253  * RNA property lookup isn't particularly fast.
254  *
255  * For descriptions of these settings, check the operator properties.
256  */
257
258 typedef struct StrokeCache {
259         /* Invariants */
260         float initial_radius;
261         float scale[3];
262         int flag;
263         float clip_tolerance[3];
264         float initial_mouse[2];
265
266         /* Variants */
267         float radius;
268         float radius_squared;
269         float true_location[3];
270         float true_last_location[3];
271         float location[3];
272         float last_location[3];
273         bool is_last_valid;
274
275         bool pen_flip;
276         bool invert;
277         float pressure;
278         float mouse[2];
279         float bstrength;
280         float normal_weight;  /* from brush (with optional override) */
281
282         /* The rest is temporary storage that isn't saved as a property */
283
284         bool first_time; /* Beginning of stroke may do some things special */
285
286         /* from ED_view3d_ob_project_mat_get() */
287         float projection_mat[4][4];
288
289         /* Clean this up! */
290         struct ViewContext *vc;
291         const struct Brush *brush;
292
293         float special_rotation;
294         float grab_delta[3], grab_delta_symmetry[3];
295         float old_grab_location[3], orig_grab_location[3];
296
297         /* screen-space rotation defined by mouse motion */
298         float   rake_rotation[4], rake_rotation_symmetry[4];
299         bool is_rake_rotation_valid;
300         struct SculptRakeData rake_data;
301
302         /* Symmetry index between 0 and 7 bit combo 0 is Brush only;
303          * 1 is X mirror; 2 is Y mirror; 3 is XY; 4 is Z; 5 is XZ; 6 is YZ; 7 is XYZ */
304         int symmetry;
305         int mirror_symmetry_pass; /* the symmetry pass we are currently on between 0 and 7*/
306         float true_view_normal[3];
307         float view_normal[3];
308
309         /* sculpt_normal gets calculated by calc_sculpt_normal(), then the
310          * sculpt_normal_symm gets updated quickly with the usual symmetry
311          * transforms */
312         float sculpt_normal[3];
313         float sculpt_normal_symm[3];
314
315         /* Used for area texture mode, local_mat gets calculated by
316          * calc_brush_local_mat() and used in tex_strength(). */
317         float brush_local_mat[4][4];
318
319         float plane_offset[3]; /* used to shift the plane around when doing tiled strokes */
320         int tile_pass;
321
322         float last_center[3];
323         int radial_symmetry_pass;
324         float symm_rot_mat[4][4];
325         float symm_rot_mat_inv[4][4];
326         bool original;
327         float anchored_location[3];
328
329         float vertex_rotation; /* amount to rotate the vertices when using rotate brush */
330         struct Dial *dial;
331
332         char saved_active_brush_name[MAX_ID_NAME];
333         char saved_mask_brush_tool;
334         int saved_smooth_size; /* smooth tool copies the size of the current tool */
335         bool alt_smooth;
336
337         float plane_trim_squared;
338
339         bool supports_gravity;
340         float true_gravity_direction[3];
341         float gravity_direction[3];
342
343         rcti previous_r; /* previous redraw rectangle */
344         rcti current_r; /* current redraw rectangle */
345
346 } StrokeCache;
347
348 void sculpt_cache_calc_brushdata_symm(
349         StrokeCache *cache, const char symm,
350         const char axis, const float angle);
351 void sculpt_cache_free(StrokeCache *cache);
352
353 SculptUndoNode *sculpt_undo_push_node(Object *ob, PBVHNode *node, SculptUndoType type);
354 SculptUndoNode *sculpt_undo_get_node(PBVHNode *node);
355 void sculpt_undo_push_begin(const char *name);
356 void sculpt_undo_push_end(void);
357
358 void sculpt_vertcos_to_key(Object *ob, KeyBlock *kb, float (*vertCos)[3]);
359
360 void sculpt_update_object_bounding_box(struct Object *ob);
361
362 bool sculpt_get_redraw_rect(struct ARegion *ar, struct RegionView3D *rv3d, Object *ob, rcti *rect);
363
364 #define SCULPT_THREADED_LIMIT 4
365
366 #endif