d519511031428c05edd78ca7473e467d4d6eb8de
[blender-staging.git] / source / blender / makesrna / intern / rna_brush.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., 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.
19  *
20  * Contributor(s): Blender Foundation (2008), Juho Veps�l�inen
21  *
22  * ***** END GPL LICENSE BLOCK *****
23  */
24
25 #include <stdlib.h>
26
27 #include "RNA_define.h"
28 #include "RNA_types.h"
29
30 #include "rna_internal.h"
31
32 #include "DNA_brush_types.h"
33 #include "DNA_texture_types.h"
34
35 #include "IMB_imbuf.h"
36
37 EnumPropertyItem brush_sculpt_tool_items[] = {
38         {SCULPT_TOOL_DRAW, "DRAW", 0, "Draw", ""},
39         {SCULPT_TOOL_SMOOTH, "SMOOTH", 0, "Smooth", ""},
40         {SCULPT_TOOL_PINCH, "PINCH", 0, "Pinch", ""},
41         {SCULPT_TOOL_INFLATE, "INFLATE", 0, "Inflate", ""},
42         {SCULPT_TOOL_GRAB, "GRAB", 0, "Grab", ""},
43         {SCULPT_TOOL_LAYER, "LAYER", 0, "Layer", ""},
44         {SCULPT_TOOL_FLATTEN, "FLATTEN", 0, "Flatten", ""},
45         {SCULPT_TOOL_CLAY, "CLAY", 0, "Clay", ""},
46         {0, NULL, 0, NULL, NULL}};
47
48 #ifdef RNA_RUNTIME
49
50 #include "MEM_guardedalloc.h"
51
52 #include "BKE_texture.h"
53
54 #include "WM_api.h"
55 #include "WM_types.h"
56
57 static void rna_Brush_mtex_begin(CollectionPropertyIterator *iter, PointerRNA *ptr)
58 {
59         Brush *brush= (Brush*)ptr->data;
60         rna_iterator_array_begin(iter, (void*)brush->mtex, sizeof(MTex*), MAX_MTEX, 0, NULL);
61 }
62
63 static PointerRNA rna_Brush_active_texture_get(PointerRNA *ptr)
64 {
65         Brush *br= (Brush*)ptr->data;
66         Tex *tex;
67
68         tex= (br->mtex[(int)br->texact])? br->mtex[(int)br->texact]->tex: NULL;
69         return rna_pointer_inherit_refine(ptr, &RNA_Texture, tex);
70 }
71
72 static void rna_Brush_active_texture_set(PointerRNA *ptr, PointerRNA value)
73 {
74         Brush *br= (Brush*)ptr->data;
75         int act= br->texact;
76
77         if(br->mtex[act] && br->mtex[act]->tex)
78                 id_us_min(&br->mtex[act]->tex->id);
79
80         if(value.data) {
81                 if(!br->mtex[act])
82                         br->mtex[act]= add_mtex();
83                 
84                 br->mtex[act]->tex= value.data;
85                 id_us_plus(&br->mtex[act]->tex->id);
86         }
87         else if(br->mtex[act]) {
88                 MEM_freeN(br->mtex[act]);
89                 br->mtex[act]= NULL;
90         }
91 }
92
93 static void rna_Brush_update(bContext *C, PointerRNA *ptr)
94 {
95         Brush *br= (Brush*)ptr->data;
96         WM_event_add_notifier(C, NC_BRUSH|NA_EDITED, br);
97 }
98
99 #else
100
101 static void rna_def_brush(BlenderRNA *brna)
102 {
103         StructRNA *srna;
104         PropertyRNA *prop;
105         
106         static EnumPropertyItem prop_blend_items[] = {
107                 {IMB_BLEND_MIX, "MIX", 0, "Mix", "Use mix blending mode while painting."},
108                 {IMB_BLEND_ADD, "ADD", 0, "Add", "Use add blending mode while painting."},
109                 {IMB_BLEND_SUB, "SUB", 0, "Subtract", "Use subtract blending mode while painting."},
110                 {IMB_BLEND_MUL, "MUL", 0, "Multiply", "Use multiply blending mode while painting."},
111                 {IMB_BLEND_LIGHTEN, "LIGHTEN", 0, "Lighten", "Use lighten blending mode while painting."},
112                 {IMB_BLEND_DARKEN, "DARKEN", 0, "Darken", "Use darken blending mode while painting."},
113                 {IMB_BLEND_ERASE_ALPHA, "ERASE_ALPHA", 0, "Erase Alpha", "Erase alpha while painting."},
114                 {IMB_BLEND_ADD_ALPHA, "ADD_ALPHA", 0, "Add Alpha", "Add alpha while painting."},
115                 {0, NULL, 0, NULL, NULL}};
116         
117         static const EnumPropertyItem prop_flip_direction_items[]= {
118                 {0, "ADD", 0, "Add", "Add effect of brush"},
119                 {BRUSH_DIR_IN, "SUBTRACT", 0, "Subtract", "Subtract effect of brush"},
120                 {0, NULL, 0, NULL, NULL}};
121                 
122         srna= RNA_def_struct(brna, "Brush", "ID");
123         RNA_def_struct_ui_text(srna, "Brush", "Brush datablock for storing brush settings for painting and sculpting.");
124         RNA_def_struct_ui_icon(srna, ICON_BRUSH_DATA);
125         
126         /* enums */
127         prop= RNA_def_property(srna, "blend", PROP_ENUM, PROP_NONE);
128         RNA_def_property_enum_items(prop, prop_blend_items);
129         RNA_def_property_ui_text(prop, "Blending mode", "Brush blending mode.");
130         RNA_def_property_update(prop, 0, "rna_Brush_update");
131
132         prop= RNA_def_property(srna, "sculpt_tool", PROP_ENUM, PROP_NONE);
133         RNA_def_property_enum_items(prop, brush_sculpt_tool_items);
134         RNA_def_property_ui_text(prop, "Sculpt Tool", "");
135         RNA_def_property_update(prop, 0, "rna_Brush_update");
136
137         prop= RNA_def_property(srna, "direction", PROP_ENUM, PROP_NONE);
138         RNA_def_property_enum_bitflag_sdna(prop, NULL, "flag");
139         RNA_def_property_enum_items(prop, prop_flip_direction_items);
140         RNA_def_property_ui_text(prop, "Direction", "Mapping type to use for this image in the game engine.");
141         RNA_def_property_update(prop, 0, "rna_Brush_update");
142         
143         /* number values */
144         prop= RNA_def_property(srna, "size", PROP_INT, PROP_NONE);
145         RNA_def_property_range(prop, 1, 200);
146         RNA_def_property_ui_text(prop, "Size", "Diameter of the brush.");
147         RNA_def_property_update(prop, 0, "rna_Brush_update");
148         
149         prop= RNA_def_property(srna, "jitter", PROP_FLOAT, PROP_NONE);
150         RNA_def_property_float_sdna(prop, NULL, "jitter");
151         RNA_def_property_range(prop, 0.0f, 1.0f);
152         RNA_def_property_ui_text(prop, "Jitter", "Jitter the position of the brush while painting.");
153         RNA_def_property_update(prop, 0, "rna_Brush_update");
154
155         prop= RNA_def_property(srna, "spacing", PROP_FLOAT, PROP_NONE);
156         RNA_def_property_float_sdna(prop, NULL, "spacing");
157         RNA_def_property_range(prop, 1.0f, 100.0f);
158         RNA_def_property_ui_text(prop, "Spacing", "Spacing between brush stamps.");
159         RNA_def_property_update(prop, 0, "rna_Brush_update");
160
161         prop= RNA_def_property(srna, "smooth_stroke_radius", PROP_INT, PROP_NONE);
162         RNA_def_property_range(prop, 10, 200);
163         RNA_def_property_ui_text(prop, "Smooth Stroke Radius", "Minimum distance from last point before stroke continues.");
164         RNA_def_property_update(prop, 0, "rna_Brush_update");
165
166         prop= RNA_def_property(srna, "smooth_stroke_factor", PROP_FLOAT, PROP_NONE);
167         RNA_def_property_range(prop, 0.5, 0.99);
168         RNA_def_property_ui_text(prop, "Smooth Stroke Factor", "Higher values give a smoother stroke.");
169         RNA_def_property_update(prop, 0, "rna_Brush_update");
170         
171         prop= RNA_def_property(srna, "rate", PROP_FLOAT, PROP_NONE);
172         RNA_def_property_float_sdna(prop, NULL, "rate");
173         RNA_def_property_range(prop, 0.010f, 1.0f);
174         RNA_def_property_ui_text(prop, "Rate", "Number of paints per second for Airbrush.");
175         RNA_def_property_update(prop, 0, "rna_Brush_update");
176         
177         prop= RNA_def_property(srna, "color", PROP_FLOAT, PROP_COLOR);
178         RNA_def_property_float_sdna(prop, NULL, "rgb");
179         RNA_def_property_ui_text(prop, "Color", "");
180         RNA_def_property_update(prop, 0, "rna_Brush_update");
181         
182         prop= RNA_def_property(srna, "strength", PROP_FLOAT, PROP_NONE);
183         RNA_def_property_float_sdna(prop, NULL, "alpha");
184         RNA_def_property_range(prop, 0.0f, 1.0f);
185         RNA_def_property_ui_text(prop, "Strength", "The amount of pressure on the brush.");
186         RNA_def_property_update(prop, 0, "rna_Brush_update");
187
188         /* flag */
189         prop= RNA_def_property(srna, "use_airbrush", PROP_BOOLEAN, PROP_NONE);
190         RNA_def_property_boolean_sdna(prop, NULL, "flag", BRUSH_AIRBRUSH);
191         RNA_def_property_ui_text(prop, "Airbrush", "Keep applying paint effect while holding mouse (spray).");
192         RNA_def_property_update(prop, 0, "rna_Brush_update");
193         
194         prop= RNA_def_property(srna, "use_wrap", PROP_BOOLEAN, PROP_NONE);
195         RNA_def_property_boolean_sdna(prop, NULL, "flag", BRUSH_TORUS);
196         RNA_def_property_ui_text(prop, "Wrap", "Enable torus wrapping while painting.");
197         RNA_def_property_update(prop, 0, "rna_Brush_update");
198         
199         prop= RNA_def_property(srna, "use_strength_pressure", PROP_BOOLEAN, PROP_NONE);
200         RNA_def_property_boolean_sdna(prop, NULL, "flag", BRUSH_ALPHA_PRESSURE);
201         RNA_def_property_ui_icon(prop, ICON_STYLUS_PRESSURE, 0);
202         RNA_def_property_ui_text(prop, "Strength Pressure", "Enable tablet pressure sensitivity for strength.");
203         RNA_def_property_update(prop, 0, "rna_Brush_update");
204         
205         prop= RNA_def_property(srna, "use_size_pressure", PROP_BOOLEAN, PROP_NONE);
206         RNA_def_property_boolean_sdna(prop, NULL, "flag", BRUSH_SIZE_PRESSURE);
207         RNA_def_property_ui_icon(prop, ICON_STYLUS_PRESSURE, 0);
208         RNA_def_property_ui_text(prop, "Size Pressure", "Enable tablet pressure sensitivity for size.");
209         RNA_def_property_update(prop, 0, "rna_Brush_update");
210         
211         prop= RNA_def_property(srna, "use_jitter_pressure", PROP_BOOLEAN, PROP_NONE);
212         RNA_def_property_boolean_sdna(prop, NULL, "flag", BRUSH_JITTER_PRESSURE);
213         RNA_def_property_ui_icon(prop, ICON_STYLUS_PRESSURE, 0);
214         RNA_def_property_ui_text(prop, "Jitter Pressure", "Enable tablet pressure sensitivity for jitter.");
215         RNA_def_property_update(prop, 0, "rna_Brush_update");
216
217         prop= RNA_def_property(srna, "use_spacing_pressure", PROP_BOOLEAN, PROP_NONE);
218         RNA_def_property_boolean_sdna(prop, NULL, "flag", BRUSH_SPACING_PRESSURE);
219         RNA_def_property_ui_icon(prop, ICON_STYLUS_PRESSURE, 0);
220         RNA_def_property_ui_text(prop, "Spacing Pressure", "Enable tablet pressure sensitivity for spacing.");
221         RNA_def_property_update(prop, 0, "rna_Brush_update");
222
223         prop= RNA_def_property(srna, "use_rake", PROP_BOOLEAN, PROP_NONE);
224         RNA_def_property_boolean_sdna(prop, NULL, "flag", BRUSH_RAKE);
225         RNA_def_property_ui_text(prop, "Rake", "Rotate the brush texture to match the stroke direction.");
226         RNA_def_property_update(prop, 0, "rna_Brush_update");
227
228         prop= RNA_def_property(srna, "use_anchor", PROP_BOOLEAN, PROP_NONE);
229         RNA_def_property_boolean_sdna(prop, NULL, "flag", BRUSH_ANCHORED);
230         RNA_def_property_ui_text(prop, "Anchored", "Keep the brush anchored to the initial location.");
231         RNA_def_property_update(prop, 0, "rna_Brush_update");
232
233         prop= RNA_def_property(srna, "use_space", PROP_BOOLEAN, PROP_NONE);
234         RNA_def_property_boolean_sdna(prop, NULL, "flag", BRUSH_SPACE);
235         RNA_def_property_ui_text(prop, "Space", "Limit brush application to the distance specified by spacing.");
236         RNA_def_property_update(prop, 0, "rna_Brush_update");
237
238         prop= RNA_def_property(srna, "use_smooth_stroke", PROP_BOOLEAN, PROP_NONE);
239         RNA_def_property_boolean_sdna(prop, NULL, "flag", BRUSH_SMOOTH_STROKE);
240         RNA_def_property_ui_text(prop, "Smooth Stroke", "Brush lags behind mouse and follows a smoother path.");
241         RNA_def_property_update(prop, 0, "rna_Brush_update");
242
243         prop= RNA_def_property(srna, "use_persistent", PROP_BOOLEAN, PROP_NONE);
244         RNA_def_property_boolean_sdna(prop, NULL, "flag", BRUSH_PERSISTENT);
245         RNA_def_property_ui_text(prop, "Persistent", "Sculpts on a persistent layer of the mesh.");
246         RNA_def_property_update(prop, 0, "rna_Brush_update");
247         
248         /* not exposed in the interface yet
249         prop= RNA_def_property(srna, "fixed_tex", PROP_BOOLEAN, PROP_NONE);
250         RNA_def_property_boolean_sdna(prop, NULL, "flag", BRUSH_FIXED_TEX);
251         RNA_def_property_ui_text(prop, "Fixed Texture", "Keep texture origin in fixed position.");
252         RNA_def_property_update(prop, 0, "rna_Brush_update"); */
253
254         prop= RNA_def_property(srna, "curve", PROP_POINTER, PROP_NONE);
255         RNA_def_property_flag(prop, PROP_NEVER_NULL);
256         RNA_def_property_ui_text(prop, "Curve", "Editable falloff curve.");
257         RNA_def_property_update(prop, 0, "rna_Brush_update");
258
259         /* texture */
260         rna_def_mtex_common(srna, "rna_Brush_mtex_begin", "rna_Brush_active_texture_get",
261                 "rna_Brush_active_texture_set", "TextureSlot", "rna_Brush_update");
262
263         /* clone tool */
264         prop= RNA_def_property(srna, "clone_image", PROP_POINTER, PROP_NONE);
265         RNA_def_property_pointer_sdna(prop, NULL, "clone.image");
266         RNA_def_property_flag(prop, PROP_EDITABLE);
267         RNA_def_property_ui_text(prop, "Clone Image", "Image for clone tool.");
268         RNA_def_property_update(prop, 0, "rna_Brush_update");
269         
270         prop= RNA_def_property(srna, "clone_opacity", PROP_FLOAT, PROP_NONE);
271         RNA_def_property_float_sdna(prop, NULL, "clone.alpha");
272         RNA_def_property_range(prop, 0.0f, 1.0f);
273         RNA_def_property_ui_text(prop, "Clone Opacity", "Opacity of clone image display.");
274         RNA_def_property_update(prop, 0, "rna_Brush_update");
275
276         prop= RNA_def_property(srna, "clone_offset", PROP_FLOAT, PROP_XYZ);
277         RNA_def_property_float_sdna(prop, NULL, "clone.offset");
278         RNA_def_property_ui_text(prop, "Clone Offset", "");
279         RNA_def_property_ui_range(prop, -1.0f , 1.0f, 10.0f, 3);
280         RNA_def_property_update(prop, 0, "rna_Brush_update");
281 }
282
283
284 /* A brush stroke is a list of changes to the brush that
285  * can occur during a stroke
286  *
287  *  o 3D location of the brush
288  *  o 2D mouse location
289  *  o Tablet pressure
290  *  o Direction flip
291  *  o Tool switch
292  *  o Time
293  */
294 static void rna_def_operator_stroke_element(BlenderRNA *brna)
295 {
296         StructRNA *srna;
297         PropertyRNA *prop;
298
299         srna= RNA_def_struct(brna, "OperatorStrokeElement", "IDPropertyGroup");
300         RNA_def_struct_ui_text(srna, "Operator Stroke Element", "");
301
302         prop= RNA_def_property(srna, "location", PROP_FLOAT, PROP_XYZ);
303         RNA_def_property_flag(prop, PROP_IDPROPERTY);
304         RNA_def_property_array(prop, 3);
305         RNA_def_property_ui_text(prop, "Location", "");
306
307         prop= RNA_def_property(srna, "mouse", PROP_FLOAT, PROP_XYZ);
308         RNA_def_property_flag(prop, PROP_IDPROPERTY);
309         RNA_def_property_array(prop, 2);
310         RNA_def_property_ui_text(prop, "Mouse", "");
311
312         prop= RNA_def_property(srna, "pressure", PROP_FLOAT, PROP_NONE);
313         RNA_def_property_flag(prop, PROP_IDPROPERTY);
314         RNA_def_property_range(prop, 0.0f, 1.0f);
315         RNA_def_property_ui_text(prop, "Pressure", "Tablet pressure.");
316
317         prop= RNA_def_property(srna, "time", PROP_FLOAT, PROP_UNSIGNED);
318         RNA_def_property_flag(prop, PROP_IDPROPERTY);
319         RNA_def_property_ui_text(prop, "Time", "");
320
321         prop= RNA_def_property(srna, "flip", PROP_BOOLEAN, PROP_NONE);
322         RNA_def_property_flag(prop, PROP_IDPROPERTY);
323         RNA_def_property_ui_text(prop, "Flip", "");
324
325         /* XXX: Tool (this will be for pressing a modifier key for a different brush,
326                 e.g. switching to a Smooth brush in the middle of the stroke */
327 }
328
329 void RNA_def_brush(BlenderRNA *brna)
330 {
331         rna_def_brush(brna);
332         rna_def_operator_stroke_element(brna);
333 }
334
335 #endif