Merge branch 'master' into blender2.8
[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 #include "BLI_string_utils.h"
35
36 #include "BLT_translation.h"
37
38 #include "RNA_define.h"
39 #include "RNA_enum_types.h"
40
41 #include "rna_internal.h"
42
43
44 #include "WM_types.h"
45
46 EnumPropertyItem rna_enum_gameproperty_type_items[] = {
47         {GPROP_BOOL, "BOOL", 0, "Boolean", "Boolean Property"},
48         {GPROP_INT, "INT", 0, "Integer", "Integer Property"},
49         {GPROP_FLOAT, "FLOAT", 0, "Float", "Floating-Point Property"},
50         {GPROP_STRING, "STRING", 0, "String", "String Property"},
51         {GPROP_TIME, "TIMER", 0, "Timer", "Timer Property"},
52         {0, NULL, 0, NULL, NULL}
53 };
54
55
56 #ifdef RNA_RUNTIME
57
58 #include "BKE_property.h"
59
60 static StructRNA *rna_GameProperty_refine(struct PointerRNA *ptr)
61 {
62         bProperty *property = (bProperty *)ptr->data;
63
64         switch (property->type) {
65                 case GPROP_BOOL:
66                         return &RNA_GameBooleanProperty;
67                 case GPROP_INT:
68                         return &RNA_GameIntProperty;
69                 case GPROP_FLOAT:
70                         return &RNA_GameFloatProperty;
71                 case GPROP_STRING:
72                         return &RNA_GameStringProperty;
73                 case GPROP_TIME:
74                         return &RNA_GameTimerProperty;
75                 default:
76                         return &RNA_GameProperty;
77         }
78 }
79
80 /* for both float and timer */
81 static float rna_GameFloatProperty_value_get(PointerRNA *ptr)
82 {
83         bProperty *prop = (bProperty *)(ptr->data);
84         return *(float *)(&prop->data);
85 }
86
87 static void rna_GameFloatProperty_value_set(PointerRNA *ptr, float value)
88 {
89         bProperty *prop = (bProperty *)(ptr->data);
90         CLAMP(value, -10000.0f, 10000.0f);
91         *(float *)(&prop->data) = value;
92 }
93
94 static void rna_GameProperty_type_set(PointerRNA *ptr, int value)
95 {
96         bProperty *prop = (bProperty *)(ptr->data);
97
98         if (prop->type != value) {
99                 prop->type = value;
100                 BKE_bproperty_init(prop);
101         }
102 }
103
104 static void rna_GameProperty_name_set(PointerRNA *ptr, const char *value)
105 {
106         Object *ob = ptr->id.data;
107         bProperty *prop = ptr->data;
108         BLI_strncpy_utf8(prop->name, value, sizeof(prop->name));
109
110         BLI_uniquename(&ob->prop, prop, DATA_("Property"), '.', offsetof(bProperty, name), sizeof(prop->name));
111 }
112
113
114 #else
115
116 void RNA_def_gameproperty(BlenderRNA *brna)
117 {
118         StructRNA *srna;
119         PropertyRNA *prop;
120
121         /* Base Struct for GameProperty */
122         srna = RNA_def_struct(brna, "GameProperty", NULL);
123         RNA_def_struct_ui_text(srna, "Game Property", "Game engine user defined object property");
124         RNA_def_struct_sdna(srna, "bProperty");
125         RNA_def_struct_refine_func(srna, "rna_GameProperty_refine");
126
127         prop = RNA_def_property(srna, "name", PROP_STRING, PROP_NONE);
128         RNA_def_property_ui_text(prop, "Name", "Available as GameObject attributes in the game engine's python API");
129         RNA_def_struct_name_property(srna, prop);
130         RNA_def_property_string_funcs(prop, NULL, NULL, "rna_GameProperty_name_set");
131         RNA_def_property_update(prop, NC_LOGIC, NULL);
132
133         prop = RNA_def_property(srna, "type", PROP_ENUM, PROP_NONE);
134         RNA_def_property_enum_items(prop, rna_enum_gameproperty_type_items);
135         RNA_def_property_ui_text(prop, "Type", "");
136         RNA_def_property_enum_funcs(prop, NULL, "rna_GameProperty_type_set", NULL);
137         RNA_def_property_update(prop, NC_LOGIC, NULL);
138
139         prop = RNA_def_property(srna, "show_debug", PROP_BOOLEAN, PROP_NONE);
140         RNA_def_property_boolean_sdna(prop, NULL, "flag", PROP_DEBUG);
141         RNA_def_property_ui_text(prop, "Debug", "Print debug information for this property");
142         RNA_def_property_update(prop, NC_LOGIC, NULL);
143
144         /* GameBooleanProperty */
145         srna = RNA_def_struct(brna, "GameBooleanProperty", "GameProperty");
146         RNA_def_struct_ui_text(srna, "Game Boolean Property", "Game engine user defined Boolean property");
147         RNA_def_struct_sdna(srna, "bProperty");
148         RNA_def_property_update(prop, NC_LOGIC, NULL);
149
150         prop = RNA_def_property(srna, "value", PROP_BOOLEAN, PROP_NONE);
151         RNA_def_property_boolean_sdna(prop, NULL, "data", 1);
152         RNA_def_property_ui_text(prop, "Value", "Property value");
153         RNA_def_property_update(prop, NC_LOGIC, NULL);
154
155         /* GameIntProperty */
156         srna = RNA_def_struct(brna, "GameIntProperty", "GameProperty");
157         RNA_def_struct_ui_text(srna, "Game Integer Property", "Game engine user defined integer number property");
158         RNA_def_struct_sdna(srna, "bProperty");
159
160         prop = RNA_def_property(srna, "value", PROP_INT, PROP_NONE);
161         RNA_def_property_int_sdna(prop, NULL, "data");
162         RNA_def_property_ui_text(prop, "Value", "Property value");
163         RNA_def_property_range(prop, -10000, 10000);
164         RNA_def_property_update(prop, NC_LOGIC, NULL);
165
166         /* GameFloatProperty */
167         srna = RNA_def_struct(brna, "GameFloatProperty", "GameProperty");
168         RNA_def_struct_ui_text(srna, "Game Float Property", "Game engine user defined floating point number property");
169         RNA_def_struct_sdna(srna, "bProperty");
170
171         prop = RNA_def_property(srna, "value", PROP_FLOAT, PROP_NONE);
172         /* RNA_def_property_float_sdna(prop, NULL, "data"); */
173         RNA_def_property_ui_text(prop, "Value", "Property value");
174         RNA_def_property_range(prop, -10000, 10000);
175         RNA_def_property_float_funcs(prop, "rna_GameFloatProperty_value_get", "rna_GameFloatProperty_value_set", NULL);
176         RNA_def_property_update(prop, NC_LOGIC, NULL);
177
178         /* GameTimerProperty */
179         srna = RNA_def_struct(brna, "GameTimerProperty", "GameProperty");
180         RNA_def_struct_ui_text(srna, "Game Timer Property", "Game engine user defined timer property");
181         RNA_def_struct_sdna(srna, "bProperty");
182
183         prop = RNA_def_property(srna, "value", PROP_FLOAT, PROP_NONE);
184         /* RNA_def_property_float_sdna(prop, NULL, "data"); */
185         RNA_def_property_ui_text(prop, "Value", "Property value");
186         RNA_def_property_range(prop, -10000, 10000);
187         RNA_def_property_float_funcs(prop, "rna_GameFloatProperty_value_get", "rna_GameFloatProperty_value_set", NULL);
188         RNA_def_property_update(prop, NC_LOGIC, NULL);
189
190         /* GameStringProperty */
191         srna = RNA_def_struct(brna, "GameStringProperty", "GameProperty");
192         RNA_def_struct_ui_text(srna, "Game String Property", "Game engine user defined text string property");
193         RNA_def_struct_sdna(srna, "bProperty");
194
195         prop = RNA_def_property(srna, "value", PROP_STRING, PROP_NONE);
196         RNA_def_property_string_sdna(prop, NULL, "poin");
197         RNA_def_property_string_maxlength(prop, MAX_PROPSTRING);
198         RNA_def_property_ui_text(prop, "Value", "Property value");
199         RNA_def_property_update(prop, NC_LOGIC, NULL);
200 }
201
202 #endif
203