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