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