* First commit merging 2.4-based sim_physics in to volume25 branch.
[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 #ifdef RNA_RUNTIME
36
37 #include "MEM_guardedalloc.h"
38
39 #include "BKE_texture.h"
40
41 static void rna_Brush_mtex_begin(CollectionPropertyIterator *iter, PointerRNA *ptr)
42 {
43         Brush *brush= (Brush*)ptr->data;
44         rna_iterator_array_begin(iter, (void*)brush->mtex, sizeof(MTex*), MAX_MTEX, 0, NULL);
45 }
46
47 static PointerRNA rna_Brush_active_texture_get(PointerRNA *ptr)
48 {
49         Brush *br= (Brush*)ptr->data;
50         Tex *tex;
51
52         tex= (br->mtex[(int)br->texact])? br->mtex[(int)br->texact]->tex: NULL;
53         return rna_pointer_inherit_refine(ptr, &RNA_Texture, tex);
54 }
55
56 static void rna_Brush_active_texture_set(PointerRNA *ptr, PointerRNA value)
57 {
58         Brush *br= (Brush*)ptr->data;
59         int act= br->texact;
60
61         if(br->mtex[act] && br->mtex[act]->tex)
62                 id_us_min(&br->mtex[act]->tex->id);
63
64         if(value.data) {
65                 if(!br->mtex[act])
66                         br->mtex[act]= add_mtex();
67                 
68                 br->mtex[act]->tex= value.data;
69                 id_us_plus(&br->mtex[act]->tex->id);
70         }
71         else if(br->mtex[act]) {
72                 MEM_freeN(br->mtex[act]);
73                 br->mtex[act]= NULL;
74         }
75 }
76
77 static float rna_Brush_rotation_get(PointerRNA *ptr)
78 {
79         Brush *brush= (Brush*)ptr->data;
80         const float conv = 57.295779506;
81         return brush->rot * conv;
82 }
83
84 static void rna_Brush_rotation_set(PointerRNA *ptr, float v)
85 {
86         Brush *brush= (Brush*)ptr->data;
87         const float conv = 0.017453293;
88         brush->rot = v * conv;
89 }
90
91 #else
92
93 void rna_def_brush(BlenderRNA *brna)
94 {
95         StructRNA *srna;
96         PropertyRNA *prop;
97         
98         static EnumPropertyItem prop_blend_items[] = {
99                 {BRUSH_BLEND_MIX, "MIX", 0, "Mix", "Use mix blending mode while painting."},
100                 {BRUSH_BLEND_ADD, "ADD", 0, "Add", "Use add blending mode while painting."},
101                 {BRUSH_BLEND_SUB, "SUB", 0, "Subtract", "Use subtract blending mode while painting."},
102                 {BRUSH_BLEND_MUL, "MUL", 0, "Multiply", "Use multiply blending mode while painting."},
103                 {BRUSH_BLEND_LIGHTEN, "LIGHTEN", 0, "Lighten", "Use lighten blending mode while painting."},
104                 {BRUSH_BLEND_DARKEN, "DARKEN", 0, "Darken", "Use darken blending mode while painting."},
105                 {BRUSH_BLEND_ERASE_ALPHA, "ERASE_ALPHA", 0, "Erase Alpha", "Erase alpha while painting."},
106                 {BRUSH_BLEND_ADD_ALPHA, "ADD_ALPHA", 0, "Add Alpha", "Add alpha while painting."},
107                 {0, NULL, 0, NULL, NULL}};
108                 
109         static EnumPropertyItem prop_texture_mode_items[] = {
110                 {BRUSH_TEX_DRAG, "TEX_DRAG", 0, "Drag", ""},
111                 {BRUSH_TEX_TILE, "TEX_TILE", 0, "Tile", ""},
112                 {BRUSH_TEX_3D, "TEX_3D", 0, "3D", ""},
113                 {0, NULL, 0, NULL, NULL}};
114                 
115         static EnumPropertyItem prop_sculpt_tool_items[] = {
116                 {SCULPT_TOOL_DRAW, "DRAW", 0, "Draw", ""},
117                 {SCULPT_TOOL_SMOOTH, "SMOOTH", 0, "Smooth", ""},
118                 {SCULPT_TOOL_PINCH, "PINCH", 0, "Pinch", ""},
119                 {SCULPT_TOOL_INFLATE, "INFLATE", 0, "Inflate", ""},
120                 {SCULPT_TOOL_GRAB, "GRAB", 0, "Grab", ""},
121                 {SCULPT_TOOL_LAYER, "LAYER", 0, "Layer", ""},
122                 {SCULPT_TOOL_FLATTEN, "FLATTEN", 0, "Flatten", ""},
123                 {SCULPT_TOOL_CLAY, "CLAY", 0, "Clay", ""},
124                 {0, NULL, 0, NULL, NULL}};
125         
126         srna= RNA_def_struct(brna, "Brush", "ID");
127         RNA_def_struct_ui_text(srna, "Brush", "Brush datablock for storing brush settings for painting and sculpting.");
128         RNA_def_struct_ui_icon(srna, ICON_BRUSH_DATA);
129         
130         /* enums */
131         prop= RNA_def_property(srna, "blend", PROP_ENUM, PROP_NONE);
132         RNA_def_property_enum_items(prop, prop_blend_items);
133         RNA_def_property_ui_text(prop, "Blending mode", "Brush blending mode.");
134
135         prop= RNA_def_property(srna, "texture_mode", PROP_ENUM, PROP_NONE);
136         RNA_def_property_enum_sdna(prop, NULL, "tex_mode");
137         RNA_def_property_enum_items(prop, prop_texture_mode_items);
138         RNA_def_property_ui_text(prop, "Texture Mode", "");
139
140         prop= RNA_def_property(srna, "sculpt_tool", PROP_ENUM, PROP_NONE);
141         RNA_def_property_enum_items(prop, prop_sculpt_tool_items);
142         RNA_def_property_ui_text(prop, "Sculpt Tool", "");
143         
144         /* number values */
145         prop= RNA_def_property(srna, "size", PROP_INT, PROP_NONE);
146         RNA_def_property_range(prop, 1, 200);
147         RNA_def_property_ui_text(prop, "Size", "Diameter of the brush.");
148         
149         prop= RNA_def_property(srna, "falloff", PROP_FLOAT, PROP_NONE);
150         RNA_def_property_float_sdna(prop, NULL, "innerradius");
151         RNA_def_property_range(prop, 0.0f, 1.0f);
152         RNA_def_property_ui_text(prop, "Falloff", "Falloff radius of the brush.");
153         
154         prop= RNA_def_property(srna, "spacing", PROP_FLOAT, PROP_NONE);
155         RNA_def_property_float_sdna(prop, NULL, "spacing");
156         RNA_def_property_range(prop, 1.0f, 100.0f);
157         RNA_def_property_ui_text(prop, "Spacing", "Spacing between brush stamps.");
158         
159         prop= RNA_def_property(srna, "rate", PROP_FLOAT, PROP_NONE);
160         RNA_def_property_float_sdna(prop, NULL, "rate");
161         RNA_def_property_range(prop, 0.010f, 1.0f);
162         RNA_def_property_ui_text(prop, "Rate", "Number of paints per second for Airbrush.");
163         
164         prop= RNA_def_property(srna, "color", PROP_FLOAT, PROP_COLOR);
165         RNA_def_property_float_sdna(prop, NULL, "rgb");
166         RNA_def_property_ui_text(prop, "Color", "");
167         
168         prop= RNA_def_property(srna, "strength", PROP_FLOAT, PROP_NONE);
169         RNA_def_property_float_sdna(prop, NULL, "alpha");
170         RNA_def_property_range(prop, 0.0f, 1.0f);
171         RNA_def_property_ui_text(prop, "Strength", "The amount of pressure on the brush.");
172
173         prop= RNA_def_property(srna, "rotation", PROP_FLOAT, PROP_NONE);
174         RNA_def_property_float_sdna(prop, NULL, "rot");
175         RNA_def_property_range(prop, 0, 360);
176         RNA_def_property_float_funcs(prop, "rna_Brush_rotation_get", "rna_Brush_rotation_set", NULL);
177         RNA_def_property_ui_text(prop, "Rotation", "Angle of the brush texture.");
178         
179         /* flag */
180         prop= RNA_def_property(srna, "airbrush", PROP_BOOLEAN, PROP_NONE);
181         RNA_def_property_boolean_sdna(prop, NULL, "flag", BRUSH_AIRBRUSH);
182         RNA_def_property_ui_text(prop, "Airbrush", "Keep applying paint effect while holding mouse (spray).");
183         
184         prop= RNA_def_property(srna, "wrap", PROP_BOOLEAN, PROP_NONE);
185         RNA_def_property_boolean_sdna(prop, NULL, "flag", BRUSH_TORUS);
186         RNA_def_property_ui_text(prop, "Wrap", "Enable torus wrapping while painting.");
187         
188         prop= RNA_def_property(srna, "strength_pressure", PROP_BOOLEAN, PROP_NONE);
189         RNA_def_property_boolean_sdna(prop, NULL, "flag", BRUSH_ALPHA_PRESSURE);
190         RNA_def_property_ui_text(prop, "Strength Pressure", "Enable tablet pressure sensitivity for strength.");
191         
192         prop= RNA_def_property(srna, "size_pressure", PROP_BOOLEAN, PROP_NONE);
193         RNA_def_property_boolean_sdna(prop, NULL, "flag", BRUSH_SIZE_PRESSURE);
194         RNA_def_property_ui_text(prop, "Size Pressure", "Enable tablet pressure sensitivity for size.");
195         
196         prop= RNA_def_property(srna, "falloff_pressure", PROP_BOOLEAN, PROP_NONE);
197         RNA_def_property_boolean_sdna(prop, NULL, "flag", BRUSH_RAD_PRESSURE);
198         RNA_def_property_ui_text(prop, "Falloff Pressure", "Enable tablet pressure sensitivity for falloff.");
199         
200         prop= RNA_def_property(srna, "spacing_pressure", PROP_BOOLEAN, PROP_NONE);
201         RNA_def_property_boolean_sdna(prop, NULL, "flag", BRUSH_SPACING_PRESSURE);
202         RNA_def_property_ui_text(prop, "Spacing Pressure", "Enable tablet pressure sensitivity for spacing.");
203
204         prop= RNA_def_property(srna, "rake", PROP_BOOLEAN, PROP_NONE);
205         RNA_def_property_boolean_sdna(prop, NULL, "flag", BRUSH_RAKE);
206         RNA_def_property_ui_text(prop, "Rake", "Rotate the brush texture to match the stroke direction.");
207
208         prop= RNA_def_property(srna, "anchored", PROP_BOOLEAN, PROP_NONE);
209         RNA_def_property_boolean_sdna(prop, NULL, "flag", BRUSH_ANCHORED);
210         RNA_def_property_ui_text(prop, "Anchored", "Keep the brush anchored to the initial location.");
211
212         prop= RNA_def_property(srna, "flip_direction", PROP_BOOLEAN, PROP_NONE);
213         RNA_def_property_boolean_sdna(prop, NULL, "flag", BRUSH_DIR_IN);
214         RNA_def_property_ui_text(prop, "Flip Direction", "Move vertices in the opposite direction.");
215
216         prop= RNA_def_property(srna, "space", PROP_BOOLEAN, PROP_NONE);
217         RNA_def_property_boolean_sdna(prop, NULL, "flag", BRUSH_SPACE);
218         RNA_def_property_ui_text(prop, "Space", "Limit brush application to the distance specified by spacing.");
219
220         prop= RNA_def_property(srna, "smooth_stroke", PROP_BOOLEAN, PROP_NONE);
221         RNA_def_property_boolean_sdna(prop, NULL, "flag", BRUSH_SMOOTH_STROKE);
222         RNA_def_property_ui_text(prop, "Smooth Stroke", "Brush lags behind mouse and follows a smoother path.");
223
224         prop= RNA_def_property(srna, "persistent", PROP_BOOLEAN, PROP_NONE);
225         RNA_def_property_boolean_sdna(prop, NULL, "flag", BRUSH_PERSISTENT);
226         RNA_def_property_ui_text(prop, "Persistent", "Sculpts on a persistent layer of the mesh.");
227         
228         /* not exposed in the interface yet
229         prop= RNA_def_property(srna, "fixed_tex", PROP_BOOLEAN, PROP_NONE);
230         RNA_def_property_boolean_sdna(prop, NULL, "flag", BRUSH_FIXED_TEX);
231         RNA_def_property_ui_text(prop, "Fixed Texture", "Keep texture origin in fixed position.");*/
232
233         prop= RNA_def_property(srna, "curve", PROP_POINTER, PROP_NEVER_NULL);
234         RNA_def_property_ui_text(prop, "Curve", "Editable falloff curve.");
235
236         /* texture */
237         rna_def_mtex_common(srna, "rna_Brush_mtex_begin", "rna_Brush_active_texture_get",
238                 "rna_Brush_active_texture_set", "TextureSlot");
239
240         /* clone tool */
241         prop= RNA_def_property(srna, "clone_image", PROP_POINTER, PROP_NONE);
242         RNA_def_property_pointer_sdna(prop, NULL, "clone.image");
243         RNA_def_property_flag(prop, PROP_EDITABLE);
244         RNA_def_property_ui_text(prop, "Clone Image", "Image for clone tool.");
245         
246         prop= RNA_def_property(srna, "clone_opacity", PROP_FLOAT, PROP_NONE);
247         RNA_def_property_float_sdna(prop, NULL, "clone.alpha");
248         RNA_def_property_range(prop, 0.0f, 1.0f);
249         RNA_def_property_ui_text(prop, "Clone Opacity", "Opacity of clone image display.");
250
251         prop= RNA_def_property(srna, "clone_offset", PROP_FLOAT, PROP_XYZ);
252         RNA_def_property_float_sdna(prop, NULL, "clone.offset");
253         RNA_def_property_ui_text(prop, "Clone Offset", "");
254         RNA_def_property_ui_range(prop, -1.0f , 1.0f, 10.0f, 3);
255 }
256
257
258 /* A brush stroke is a list of changes to the brush that
259  * can occur during a stroke
260  *
261  *  o 3D location of the brush
262  *  o 2D mouse location
263  *  o Tablet pressure
264  *  o Direction flip
265  *  o Tool switch
266  *  o Time
267  */
268 static void rna_def_operator_stroke_element(BlenderRNA *brna)
269 {
270         StructRNA *srna;
271         PropertyRNA *prop;
272
273         srna= RNA_def_struct(brna, "OperatorStrokeElement", "IDPropertyGroup");
274         RNA_def_struct_ui_text(srna, "Operator Stroke Element", "");
275
276         prop= RNA_def_property(srna, "location", PROP_FLOAT, PROP_XYZ);
277         RNA_def_property_flag(prop, PROP_IDPROPERTY);
278         RNA_def_property_array(prop, 3);
279         RNA_def_property_ui_text(prop, "Location", "");
280
281         prop= RNA_def_property(srna, "mouse", PROP_INT, PROP_XYZ);
282         RNA_def_property_flag(prop, PROP_IDPROPERTY);
283         RNA_def_property_array(prop, 2);
284         RNA_def_property_ui_text(prop, "Mouse", "");
285
286         prop= RNA_def_property(srna, "pressure", PROP_FLOAT, PROP_NONE);
287         RNA_def_property_flag(prop, PROP_IDPROPERTY);
288         RNA_def_property_range(prop, 0.0f, 1.0f);
289         RNA_def_property_ui_text(prop, "Pressure", "Tablet pressure.");
290
291         prop= RNA_def_property(srna, "time", PROP_FLOAT, PROP_UNSIGNED);
292         RNA_def_property_flag(prop, PROP_IDPROPERTY);
293         RNA_def_property_ui_text(prop, "Time", "");
294
295         prop= RNA_def_property(srna, "flip", PROP_BOOLEAN, PROP_NONE);
296         RNA_def_property_flag(prop, PROP_IDPROPERTY);
297         RNA_def_property_ui_text(prop, "Flip", "");
298
299         /* XXX: Tool (this will be for pressing a modifier key for a different brush,
300                 e.g. switching to a Smooth brush in the middle of the stroke */
301 }
302
303 void RNA_def_brush(BlenderRNA *brna)
304 {
305         rna_def_brush(brna);
306         rna_def_operator_stroke_element(brna);
307 }
308
309 #endif