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