RNA
[blender.git] / source / blender / makesrna / intern / rna_property.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).
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_property_types.h"
33
34 #ifdef RNA_RUNTIME
35
36 static StructRNA* rna_GameProperty_refine(struct PointerRNA *ptr)
37 {
38         bProperty *property= (bProperty*)ptr->data;
39
40         switch(property->type){
41                 case GPROP_BOOL:
42                         return &RNA_GameBooleanProperty;
43                 case GPROP_INT:
44                         return &RNA_GameIntProperty;
45                 case GPROP_FLOAT:
46                         return &RNA_GameFloatProperty;
47                 case GPROP_STRING:
48                         return &RNA_GameStringProperty;
49                 case GPROP_TIME:
50                         return &RNA_GameTimerProperty;
51                 default:
52                         return &RNA_GameProperty;
53         }
54 }
55
56 /* for both float and timer */
57 static float rna_GameFloatProperty_value_get(PointerRNA *ptr)
58 {
59         bProperty *prop= (bProperty*)(ptr->data);
60         return *(float*)(&prop->data);
61 }
62
63 static void rna_GameFloatProperty_value_set(PointerRNA *ptr, float value)
64 {
65         bProperty *prop= (bProperty*)(ptr->data);
66         CLAMP(value, -10000.0f, 10000.0f);
67         *(float*)(&prop->data)= value;
68 }
69
70 #else
71
72 void RNA_def_gameproperty(BlenderRNA *brna)
73 {
74         StructRNA *srna;
75         PropertyRNA *prop;
76
77         static EnumPropertyItem gameproperty_type_items[] ={
78                 {GPROP_BOOL, "BOOL", "Boolean", ""},
79                 {GPROP_INT, "INT", "Integer", ""},
80                 {GPROP_FLOAT, "FLOAT", "Float", ""},
81                 {GPROP_STRING, "STRING", "String", ""},
82                 {GPROP_TIME, "TIMER", "Timer", ""},
83                 {0, NULL, NULL, NULL}};
84
85         /* Base Struct for GameProperty */
86         srna= RNA_def_struct(brna, "GameProperty", NULL);
87         RNA_def_struct_ui_text(srna , "Game Property", "Game engine user defined object property.");
88         RNA_def_struct_sdna(srna, "bProperty");
89         RNA_def_struct_refine_func(srna, "rna_GameProperty_refine");
90
91         prop= RNA_def_property(srna, "name", PROP_STRING, PROP_NONE);
92         RNA_def_property_flag(prop, PROP_NOT_EDITABLE); /* must be unique */
93         RNA_def_property_ui_text(prop, "Name", "Available as as GameObject attributes in the game engines python api");
94         RNA_def_struct_name_property(srna, prop);
95
96         prop= RNA_def_property(srna, "type", PROP_ENUM, PROP_NONE);
97         RNA_def_property_flag(prop, PROP_NOT_EDITABLE);
98         RNA_def_property_enum_items(prop, gameproperty_type_items);
99         RNA_def_property_ui_text(prop, "Type", "");
100
101         prop= RNA_def_property(srna, "debug", PROP_BOOLEAN, PROP_NONE);
102         RNA_def_property_boolean_sdna(prop, NULL, "flag", PROP_DEBUG);
103         RNA_def_property_ui_text(prop, "Debug", "Print debug information for this property.");
104
105         /* GameBooleanProperty */
106         srna= RNA_def_struct(brna, "GameBooleanProperty", "GameProperty");
107         RNA_def_struct_ui_text(srna , "Game Boolean Property", "Game engine user defined boolean property.");
108         RNA_def_struct_sdna(srna, "bProperty");
109
110         prop= RNA_def_property(srna, "value", PROP_BOOLEAN, PROP_NONE);
111         RNA_def_property_boolean_sdna(prop, NULL, "data", 1);
112         RNA_def_property_ui_text(prop, "Value", "Property value.");
113
114         /* GameIntProperty */
115         srna= RNA_def_struct(brna, "GameIntProperty", "GameProperty");
116         RNA_def_struct_ui_text(srna , "Game Integer Property", "Game engine user defined integer number property.");
117         RNA_def_struct_sdna(srna, "bProperty");
118
119         prop= RNA_def_property(srna, "value", PROP_INT, PROP_NONE);
120         RNA_def_property_int_sdna(prop, NULL, "data");
121         RNA_def_property_ui_text(prop, "Value", "Property value.");
122         RNA_def_property_range(prop, -10000, 10000);
123
124         /* GameFloatProperty */
125         srna= RNA_def_struct(brna, "GameFloatProperty", "GameProperty");
126         RNA_def_struct_ui_text(srna, "Game Float Property", "Game engine user defined floating pointer number property.");
127         RNA_def_struct_sdna(srna, "bProperty");
128
129         prop= RNA_def_property(srna, "value", PROP_FLOAT, PROP_NONE);
130         RNA_def_property_float_sdna(prop, NULL, "data");
131         RNA_def_property_ui_text(prop, "Value", "Property value.");
132         RNA_def_property_range(prop, -10000, 10000);
133         RNA_def_property_float_funcs(prop, "rna_GameFloatProperty_value_get", "rna_GameFloatProperty_value_set", NULL);
134
135         /* GameTimerProperty */
136         srna= RNA_def_struct(brna, "GameTimerProperty", "GameProperty");
137         RNA_def_struct_ui_text(srna, "Game Timer Property", "Game engine user defined timer property.");
138         RNA_def_struct_sdna(srna, "bProperty");
139
140         prop= RNA_def_property(srna, "value", PROP_FLOAT, PROP_NONE);
141         RNA_def_property_float_sdna(prop, NULL, "data");
142         RNA_def_property_ui_text(prop, "Value", "Property value.");
143         RNA_def_property_range(prop, -10000, 10000);
144         RNA_def_property_float_funcs(prop, "rna_GameFloatProperty_value_get", "rna_GameFloatProperty_value_set", NULL);
145
146         /* GameStringProperty */
147         srna= RNA_def_struct(brna, "GameStringProperty", "GameProperty");
148         RNA_def_struct_ui_text(srna, "Game String Property", "Game engine user defined text string property.");
149         RNA_def_struct_sdna(srna, "bProperty");
150
151         prop= RNA_def_property(srna, "value", PROP_STRING, PROP_NONE);
152         RNA_def_property_string_sdna(prop, NULL, "poin");
153         RNA_def_property_string_maxlength(prop, MAX_PROPSTRING);
154         RNA_def_property_ui_text(prop, "Value", "Property value.");
155 }
156
157 #endif
158