batch remove .'s used with RNA_def_struct_ui_text
[blender.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 "BLI_math.h"
36
37 #include "IMB_imbuf.h"
38
39 #include "WM_types.h"
40
41 #ifdef RNA_RUNTIME
42
43 #include "MEM_guardedalloc.h"
44
45 #include "BKE_texture.h"
46
47 #include "WM_api.h"
48
49 static void rna_Brush_update(Main *bmain, Scene *scene, PointerRNA *ptr)
50 {
51         Brush *br= (Brush*)ptr->data;
52         WM_main_add_notifier(NC_BRUSH|NA_EDITED, br);
53 }
54
55 #else
56
57 static void rna_def_brush_texture_slot(BlenderRNA *brna)
58 {
59         StructRNA *srna;
60         PropertyRNA *prop;
61
62         static EnumPropertyItem prop_map_mode_items[] = {
63                 {MTEX_MAP_MODE_FIXED, "FIXED", 0, "Fixed", ""},
64                 {MTEX_MAP_MODE_TILED, "TILED", 0, "Tiled", ""},
65                 {MTEX_MAP_MODE_3D, "3D", 0, "3D", ""},
66                 {0, NULL, 0, NULL, NULL}};
67
68         srna= RNA_def_struct(brna, "BrushTextureSlot", "TextureSlot");
69         RNA_def_struct_sdna(srna, "MTex");
70         RNA_def_struct_ui_text(srna, "Brush Texture Slot", "Texture slot for textures in a Brush datablock");
71
72         prop= RNA_def_property(srna, "angle", PROP_FLOAT, PROP_ANGLE);
73         RNA_def_property_float_sdna(prop, NULL, "rot");
74         RNA_def_property_range(prop, 0, M_PI*2);
75         RNA_def_property_ui_text(prop, "Angle", "Defines brush texture rotation");
76         RNA_def_property_update(prop, 0, "rna_TextureSlot_update");
77
78         prop= RNA_def_property(srna, "map_mode", PROP_ENUM, PROP_NONE);
79         RNA_def_property_enum_sdna(prop, NULL, "brush_map_mode");
80         RNA_def_property_enum_items(prop, prop_map_mode_items);
81         RNA_def_property_ui_text(prop, "Mode", "");
82         RNA_def_property_update(prop, 0, "rna_TextureSlot_update");
83 }
84
85 static void rna_def_brush(BlenderRNA *brna)
86 {
87         StructRNA *srna;
88         PropertyRNA *prop;
89         
90         static EnumPropertyItem prop_blend_items[] = {
91                 {IMB_BLEND_MIX, "MIX", 0, "Mix", "Use mix blending mode while painting."},
92                 {IMB_BLEND_ADD, "ADD", 0, "Add", "Use add blending mode while painting."},
93                 {IMB_BLEND_SUB, "SUB", 0, "Subtract", "Use subtract blending mode while painting."},
94                 {IMB_BLEND_MUL, "MUL", 0, "Multiply", "Use multiply blending mode while painting."},
95                 {IMB_BLEND_LIGHTEN, "LIGHTEN", 0, "Lighten", "Use lighten blending mode while painting."},
96                 {IMB_BLEND_DARKEN, "DARKEN", 0, "Darken", "Use darken blending mode while painting."},
97                 {IMB_BLEND_ERASE_ALPHA, "ERASE_ALPHA", 0, "Erase Alpha", "Erase alpha while painting."},
98                 {IMB_BLEND_ADD_ALPHA, "ADD_ALPHA", 0, "Add Alpha", "Add alpha while painting."},
99                 {0, NULL, 0, NULL, NULL}};
100         
101         static EnumPropertyItem brush_sculpt_tool_items[] = {
102                 {SCULPT_TOOL_DRAW, "DRAW", 0, "Draw", ""},
103                 {SCULPT_TOOL_SMOOTH, "SMOOTH", 0, "Smooth", ""},
104                 {SCULPT_TOOL_PINCH, "PINCH", 0, "Pinch", ""},
105                 {SCULPT_TOOL_INFLATE, "INFLATE", 0, "Inflate", ""},
106                 {SCULPT_TOOL_GRAB, "GRAB", 0, "Grab", ""},
107                 {SCULPT_TOOL_LAYER, "LAYER", 0, "Layer", ""},
108                 {SCULPT_TOOL_FLATTEN, "FLATTEN", 0, "Flatten", ""},
109                 {SCULPT_TOOL_CLAY, "CLAY", 0, "Clay", ""},
110                 {0, NULL, 0, NULL, NULL}};
111         
112         static EnumPropertyItem brush_vertexpaint_tool_items[] = {
113                 {0, "MIX", 0, "Mix", "Use mix blending mode while painting."},
114                 {1, "ADD", 0, "Add", "Use add blending mode while painting."},
115                 {2, "SUB", 0, "Subtract", "Use subtract blending mode while painting."},
116                 {3, "MUL", 0, "Multiply", "Use multiply blending mode while painting."},
117                 {4, "BLUR", 0, "Blur", "Blur the color with surrounding values"},
118                 {5, "LIGHTEN", 0, "Lighten", "Use lighten blending mode while painting."},
119                 {6, "DARKEN", 0, "Darken", "Use darken blending mode while painting."},
120                 {0, NULL, 0, NULL, NULL}};
121         
122         static EnumPropertyItem brush_imagepaint_tool_items[] = {
123                 {PAINT_TOOL_DRAW, "DRAW", 0, "Draw", ""},
124                 {PAINT_TOOL_SOFTEN, "SOFTEN", 0, "Soften", ""},
125                 {PAINT_TOOL_SMEAR, "SMEAR", 0, "Smear", ""},
126                 {PAINT_TOOL_CLONE, "CLONE", 0, "Clone", ""},
127                 {0, NULL, 0, NULL, NULL}};
128         
129         static const EnumPropertyItem prop_flip_direction_items[]= {
130                 {0, "ADD", 0, "Add", "Add effect of brush"},
131                 {BRUSH_DIR_IN, "SUBTRACT", 0, "Subtract", "Subtract effect of brush"},
132                 {0, NULL, 0, NULL, NULL}};
133                 
134         srna= RNA_def_struct(brna, "Brush", "ID");
135         RNA_def_struct_ui_text(srna, "Brush", "Brush datablock for storing brush settings for painting and sculpting");
136         RNA_def_struct_ui_icon(srna, ICON_BRUSH_DATA);
137         
138         /* enums */
139         prop= RNA_def_property(srna, "blend", PROP_ENUM, PROP_NONE);
140         RNA_def_property_enum_items(prop, prop_blend_items);
141         RNA_def_property_ui_text(prop, "Blending mode", "Brush blending mode");
142         RNA_def_property_update(prop, 0, "rna_Brush_update");
143
144         prop= RNA_def_property(srna, "sculpt_tool", PROP_ENUM, PROP_NONE);
145         RNA_def_property_enum_items(prop, brush_sculpt_tool_items);
146         RNA_def_property_ui_text(prop, "Sculpt Tool", "");
147         RNA_def_property_update(prop, 0, "rna_Brush_update");
148         
149         prop= RNA_def_property(srna, "vertexpaint_tool", PROP_ENUM, PROP_NONE);
150         RNA_def_property_enum_items(prop, brush_vertexpaint_tool_items);
151         RNA_def_property_ui_text(prop, "Vertex/Weight Paint Tool", "");
152         RNA_def_property_update(prop, 0, "rna_Brush_update");
153         
154         prop= RNA_def_property(srna, "imagepaint_tool", PROP_ENUM, PROP_NONE);
155         RNA_def_property_enum_items(prop, brush_imagepaint_tool_items);
156         RNA_def_property_ui_text(prop, "Image Paint Tool", "");
157         RNA_def_property_update(prop, NC_SPACE|ND_SPACE_IMAGE, "rna_Brush_update");
158
159         prop= RNA_def_property(srna, "direction", PROP_ENUM, PROP_NONE);
160         RNA_def_property_enum_bitflag_sdna(prop, NULL, "flag");
161         RNA_def_property_enum_items(prop, prop_flip_direction_items);
162         RNA_def_property_ui_text(prop, "Direction", "Mapping type to use for this image in the game engine");
163         RNA_def_property_update(prop, 0, "rna_Brush_update");
164         
165         /* number values */
166         prop= RNA_def_property(srna, "size", PROP_INT, PROP_NONE);
167         RNA_def_property_range(prop, 1, 200);
168         RNA_def_property_ui_text(prop, "Size", "Diameter of the brush");
169         RNA_def_property_update(prop, 0, "rna_Brush_update");
170         
171         prop= RNA_def_property(srna, "jitter", PROP_FLOAT, PROP_NONE);
172         RNA_def_property_float_sdna(prop, NULL, "jitter");
173         RNA_def_property_range(prop, 0.0f, 1.0f);
174         RNA_def_property_ui_text(prop, "Jitter", "Jitter the position of the brush while painting");
175         RNA_def_property_update(prop, 0, "rna_Brush_update");
176
177         prop= RNA_def_property(srna, "spacing", PROP_FLOAT, PROP_NONE);
178         RNA_def_property_float_sdna(prop, NULL, "spacing");
179         RNA_def_property_range(prop, 1.0f, 100.0f);
180         RNA_def_property_ui_text(prop, "Spacing", "Spacing between brush stamps");
181         RNA_def_property_update(prop, 0, "rna_Brush_update");
182
183         prop= RNA_def_property(srna, "smooth_stroke_radius", PROP_INT, PROP_NONE);
184         RNA_def_property_range(prop, 10, 200);
185         RNA_def_property_ui_text(prop, "Smooth Stroke Radius", "Minimum distance from last point before stroke continues");
186         RNA_def_property_update(prop, 0, "rna_Brush_update");
187
188         prop= RNA_def_property(srna, "smooth_stroke_factor", PROP_FLOAT, PROP_NONE);
189         RNA_def_property_range(prop, 0.5, 0.99);
190         RNA_def_property_ui_text(prop, "Smooth Stroke Factor", "Higher values give a smoother stroke");
191         RNA_def_property_update(prop, 0, "rna_Brush_update");
192         
193         prop= RNA_def_property(srna, "rate", PROP_FLOAT, PROP_NONE);
194         RNA_def_property_float_sdna(prop, NULL, "rate");
195         RNA_def_property_range(prop, 0.010f, 1.0f);
196         RNA_def_property_ui_text(prop, "Rate", "Number of paints per second for Airbrush");
197         RNA_def_property_update(prop, 0, "rna_Brush_update");
198         
199         prop= RNA_def_property(srna, "color", PROP_FLOAT, PROP_COLOR_GAMMA);
200         RNA_def_property_range(prop, 0.0, 1.0);
201         RNA_def_property_float_sdna(prop, NULL, "rgb");
202         RNA_def_property_ui_text(prop, "Color", "");
203         RNA_def_property_update(prop, 0, "rna_Brush_update");
204         
205         prop= RNA_def_property(srna, "strength", PROP_FLOAT, PROP_NONE);
206         RNA_def_property_float_sdna(prop, NULL, "alpha");
207         RNA_def_property_range(prop, 0.0f, 1.0f);
208         RNA_def_property_ui_text(prop, "Strength", "The amount of pressure on the brush");
209         RNA_def_property_update(prop, 0, "rna_Brush_update");
210
211         /* flag */
212         prop= RNA_def_property(srna, "use_airbrush", PROP_BOOLEAN, PROP_NONE);
213         RNA_def_property_boolean_sdna(prop, NULL, "flag", BRUSH_AIRBRUSH);
214         RNA_def_property_ui_text(prop, "Airbrush", "Keep applying paint effect while holding mouse (spray)");
215         RNA_def_property_update(prop, 0, "rna_Brush_update");
216         
217         prop= RNA_def_property(srna, "use_wrap", PROP_BOOLEAN, PROP_NONE);
218         RNA_def_property_boolean_sdna(prop, NULL, "flag", BRUSH_TORUS);
219         RNA_def_property_ui_text(prop, "Wrap", "Enable torus wrapping while painting");
220         RNA_def_property_update(prop, 0, "rna_Brush_update");
221         
222         prop= RNA_def_property(srna, "use_strength_pressure", PROP_BOOLEAN, PROP_NONE);
223         RNA_def_property_boolean_sdna(prop, NULL, "flag", BRUSH_ALPHA_PRESSURE);
224         RNA_def_property_ui_icon(prop, ICON_STYLUS_PRESSURE, 0);
225         RNA_def_property_ui_text(prop, "Strength Pressure", "Enable tablet pressure sensitivity for strength");
226         RNA_def_property_update(prop, 0, "rna_Brush_update");
227         
228         prop= RNA_def_property(srna, "use_size_pressure", PROP_BOOLEAN, PROP_NONE);
229         RNA_def_property_boolean_sdna(prop, NULL, "flag", BRUSH_SIZE_PRESSURE);
230         RNA_def_property_ui_icon(prop, ICON_STYLUS_PRESSURE, 0);
231         RNA_def_property_ui_text(prop, "Size Pressure", "Enable tablet pressure sensitivity for size");
232         RNA_def_property_update(prop, 0, "rna_Brush_update");
233         
234         prop= RNA_def_property(srna, "use_jitter_pressure", PROP_BOOLEAN, PROP_NONE);
235         RNA_def_property_boolean_sdna(prop, NULL, "flag", BRUSH_JITTER_PRESSURE);
236         RNA_def_property_ui_icon(prop, ICON_STYLUS_PRESSURE, 0);
237         RNA_def_property_ui_text(prop, "Jitter Pressure", "Enable tablet pressure sensitivity for jitter");
238         RNA_def_property_update(prop, 0, "rna_Brush_update");
239
240         prop= RNA_def_property(srna, "use_spacing_pressure", PROP_BOOLEAN, PROP_NONE);
241         RNA_def_property_boolean_sdna(prop, NULL, "flag", BRUSH_SPACING_PRESSURE);
242         RNA_def_property_ui_icon(prop, ICON_STYLUS_PRESSURE, 0);
243         RNA_def_property_ui_text(prop, "Spacing Pressure", "Enable tablet pressure sensitivity for spacing");
244         RNA_def_property_update(prop, 0, "rna_Brush_update");
245
246         prop= RNA_def_property(srna, "use_rake", PROP_BOOLEAN, PROP_NONE);
247         RNA_def_property_boolean_sdna(prop, NULL, "flag", BRUSH_RAKE);
248         RNA_def_property_ui_text(prop, "Rake", "Rotate the brush texture to match the stroke direction");
249         RNA_def_property_update(prop, 0, "rna_Brush_update");
250
251         prop= RNA_def_property(srna, "use_anchor", PROP_BOOLEAN, PROP_NONE);
252         RNA_def_property_boolean_sdna(prop, NULL, "flag", BRUSH_ANCHORED);
253         RNA_def_property_ui_text(prop, "Anchored", "Keep the brush anchored to the initial location");
254         RNA_def_property_update(prop, 0, "rna_Brush_update");
255
256         prop= RNA_def_property(srna, "use_space", PROP_BOOLEAN, PROP_NONE);
257         RNA_def_property_boolean_sdna(prop, NULL, "flag", BRUSH_SPACE);
258         RNA_def_property_ui_text(prop, "Space", "Limit brush application to the distance specified by spacing");
259         RNA_def_property_update(prop, 0, "rna_Brush_update");
260
261         prop= RNA_def_property(srna, "use_smooth_stroke", PROP_BOOLEAN, PROP_NONE);
262         RNA_def_property_boolean_sdna(prop, NULL, "flag", BRUSH_SMOOTH_STROKE);
263         RNA_def_property_ui_text(prop, "Smooth Stroke", "Brush lags behind mouse and follows a smoother path");
264         RNA_def_property_update(prop, 0, "rna_Brush_update");
265
266         prop= RNA_def_property(srna, "use_persistent", PROP_BOOLEAN, PROP_NONE);
267         RNA_def_property_boolean_sdna(prop, NULL, "flag", BRUSH_PERSISTENT);
268         RNA_def_property_ui_text(prop, "Persistent", "Sculpts on a persistent layer of the mesh");
269         RNA_def_property_update(prop, 0, "rna_Brush_update");
270
271         prop= RNA_def_property(srna, "use_accumulate", PROP_BOOLEAN, PROP_NONE);
272         RNA_def_property_boolean_sdna(prop, NULL, "flag", BRUSH_ACCUMULATE);
273         RNA_def_property_ui_text(prop, "Accumulate", "Accumulate stroke dabs on top of each other");
274         RNA_def_property_update(prop, 0, "rna_Brush_update");
275         
276         /* not exposed in the interface yet
277         prop= RNA_def_property(srna, "fixed_tex", PROP_BOOLEAN, PROP_NONE);
278         RNA_def_property_boolean_sdna(prop, NULL, "flag", BRUSH_FIXED_TEX);
279         RNA_def_property_ui_text(prop, "Fixed Texture", "Keep texture origin in fixed position");
280         RNA_def_property_update(prop, 0, "rna_Brush_update"); */
281
282         prop= RNA_def_property(srna, "curve", PROP_POINTER, PROP_NONE);
283         RNA_def_property_flag(prop, PROP_NEVER_NULL);
284         RNA_def_property_ui_text(prop, "Curve", "Editable falloff curve");
285         RNA_def_property_update(prop, 0, "rna_Brush_update");
286
287         /* texture */
288         prop= RNA_def_property(srna, "texture_slot", PROP_POINTER, PROP_NONE);
289         RNA_def_property_struct_type(prop, "BrushTextureSlot");
290         RNA_def_property_pointer_sdna(prop, NULL, "mtex");
291         RNA_def_property_clear_flag(prop, PROP_EDITABLE);
292         RNA_def_property_ui_text(prop, "Texture Slot", "");
293         
294         prop= RNA_def_property(srna, "texture", PROP_POINTER, PROP_NONE);
295         RNA_def_property_pointer_sdna(prop, NULL, "mtex.tex");
296         RNA_def_property_flag(prop, PROP_EDITABLE);
297         RNA_def_property_ui_text(prop, "Texture", "");
298         RNA_def_property_update(prop, NC_TEXTURE, "rna_Brush_update");
299
300         /* clone tool */
301         prop= RNA_def_property(srna, "clone_image", PROP_POINTER, PROP_NONE);
302         RNA_def_property_pointer_sdna(prop, NULL, "clone.image");
303         RNA_def_property_flag(prop, PROP_EDITABLE);
304         RNA_def_property_ui_text(prop, "Clone Image", "Image for clone tool");
305         RNA_def_property_update(prop, NC_SPACE|ND_SPACE_IMAGE, "rna_Brush_update");
306         
307         prop= RNA_def_property(srna, "clone_alpha", PROP_FLOAT, PROP_NONE);
308         RNA_def_property_float_sdna(prop, NULL, "clone.alpha");
309         RNA_def_property_range(prop, 0.0f, 1.0f);
310         RNA_def_property_ui_text(prop, "Clone Alpha", "Opacity of clone image display");
311         RNA_def_property_update(prop, NC_SPACE|ND_SPACE_IMAGE, "rna_Brush_update");
312
313         prop= RNA_def_property(srna, "clone_offset", PROP_FLOAT, PROP_XYZ);
314         RNA_def_property_float_sdna(prop, NULL, "clone.offset");
315         RNA_def_property_ui_text(prop, "Clone Offset", "");
316         RNA_def_property_ui_range(prop, -1.0f , 1.0f, 10.0f, 3);
317         RNA_def_property_update(prop, NC_SPACE|ND_SPACE_IMAGE, "rna_Brush_update");
318 }
319
320
321 /* A brush stroke is a list of changes to the brush that
322  * can occur during a stroke
323  *
324  *  o 3D location of the brush
325  *  o 2D mouse location
326  *  o Tablet pressure
327  *  o Direction flip
328  *  o Tool switch
329  *  o Time
330  */
331 static void rna_def_operator_stroke_element(BlenderRNA *brna)
332 {
333         StructRNA *srna;
334         PropertyRNA *prop;
335
336         srna= RNA_def_struct(brna, "OperatorStrokeElement", "IDPropertyGroup");
337         RNA_def_struct_ui_text(srna, "Operator Stroke Element", "");
338
339         prop= RNA_def_property(srna, "location", PROP_FLOAT, PROP_XYZ);
340         RNA_def_property_flag(prop, PROP_IDPROPERTY);
341         RNA_def_property_array(prop, 3);
342         RNA_def_property_ui_text(prop, "Location", "");
343
344         prop= RNA_def_property(srna, "mouse", PROP_FLOAT, PROP_XYZ);
345         RNA_def_property_flag(prop, PROP_IDPROPERTY);
346         RNA_def_property_array(prop, 2);
347         RNA_def_property_ui_text(prop, "Mouse", "");
348
349         prop= RNA_def_property(srna, "pressure", PROP_FLOAT, PROP_NONE);
350         RNA_def_property_flag(prop, PROP_IDPROPERTY);
351         RNA_def_property_range(prop, 0.0f, 1.0f);
352         RNA_def_property_ui_text(prop, "Pressure", "Tablet pressure");
353
354         prop= RNA_def_property(srna, "time", PROP_FLOAT, PROP_UNSIGNED);
355         RNA_def_property_flag(prop, PROP_IDPROPERTY);
356         RNA_def_property_ui_text(prop, "Time", "");
357
358         prop= RNA_def_property(srna, "flip", PROP_BOOLEAN, PROP_NONE);
359         RNA_def_property_flag(prop, PROP_IDPROPERTY);
360         RNA_def_property_ui_text(prop, "Flip", "");
361
362         /* XXX: Tool (this will be for pressing a modifier key for a different brush,
363                 e.g. switching to a Smooth brush in the middle of the stroke */
364 }
365
366 void RNA_def_brush(BlenderRNA *brna)
367 {
368         rna_def_brush(brna);
369         rna_def_brush_texture_slot(brna);
370         rna_def_operator_stroke_element(brna);
371 }
372
373 #endif