patch [#34103] use boolean in path functions and add comments.
[blender.git] / source / blender / editors / sculpt_paint / paint_mask.c
1 /*
2  * $Id$
3  *
4  * ***** BEGIN GPL LICENSE BLOCK *****
5  *
6  * This program is free software; you can redistribute it and/or
7  * modify it under the terms of the GNU General Public License
8  * as published by the Free Software Foundation; either version 2
9  * of the License, or (at your option) any later version.
10  *
11  * This program is distributed in the hope that it will be useful,
12  * but WITHOUT ANY WARRANTY; without even the implied warranty of
13  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
14  * GNU General Public License for more details.
15  *
16  * You should have received a copy of the GNU General Public License
17  * along with this program; if not, write to the Free Software  Foundation,
18  * Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
19  *
20  * The Original Code is Copyright (C) 2012 by Nicholas Bishop
21  * All rights reserved.
22  *
23  * The Original Code is: all of this file.
24  *
25  * Contributor(s):
26  *
27  * ***** END GPL LICENSE BLOCK *****
28  *
29  */
30
31 /** \file blender/editors/sculpt_paint/paint_mask.c
32  *  \ingroup edsculpt
33  */
34
35 #include "MEM_guardedalloc.h"
36
37 #include "DNA_mesh_types.h"
38 #include "DNA_meshdata_types.h"
39 #include "DNA_object_types.h"
40
41 #include "BLI_utildefines.h"
42 #include "BKE_pbvh.h"
43 #include "BKE_ccg.h"
44 #include "BKE_context.h"
45 #include "BKE_DerivedMesh.h"
46 #include "BKE_multires.h"
47 #include "BKE_paint.h"
48 #include "BKE_subsurf.h"
49
50 #include "RNA_access.h"
51 #include "RNA_define.h"
52
53 #include "WM_api.h"
54 #include "WM_types.h"
55
56 #include "ED_screen.h"
57 #include "ED_sculpt.h"
58
59 #include "paint_intern.h"
60 #include "sculpt_intern.h" /* for undo push */
61
62 #include <stdlib.h>
63
64 static void mask_flood_fill_set_elem(float *elem,
65                                      PaintMaskFloodMode mode,
66                                      float value)
67 {
68         switch (mode) {
69                 case PAINT_MASK_FLOOD_VALUE:
70                         (*elem) = value;
71                         break;
72                 case PAINT_MASK_INVERT:
73                         (*elem) = 1.0f - (*elem);
74                         break;
75         }
76 }
77
78 static int mask_flood_fill_exec(bContext *C, wmOperator *op)
79 {
80         ARegion *ar = CTX_wm_region(C);
81         struct Scene *scene = CTX_data_scene(C);
82         Object *ob = CTX_data_active_object(C);
83         struct MultiresModifierData *mmd = sculpt_multires_active(scene, ob);
84         PaintMaskFloodMode mode;
85         float value;
86         DerivedMesh *dm;
87         PBVH *pbvh;
88         PBVHNode **nodes;
89         int totnode, i;
90
91         mode = RNA_enum_get(op->ptr, "mode");
92         value = RNA_float_get(op->ptr, "value");
93
94         ED_sculpt_mask_layers_ensure(ob, mmd);
95
96         dm = mesh_get_derived_final(scene, ob, CD_MASK_BAREMESH);
97         pbvh = dm->getPBVH(ob, dm);
98         ob->sculpt->pbvh = pbvh;
99
100         BKE_pbvh_search_gather(pbvh, NULL, NULL, &nodes, &totnode);
101
102         sculpt_undo_push_begin("Mask flood fill");
103
104         for (i = 0; i < totnode; i++) {
105                 PBVHVertexIter vi;
106
107                 sculpt_undo_push_node(ob, nodes[i], SCULPT_UNDO_MASK);
108
109                 BKE_pbvh_vertex_iter_begin(pbvh, nodes[i], vi, PBVH_ITER_UNIQUE) {
110                         mask_flood_fill_set_elem(vi.mask, mode, value);
111                 } BKE_pbvh_vertex_iter_end;
112                 
113                 BKE_pbvh_node_mark_update(nodes[i]);
114                 if (BKE_pbvh_type(pbvh) == PBVH_GRIDS)
115                         multires_mark_as_modified(ob, MULTIRES_COORDS_MODIFIED);
116         }
117         
118         sculpt_undo_push_end();
119
120         if (nodes)
121                 MEM_freeN(nodes);
122
123         ED_region_tag_redraw(ar);
124
125         return OPERATOR_FINISHED;
126 }
127
128 void PAINT_OT_mask_flood_fill(struct wmOperatorType *ot)
129 {
130         static EnumPropertyItem mode_items[] = {
131                 {PAINT_MASK_FLOOD_VALUE, "VALUE", 0, "Value", "Set mask to the level specified by the 'value' property"},
132                 {PAINT_MASK_INVERT, "INVERT", 0, "Invert", "Invert the mask"},
133                 {0}};
134
135         /* identifiers */
136         ot->name = "Mask Flood Fill";
137         ot->idname = "PAINT_OT_mask_flood_fill";
138         ot->description = "Fill the whole mask with a given value, or invert its values";
139
140         /* api callbacks */
141         ot->exec = mask_flood_fill_exec;
142         ot->poll = sculpt_mode_poll;
143
144         ot->flag = OPTYPE_REGISTER;
145
146         /* rna */
147         RNA_def_enum(ot->srna, "mode", mode_items, PAINT_MASK_FLOOD_VALUE, "Mode", NULL);
148         RNA_def_float(ot->srna, "value", 0, 0, 1, "Value",
149                       "Mask level to use when mode is 'Value'; zero means no masking and one is fully masked", 0, 1);
150 }