added "description" and "readonly" properties to RNA Structs (also accessible via...
[blender.git] / source / blender / makesrna / intern / rna_meta.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_meta_types.h"
33
34 #ifdef RNA_RUNTIME
35
36 static int rna_Meta_texspace_editable(PointerRNA *ptr)
37 {
38         MetaBall *mb= (MetaBall*)ptr->data;
39         return (mb->texflag & AUTOSPACE)? PROP_NOT_EDITABLE: 0;
40 }
41
42 #else
43
44 void rna_def_metaelement(BlenderRNA *brna)
45 {
46         StructRNA *srna;
47         PropertyRNA *prop;
48         static EnumPropertyItem prop_type_items[] = {
49                 {MB_BALL, "BALL", "Ball", ""},
50                 {MB_TUBE, "TUBE", "Tube", ""},
51                 {MB_PLANE, "PLANE", "Plane", ""},
52                 {MB_ELIPSOID, "ELLIPSOID", "Ellipsoid", ""}, // NOTE: typo at original definition!
53                 {MB_CUBE, "CUBE", "Cube", ""},
54                 {0, NULL, NULL, NULL}};
55         
56         srna= RNA_def_struct(brna, "MetaElement", NULL);
57         RNA_def_struct_ui_text(srna, "Meta Element", "DOC_BROKEN");
58         RNA_def_struct_sdna(srna, "MetaElem");
59         
60         /* enums */
61         prop= RNA_def_property(srna, "type", PROP_ENUM, PROP_NONE);
62         RNA_def_property_flag(prop, PROP_NOT_EDITABLE);
63         RNA_def_property_enum_items(prop, prop_type_items);
64         RNA_def_property_ui_text(prop, "Type", "Metaball types.");
65         
66         /* number values */
67         prop= RNA_def_property(srna, "location", PROP_FLOAT, PROP_VECTOR);
68         RNA_def_property_float_sdna(prop, NULL, "x");
69         RNA_def_property_array(prop, 3);
70         RNA_def_property_ui_text(prop, "Location", "");
71
72         prop= RNA_def_property(srna, "rotation", PROP_FLOAT, PROP_ROTATION);
73         RNA_def_property_float_sdna(prop, NULL, "quat");
74         RNA_def_property_ui_text(prop, "Rotation", "");
75
76         prop= RNA_def_property(srna, "radius", PROP_FLOAT, PROP_UNSIGNED);
77         RNA_def_property_float_sdna(prop, NULL, "rad");
78         RNA_def_property_ui_text(prop, "Radius", "");
79
80         prop= RNA_def_property(srna, "size", PROP_FLOAT, PROP_NONE);
81         RNA_def_property_float_sdna(prop, NULL, "expx");
82         RNA_def_property_range(prop, 0.0f, 20.0f);
83         RNA_def_property_array(prop, 3);
84         RNA_def_property_ui_text(prop, "Size", "Size of element, use of components depends on element type.");
85         
86         prop= RNA_def_property(srna, "stiffness", PROP_FLOAT, PROP_NONE);
87         RNA_def_property_float_sdna(prop, NULL, "s");
88         RNA_def_property_range(prop, 0.0f, 10.0f);
89         RNA_def_property_ui_text(prop, "Stiffness", "Stiffness defines how much of the element to fill.");
90         
91         /* flags */
92         prop= RNA_def_property(srna, "negative", PROP_BOOLEAN, PROP_NONE);
93         RNA_def_property_boolean_sdna(prop, NULL, "flag", MB_NEGATIVE);
94         RNA_def_property_ui_text(prop, "Negative", "Set metaball as negative one.");
95         
96         prop= RNA_def_property(srna, "hide", PROP_BOOLEAN, PROP_NONE);
97         RNA_def_property_boolean_sdna(prop, NULL, "flag", MB_HIDE);
98         RNA_def_property_ui_text(prop, "Hide", "Hide element.");
99 }
100
101 void rna_def_metaball(BlenderRNA *brna)
102 {
103         StructRNA *srna;
104         PropertyRNA *prop;
105         static EnumPropertyItem prop_update_items[] = {
106                 {MB_UPDATE_ALWAYS, "UPDATE_ALWAYS", "Always", "While editing, update metaball always."},
107                 {MB_UPDATE_HALFRES, "HALFRES", "Half Resolution", "While editing, update metaball in half resolution."},
108                 {MB_UPDATE_FAST, "FAST", "Fast", "While editing, update metaball without polygonization."},
109                 {MB_UPDATE_NEVER, "NEVER", "Never", "While editing, don't update metaball at all."},
110                 {0, NULL, NULL, NULL}};
111         
112         srna= RNA_def_struct(brna, "MetaBall", "ID");
113         RNA_def_struct_ui_text(srna, "MetaBall", "DOC_BROKEN");
114
115         prop= RNA_def_property(srna, "elements", PROP_COLLECTION, PROP_NONE);
116         RNA_def_property_collection_sdna(prop, NULL, "elems", NULL);
117         RNA_def_property_struct_type(prop, "MetaElement");
118         RNA_def_property_ui_text(prop, "Elements", "Meta elements.");
119
120         /* enums */
121         prop= RNA_def_property(srna, "flag", PROP_ENUM, PROP_NONE);
122         RNA_def_property_enum_items(prop, prop_update_items);
123         RNA_def_property_ui_text(prop, "Update", "Metaball edit update behavior.");
124         
125         /* number values */
126         prop= RNA_def_property(srna, "wire_size", PROP_FLOAT, PROP_NONE);
127         RNA_def_property_float_sdna(prop, NULL, "wiresize");
128         RNA_def_property_range(prop, 0.050f, 1.0f);
129         RNA_def_property_ui_text(prop, "Wire Size", "Polygonization resolution in the 3D viewport.");
130         
131         prop= RNA_def_property(srna, "render_size", PROP_FLOAT, PROP_NONE);
132         RNA_def_property_float_sdna(prop, NULL, "rendersize");
133         RNA_def_property_range(prop, 0.050f, 1.0f);
134         RNA_def_property_ui_text(prop, "Render Size", "Polygonization resolution in rendering.");
135         
136         prop= RNA_def_property(srna, "threshold", PROP_FLOAT, PROP_NONE);
137         RNA_def_property_float_sdna(prop, NULL, "thresh");
138         RNA_def_property_range(prop, 0.0f, 5.0f);
139         RNA_def_property_ui_text(prop, "Threshold", "Influence of meta elements.");
140
141         /* materials, textures */
142         rna_def_texmat_common(srna, "rna_Meta_texspace_editable");
143         rna_def_ipo_common(srna);
144 }
145
146 void RNA_def_meta(BlenderRNA *brna)
147 {
148         rna_def_metaelement(brna);
149         rna_def_metaball(brna);
150 }
151
152 #endif