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