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