454816d4e0ab421180f25da31fe83d15d187e159
[blender.git] / source / blender / makesrna / intern / rna_property.c
1 /*
2  * ***** BEGIN GPL LICENSE BLOCK *****
3  *
4  * This program is free software; you can redistribute it and/or
5  * modify it under the terms of the GNU General Public License
6  * as published by the Free Software Foundation; either version 2
7  * of the License, or (at your option) any later version.
8  *
9  * This program is distributed in the hope that it will be useful,
10  * but WITHOUT ANY WARRANTY; without even the implied warranty of
11  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
12  * GNU General Public License for more details.
13  *
14  * You should have received a copy of the GNU General Public License
15  * along with this program; if not, write to the Free Software Foundation,
16  * Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
17  *
18  * Contributor(s): Blender Foundation (2008).
19  *
20  * ***** END GPL LICENSE BLOCK *****
21  */
22
23 /** \file blender/makesrna/intern/rna_property.c
24  *  \ingroup RNA
25  */
26
27
28 #include <stdlib.h>
29
30 #include "DNA_property_types.h"
31 #include "DNA_object_types.h"
32
33 #include "BLI_path_util.h"
34
35 #include "BLT_translation.h"
36
37 #include "RNA_define.h"
38 #include "RNA_enum_types.h"
39
40 #include "rna_internal.h"
41
42
43 #include "WM_types.h"
44
45 EnumPropertyItem gameproperty_type_items[] = {
46         {GPROP_BOOL, "BOOL", 0, "Boolean", "Boolean Property"},
47         {GPROP_INT, "INT", 0, "Integer", "Integer Property"},
48         {GPROP_FLOAT, "FLOAT", 0, "Float", "Floating-Point Property"},
49         {GPROP_STRING, "STRING", 0, "String", "String Property"},
50         {GPROP_TIME, "TIMER", 0, "Timer", "Timer Property"},
51         {0, NULL, 0, NULL, NULL}
52 };
53
54
55 #ifdef RNA_RUNTIME
56
57 #include "BKE_property.h"
58
59 static StructRNA *rna_GameProperty_refine(struct PointerRNA *ptr)
60 {
61         bProperty *property = (bProperty *)ptr->data;
62
63         switch (property->type) {
64                 case GPROP_BOOL:
65                         return &RNA_GameBooleanProperty;
66                 case GPROP_INT:
67                         return &RNA_GameIntProperty;
68                 case GPROP_FLOAT:
69                         return &RNA_GameFloatProperty;
70                 case GPROP_STRING:
71                         return &RNA_GameStringProperty;
72                 case GPROP_TIME:
73                         return &RNA_GameTimerProperty;
74                 default:
75                         return &RNA_GameProperty;
76         }
77 }
78
79 /* for both float and timer */
80 static float rna_GameFloatProperty_value_get(PointerRNA *ptr)
81 {
82         bProperty *prop = (bProperty *)(ptr->data);
83         return *(float *)(&prop->data);
84 }
85
86 static void rna_GameFloatProperty_value_set(PointerRNA *ptr, float value)
87 {
88         bProperty *prop = (bProperty *)(ptr->data);
89         CLAMP(value, -10000.0f, 10000.0f);
90         *(float *)(&prop->data) = value;
91 }
92
93 static void rna_GameProperty_type_set(PointerRNA *ptr, int value)
94 {
95         bProperty *prop = (bProperty *)(ptr->data);
96
97         if (prop->type != value) {
98                 prop->type = value;
99                 BKE_bproperty_init(prop);
100         }
101 }
102
103 static void rna_GameProperty_name_set(PointerRNA *ptr, const char *value)
104 {
105         Object *ob = ptr->id.data;
106         bProperty *prop = ptr->data;
107         BLI_strncpy_utf8(prop->name, value, sizeof(prop->name));
108
109         BLI_uniquename(&ob->prop, prop, DATA_("Property"), '.', offsetof(bProperty, name), sizeof(prop->name));
110 }
111
112
113 #else
114
115 void RNA_def_gameproperty(BlenderRNA *brna)
116 {
117         StructRNA *srna;
118         PropertyRNA *prop;
119
120         /* Base Struct for GameProperty */
121         srna = RNA_def_struct(brna, "GameProperty", NULL);
122         RNA_def_struct_ui_text(srna, "Game Property", "Game engine user defined object property");
123         RNA_def_struct_sdna(srna, "bProperty");
124         RNA_def_struct_refine_func(srna, "rna_GameProperty_refine");
125
126         prop = RNA_def_property(srna, "name", PROP_STRING, PROP_NONE);
127         RNA_def_property_ui_text(prop, "Name", "Available as GameObject attributes in the game engine's python API");
128         RNA_def_struct_name_property(srna, prop);
129         RNA_def_property_string_funcs(prop, NULL, NULL, "rna_GameProperty_name_set");
130         RNA_def_property_update(prop, NC_LOGIC, NULL);
131
132         prop = RNA_def_property(srna, "type", PROP_ENUM, PROP_NONE);
133         RNA_def_property_enum_items(prop, gameproperty_type_items);
134         RNA_def_property_ui_text(prop, "Type", "");
135         RNA_def_property_enum_funcs(prop, NULL, "rna_GameProperty_type_set", NULL);
136         RNA_def_property_update(prop, NC_LOGIC, NULL);
137
138         prop = RNA_def_property(srna, "show_debug", PROP_BOOLEAN, PROP_NONE);
139         RNA_def_property_boolean_sdna(prop, NULL, "flag", PROP_DEBUG);
140         RNA_def_property_ui_text(prop, "Debug", "Print debug information for this property");
141         RNA_def_property_update(prop, NC_LOGIC, NULL);
142
143         /* GameBooleanProperty */
144         srna = RNA_def_struct(brna, "GameBooleanProperty", "GameProperty");
145         RNA_def_struct_ui_text(srna, "Game Boolean Property", "Game engine user defined Boolean property");
146         RNA_def_struct_sdna(srna, "bProperty");
147         RNA_def_property_update(prop, NC_LOGIC, NULL);
148
149         prop = RNA_def_property(srna, "value", PROP_BOOLEAN, PROP_NONE);
150         RNA_def_property_boolean_sdna(prop, NULL, "data", 1);
151         RNA_def_property_ui_text(prop, "Value", "Property value");
152         RNA_def_property_update(prop, NC_LOGIC, NULL);
153
154         /* GameIntProperty */
155         srna = RNA_def_struct(brna, "GameIntProperty", "GameProperty");
156         RNA_def_struct_ui_text(srna, "Game Integer Property", "Game engine user defined integer number property");
157         RNA_def_struct_sdna(srna, "bProperty");
158
159         prop = RNA_def_property(srna, "value", PROP_INT, PROP_NONE);
160         RNA_def_property_int_sdna(prop, NULL, "data");
161         RNA_def_property_ui_text(prop, "Value", "Property value");
162         RNA_def_property_range(prop, -10000, 10000);
163         RNA_def_property_update(prop, NC_LOGIC, NULL);
164
165         /* GameFloatProperty */
166         srna = RNA_def_struct(brna, "GameFloatProperty", "GameProperty");
167         RNA_def_struct_ui_text(srna, "Game Float Property", "Game engine user defined floating point number property");
168         RNA_def_struct_sdna(srna, "bProperty");
169
170         prop = RNA_def_property(srna, "value", PROP_FLOAT, PROP_NONE);
171         /* RNA_def_property_float_sdna(prop, NULL, "data"); */
172         RNA_def_property_ui_text(prop, "Value", "Property value");
173         RNA_def_property_range(prop, -10000, 10000);
174         RNA_def_property_float_funcs(prop, "rna_GameFloatProperty_value_get", "rna_GameFloatProperty_value_set", NULL);
175         RNA_def_property_update(prop, NC_LOGIC, NULL);
176
177         /* GameTimerProperty */
178         srna = RNA_def_struct(brna, "GameTimerProperty", "GameProperty");
179         RNA_def_struct_ui_text(srna, "Game Timer Property", "Game engine user defined timer property");
180         RNA_def_struct_sdna(srna, "bProperty");
181
182         prop = RNA_def_property(srna, "value", PROP_FLOAT, PROP_NONE);
183         /* RNA_def_property_float_sdna(prop, NULL, "data"); */
184         RNA_def_property_ui_text(prop, "Value", "Property value");
185         RNA_def_property_range(prop, -10000, 10000);
186         RNA_def_property_float_funcs(prop, "rna_GameFloatProperty_value_get", "rna_GameFloatProperty_value_set", NULL);
187         RNA_def_property_update(prop, NC_LOGIC, NULL);
188
189         /* GameStringProperty */
190         srna = RNA_def_struct(brna, "GameStringProperty", "GameProperty");
191         RNA_def_struct_ui_text(srna, "Game String Property", "Game engine user defined text string property");
192         RNA_def_struct_sdna(srna, "bProperty");
193
194         prop = RNA_def_property(srna, "value", PROP_STRING, PROP_NONE);
195         RNA_def_property_string_sdna(prop, NULL, "poin");
196         RNA_def_property_string_maxlength(prop, MAX_PROPSTRING);
197         RNA_def_property_ui_text(prop, "Value", "Property value");
198         RNA_def_property_update(prop, NC_LOGIC, NULL);
199 }
200
201 #endif
202