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