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