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