soc-2008-mxcurioni: merged changes to revision 23516
[blender.git] / source / blender / makesrna / intern / rna_main_api.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  * The Original Code is Copyright (C) 2009 Blender Foundation.
21  * All rights reserved.
22  *
23  * 
24  * Contributor(s): Blender Foundation
25  *
26  * ***** END GPL LICENSE BLOCK *****
27  */
28
29 #include <stdlib.h>
30 #include <stdio.h>
31
32 #include "RNA_define.h"
33 #include "RNA_types.h"
34 #include "RNA_enum_types.h"
35
36 #include "DNA_object_types.h"
37 #include "DNA_material_types.h"
38 #include "DNA_mesh_types.h"
39
40 #ifdef RNA_RUNTIME
41
42 #include "BKE_main.h"
43 #include "BKE_mesh.h"
44 #include "BKE_library.h"
45 #include "BKE_object.h"
46 #include "BKE_material.h"
47 #include "BKE_image.h"
48 #include "BKE_texture.h"
49
50 #include "DNA_lamp_types.h"
51
52 static Mesh *rna_Main_add_mesh(Main *main, char *name)
53 {
54         Mesh *me= add_mesh(name);
55         me->id.us--;
56         return me;
57 }
58
59 static void rna_Main_remove_mesh(Main *main, ReportList *reports, Mesh *me)
60 {
61         if(me->id.us == 0)
62                 free_libblock(&main->mesh, me);
63         else
64                 BKE_report(reports, RPT_ERROR, "Mesh must have zero users to be removed.");
65         
66         /* XXX python now has invalid pointer? */
67 }
68
69 static Lamp *rna_Main_add_lamp(Main *main, char *name)
70 {
71         Lamp *la= add_lamp(name);
72         la->id.us--;
73         return la;
74 }
75
76 /*
77 static void rna_Main_remove_lamp(Main *main, ReportList *reports, Lamp *la)
78 {
79         if(la->id.us == 0)
80                 free_libblock(&main->lamp, la);
81         else
82                 BKE_report(reports, RPT_ERROR, "Lamp must have zero users to be removed.");
83 }
84 */
85
86 static Object* rna_Main_add_object(Main *main, int type, char *name)
87 {
88         Object *ob= add_only_object(type, name);
89         ob->id.us--;
90         return ob;
91 }
92
93 /*
94   NOTE: the following example shows when this function should _not_ be called
95
96   ob = bpy.data.add_object()
97   scene.add_object(ob)
98
99   # ob is freed here
100   scene.remove_object(ob)
101
102   # don't do this since ob is already freed!
103   bpy.data.remove_object(ob)
104 */
105 static void rna_Main_remove_object(Main *main, ReportList *reports, Object *ob)
106 {
107         if(ob->id.us == 0)
108                 free_libblock(&main->object, ob);
109         else
110                 BKE_report(reports, RPT_ERROR, "Object must have zero users to be removed.");
111 }
112
113 static Material *rna_Main_add_material(Main *main, char *name)
114 {
115         return add_material(name);
116 }
117
118 /* TODO: remove material? */
119
120 struct Tex *rna_Main_add_texture(Main *main, char *name)
121 {
122         return add_texture(name);
123 }
124
125 /* TODO: remove texture? */
126
127 struct Image *rna_Main_add_image(Main *main, char *filename)
128 {
129         return BKE_add_image_file(filename, 0);
130 }
131
132 #else
133
134 void RNA_api_main(StructRNA *srna)
135 {
136         FunctionRNA *func;
137         PropertyRNA *parm;
138
139         func= RNA_def_function(srna, "add_object", "rna_Main_add_object");
140         RNA_def_function_ui_description(func, "Add a new object.");
141         parm= RNA_def_enum(func, "type", object_type_items, 0, "", "Type of Object.");
142         RNA_def_property_flag(parm, PROP_REQUIRED);
143         parm= RNA_def_string(func, "name", "Object", 0, "", "New name for the datablock.");
144         RNA_def_property_flag(parm, PROP_REQUIRED);
145         parm= RNA_def_pointer(func, "object", "Object", "", "New object.");
146         RNA_def_function_return(func, parm);
147
148         func= RNA_def_function(srna, "remove_object", "rna_Main_remove_object");
149         RNA_def_function_flag(func, FUNC_USE_REPORTS);
150         RNA_def_function_ui_description(func, "Remove an object if it has zero users.");
151         parm= RNA_def_pointer(func, "object", "Object", "", "Object to remove.");
152         RNA_def_property_flag(parm, PROP_REQUIRED);
153
154         func= RNA_def_function(srna, "add_mesh", "rna_Main_add_mesh");
155         RNA_def_function_ui_description(func, "Add a new mesh.");
156         parm= RNA_def_string(func, "name", "Mesh", 0, "", "New name for the datablock.");
157         RNA_def_property_flag(parm, PROP_REQUIRED);
158         parm= RNA_def_pointer(func, "mesh", "Mesh", "", "New mesh.");
159         RNA_def_function_return(func, parm);
160
161         func= RNA_def_function(srna, "remove_mesh", "rna_Main_remove_mesh");
162         RNA_def_function_flag(func, FUNC_USE_REPORTS);
163         RNA_def_function_ui_description(func, "Remove a mesh if it has zero users.");
164         parm= RNA_def_pointer(func, "mesh", "Mesh", "", "Mesh to remove.");
165         RNA_def_property_flag(parm, PROP_REQUIRED);
166
167         func= RNA_def_function(srna, "add_lamp", "rna_Main_add_lamp");
168         RNA_def_function_ui_description(func, "Add a new lamp.");
169         parm= RNA_def_string(func, "name", "Lamp", 0, "", "New name for the datablock.");
170         RNA_def_property_flag(parm, PROP_REQUIRED);
171         parm= RNA_def_pointer(func, "mesh", "Lamp", "", "New lamp.");
172         RNA_def_function_return(func, parm);
173
174         func= RNA_def_function(srna, "add_material", "rna_Main_add_material");
175         RNA_def_function_ui_description(func, "Add a new material.");
176         parm= RNA_def_string(func, "name", "Material", 0, "", "New name for the datablock."); /* optional */
177         parm= RNA_def_pointer(func, "material", "Material", "", "New material.");
178         RNA_def_function_return(func, parm);
179
180         func= RNA_def_function(srna, "add_texture", "rna_Main_add_texture");
181         RNA_def_function_ui_description(func, "Add a new texture.");
182         parm= RNA_def_string(func, "name", "Tex", 0, "", "New name for the datablock."); /* optional */
183         parm= RNA_def_pointer(func, "texture", "Texture", "", "New texture.");
184         RNA_def_function_return(func, parm);
185
186         func= RNA_def_function(srna, "add_image", "rna_Main_add_image");
187         RNA_def_function_ui_description(func, "Add a new image.");
188         parm= RNA_def_string(func, "filename", "", 0, "", "Filename to load image from.");
189         RNA_def_property_flag(parm, PROP_REQUIRED);
190         parm= RNA_def_pointer(func, "image", "Image", "", "New image.");
191         RNA_def_function_return(func, parm);
192
193 }
194
195 #endif
196