612863e1ab9c78862e03fcf28c5521bf84724cd8
[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 "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 static void rna_Brush_mtex_begin(CollectionPropertyIterator *iter, PointerRNA *ptr)
55 {
56         Brush *brush= (Brush*)ptr->data;
57         rna_iterator_array_begin(iter, (void*)brush->mtex, sizeof(MTex*), MAX_MTEX, 0, NULL);
58 }
59
60 static PointerRNA rna_Brush_active_texture_get(PointerRNA *ptr)
61 {
62         Brush *br= (Brush*)ptr->data;
63         Tex *tex;
64
65         tex= (br->mtex[(int)br->texact])? br->mtex[(int)br->texact]->tex: NULL;
66         return rna_pointer_inherit_refine(ptr, &RNA_Texture, tex);
67 }
68
69 static void rna_Brush_active_texture_set(PointerRNA *ptr, PointerRNA value)
70 {
71         Brush *br= (Brush*)ptr->data;
72         int act= br->texact;
73
74         if(br->mtex[act] && br->mtex[act]->tex)
75                 id_us_min(&br->mtex[act]->tex->id);
76
77         if(value.data) {
78                 if(!br->mtex[act])
79                         br->mtex[act]= add_mtex();
80                 
81                 br->mtex[act]->tex= value.data;
82                 id_us_plus(&br->mtex[act]->tex->id);
83         }
84         else if(br->mtex[act]) {
85                 MEM_freeN(br->mtex[act]);
86                 br->mtex[act]= NULL;
87         }
88 }
89
90 #else
91
92 void rna_def_brush(BlenderRNA *brna)
93 {
94         StructRNA *srna;
95         PropertyRNA *prop;
96         
97         static EnumPropertyItem prop_blend_items[] = {
98                 {IMB_BLEND_MIX, "MIX", 0, "Mix", "Use mix blending mode while painting."},
99                 {IMB_BLEND_ADD, "ADD", 0, "Add", "Use add blending mode while painting."},
100                 {IMB_BLEND_SUB, "SUB", 0, "Subtract", "Use subtract blending mode while painting."},
101                 {IMB_BLEND_MUL, "MUL", 0, "Multiply", "Use multiply blending mode while painting."},
102                 {IMB_BLEND_LIGHTEN, "LIGHTEN", 0, "Lighten", "Use lighten blending mode while painting."},
103                 {IMB_BLEND_DARKEN, "DARKEN", 0, "Darken", "Use darken blending mode while painting."},
104                 {IMB_BLEND_ERASE_ALPHA, "ERASE_ALPHA", 0, "Erase Alpha", "Erase alpha while painting."},
105                 {IMB_BLEND_ADD_ALPHA, "ADD_ALPHA", 0, "Add Alpha", "Add alpha while painting."},
106                 {0, NULL, 0, NULL, NULL}};
107         
108         static const EnumPropertyItem prop_flip_direction_items[]= {
109                 {0, "ADD", 0, "Add", "Add effect of brush"},
110                 {BRUSH_DIR_IN, "SUBTRACT", 0, "Subtract", "Subtract effect of brush"},
111                 {0, NULL, 0, NULL, NULL}};
112                 
113         srna= RNA_def_struct(brna, "Brush", "ID");
114         RNA_def_struct_ui_text(srna, "Brush", "Brush datablock for storing brush settings for painting and sculpting.");
115         RNA_def_struct_ui_icon(srna, ICON_BRUSH_DATA);
116         
117         /* enums */
118         prop= RNA_def_property(srna, "blend", PROP_ENUM, PROP_NONE);
119         RNA_def_property_enum_items(prop, prop_blend_items);
120         RNA_def_property_ui_text(prop, "Blending mode", "Brush blending mode.");
121
122         prop= RNA_def_property(srna, "sculpt_tool", PROP_ENUM, PROP_NONE);
123         RNA_def_property_enum_items(prop, brush_sculpt_tool_items);
124         RNA_def_property_ui_text(prop, "Sculpt Tool", "");
125
126         prop= RNA_def_property(srna, "direction", PROP_ENUM, PROP_NONE);
127         RNA_def_property_enum_bitflag_sdna(prop, NULL, "flag");
128         RNA_def_property_enum_items(prop, prop_flip_direction_items);
129         RNA_def_property_ui_text(prop, "Direction", "Mapping type to use for this image in the game engine.");
130         
131         /* number values */
132         prop= RNA_def_property(srna, "size", PROP_INT, PROP_NONE);
133         RNA_def_property_range(prop, 1, 200);
134         RNA_def_property_ui_text(prop, "Size", "Diameter of the brush.");
135         
136         prop= RNA_def_property(srna, "falloff", PROP_FLOAT, PROP_NONE);
137         RNA_def_property_float_sdna(prop, NULL, "innerradius");
138         RNA_def_property_range(prop, 0.0f, 1.0f);
139         RNA_def_property_ui_text(prop, "Falloff", "Falloff radius of the brush.");
140         
141         prop= RNA_def_property(srna, "spacing", PROP_FLOAT, PROP_NONE);
142         RNA_def_property_float_sdna(prop, NULL, "spacing");
143         RNA_def_property_range(prop, 1.0f, 100.0f);
144         RNA_def_property_ui_text(prop, "Spacing", "Spacing between brush stamps.");
145
146         prop= RNA_def_property(srna, "smooth_stroke_radius", PROP_INT, PROP_NONE);
147         RNA_def_property_range(prop, 10, 200);
148         RNA_def_property_ui_text(prop, "Smooth Stroke Radius", "Minimum distance from last point before stroke continues.");
149
150         prop= RNA_def_property(srna, "smooth_stroke_factor", PROP_FLOAT, PROP_NONE);
151         RNA_def_property_range(prop, 0.5, 0.99);
152         RNA_def_property_ui_text(prop, "Smooth Stroke Factor", "Higher values give a smoother stroke.");
153         
154         prop= RNA_def_property(srna, "rate", PROP_FLOAT, PROP_NONE);
155         RNA_def_property_float_sdna(prop, NULL, "rate");
156         RNA_def_property_range(prop, 0.010f, 1.0f);
157         RNA_def_property_ui_text(prop, "Rate", "Number of paints per second for Airbrush.");
158         
159         prop= RNA_def_property(srna, "color", PROP_FLOAT, PROP_COLOR);
160         RNA_def_property_float_sdna(prop, NULL, "rgb");
161         RNA_def_property_ui_text(prop, "Color", "");
162         
163         prop= RNA_def_property(srna, "strength", PROP_FLOAT, PROP_NONE);
164         RNA_def_property_float_sdna(prop, NULL, "alpha");
165         RNA_def_property_range(prop, 0.0f, 1.0f);
166         RNA_def_property_ui_text(prop, "Strength", "The amount of pressure on the brush.");
167
168         /* flag */
169         prop= RNA_def_property(srna, "airbrush", PROP_BOOLEAN, PROP_NONE);
170         RNA_def_property_boolean_sdna(prop, NULL, "flag", BRUSH_AIRBRUSH);
171         RNA_def_property_ui_text(prop, "Airbrush", "Keep applying paint effect while holding mouse (spray).");
172         
173         prop= RNA_def_property(srna, "wrap", PROP_BOOLEAN, PROP_NONE);
174         RNA_def_property_boolean_sdna(prop, NULL, "flag", BRUSH_TORUS);
175         RNA_def_property_ui_text(prop, "Wrap", "Enable torus wrapping while painting.");
176         
177         prop= RNA_def_property(srna, "strength_pressure", PROP_BOOLEAN, PROP_NONE);
178         RNA_def_property_boolean_sdna(prop, NULL, "flag", BRUSH_ALPHA_PRESSURE);
179         RNA_def_property_ui_icon(prop, ICON_STYLUS_PRESSURE, 0);
180         RNA_def_property_ui_text(prop, "Strength Pressure", "Enable tablet pressure sensitivity for strength.");
181         
182         prop= RNA_def_property(srna, "size_pressure", PROP_BOOLEAN, PROP_NONE);
183         RNA_def_property_boolean_sdna(prop, NULL, "flag", BRUSH_SIZE_PRESSURE);
184         RNA_def_property_ui_icon(prop, ICON_STYLUS_PRESSURE, 0);
185         RNA_def_property_ui_text(prop, "Size Pressure", "Enable tablet pressure sensitivity for size.");
186         
187         prop= RNA_def_property(srna, "falloff_pressure", PROP_BOOLEAN, PROP_NONE);
188         RNA_def_property_boolean_sdna(prop, NULL, "flag", BRUSH_RAD_PRESSURE);
189         RNA_def_property_ui_icon(prop, ICON_STYLUS_PRESSURE, 0);
190         RNA_def_property_ui_text(prop, "Falloff Pressure", "Enable tablet pressure sensitivity for falloff.");
191         
192         prop= RNA_def_property(srna, "spacing_pressure", PROP_BOOLEAN, PROP_NONE);
193         RNA_def_property_boolean_sdna(prop, NULL, "flag", BRUSH_SPACING_PRESSURE);
194         RNA_def_property_ui_icon(prop, ICON_STYLUS_PRESSURE, 0);
195         RNA_def_property_ui_text(prop, "Spacing Pressure", "Enable tablet pressure sensitivity for spacing.");
196
197         prop= RNA_def_property(srna, "rake", PROP_BOOLEAN, PROP_NONE);
198         RNA_def_property_boolean_sdna(prop, NULL, "flag", BRUSH_RAKE);
199         RNA_def_property_ui_text(prop, "Rake", "Rotate the brush texture to match the stroke direction.");
200
201         prop= RNA_def_property(srna, "anchored", PROP_BOOLEAN, PROP_NONE);
202         RNA_def_property_boolean_sdna(prop, NULL, "flag", BRUSH_ANCHORED);
203         RNA_def_property_ui_text(prop, "Anchored", "Keep the brush anchored to the initial location.");
204
205         prop= RNA_def_property(srna, "space", PROP_BOOLEAN, PROP_NONE);
206         RNA_def_property_boolean_sdna(prop, NULL, "flag", BRUSH_SPACE);
207         RNA_def_property_ui_text(prop, "Space", "Limit brush application to the distance specified by spacing.");
208
209         prop= RNA_def_property(srna, "smooth_stroke", PROP_BOOLEAN, PROP_NONE);
210         RNA_def_property_boolean_sdna(prop, NULL, "flag", BRUSH_SMOOTH_STROKE);
211         RNA_def_property_ui_text(prop, "Smooth Stroke", "Brush lags behind mouse and follows a smoother path.");
212
213         prop= RNA_def_property(srna, "persistent", PROP_BOOLEAN, PROP_NONE);
214         RNA_def_property_boolean_sdna(prop, NULL, "flag", BRUSH_PERSISTENT);
215         RNA_def_property_ui_text(prop, "Persistent", "Sculpts on a persistent layer of the mesh.");
216         
217         /* not exposed in the interface yet
218         prop= RNA_def_property(srna, "fixed_tex", PROP_BOOLEAN, PROP_NONE);
219         RNA_def_property_boolean_sdna(prop, NULL, "flag", BRUSH_FIXED_TEX);
220         RNA_def_property_ui_text(prop, "Fixed Texture", "Keep texture origin in fixed position.");*/
221
222         prop= RNA_def_property(srna, "curve", PROP_POINTER, PROP_NEVER_NULL);
223         RNA_def_property_ui_text(prop, "Curve", "Editable falloff curve.");
224
225         /* texture */
226         rna_def_mtex_common(srna, "rna_Brush_mtex_begin", "rna_Brush_active_texture_get",
227                 "rna_Brush_active_texture_set", "TextureSlot");
228
229         /* clone tool */
230         prop= RNA_def_property(srna, "clone_image", PROP_POINTER, PROP_NONE);
231         RNA_def_property_pointer_sdna(prop, NULL, "clone.image");
232         RNA_def_property_flag(prop, PROP_EDITABLE);
233         RNA_def_property_ui_text(prop, "Clone Image", "Image for clone tool.");
234         
235         prop= RNA_def_property(srna, "clone_opacity", PROP_FLOAT, PROP_NONE);
236         RNA_def_property_float_sdna(prop, NULL, "clone.alpha");
237         RNA_def_property_range(prop, 0.0f, 1.0f);
238         RNA_def_property_ui_text(prop, "Clone Opacity", "Opacity of clone image display.");
239
240         prop= RNA_def_property(srna, "clone_offset", PROP_FLOAT, PROP_XYZ);
241         RNA_def_property_float_sdna(prop, NULL, "clone.offset");
242         RNA_def_property_ui_text(prop, "Clone Offset", "");
243         RNA_def_property_ui_range(prop, -1.0f , 1.0f, 10.0f, 3);
244 }
245
246
247 /* A brush stroke is a list of changes to the brush that
248  * can occur during a stroke
249  *
250  *  o 3D location of the brush
251  *  o 2D mouse location
252  *  o Tablet pressure
253  *  o Direction flip
254  *  o Tool switch
255  *  o Time
256  */
257 static void rna_def_operator_stroke_element(BlenderRNA *brna)
258 {
259         StructRNA *srna;
260         PropertyRNA *prop;
261
262         srna= RNA_def_struct(brna, "OperatorStrokeElement", "IDPropertyGroup");
263         RNA_def_struct_ui_text(srna, "Operator Stroke Element", "");
264
265         prop= RNA_def_property(srna, "location", PROP_FLOAT, PROP_XYZ);
266         RNA_def_property_flag(prop, PROP_IDPROPERTY);
267         RNA_def_property_array(prop, 3);
268         RNA_def_property_ui_text(prop, "Location", "");
269
270         prop= RNA_def_property(srna, "mouse", PROP_FLOAT, PROP_XYZ);
271         RNA_def_property_flag(prop, PROP_IDPROPERTY);
272         RNA_def_property_array(prop, 2);
273         RNA_def_property_ui_text(prop, "Mouse", "");
274
275         prop= RNA_def_property(srna, "pressure", PROP_FLOAT, PROP_NONE);
276         RNA_def_property_flag(prop, PROP_IDPROPERTY);
277         RNA_def_property_range(prop, 0.0f, 1.0f);
278         RNA_def_property_ui_text(prop, "Pressure", "Tablet pressure.");
279
280         prop= RNA_def_property(srna, "time", PROP_FLOAT, PROP_UNSIGNED);
281         RNA_def_property_flag(prop, PROP_IDPROPERTY);
282         RNA_def_property_ui_text(prop, "Time", "");
283
284         prop= RNA_def_property(srna, "flip", PROP_BOOLEAN, PROP_NONE);
285         RNA_def_property_flag(prop, PROP_IDPROPERTY);
286         RNA_def_property_ui_text(prop, "Flip", "");
287
288         /* XXX: Tool (this will be for pressing a modifier key for a different brush,
289                 e.g. switching to a Smooth brush in the middle of the stroke */
290 }
291
292 void RNA_def_brush(BlenderRNA *brna)
293 {
294         rna_def_brush(brna);
295         rna_def_operator_stroke_element(brna);
296 }
297
298 #endif