python api for collection add()/remove()
[blender.git] / source / blender / makesrna / intern / rna_group.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): Campbell Barton
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_group_types.h"
33
34 #ifdef RNA_RUNTIME
35
36 #include "DNA_scene_types.h"
37 #include "DNA_object_types.h"
38
39 #include "BKE_group.h"
40
41 static PointerRNA rna_Group_objects_get(CollectionPropertyIterator *iter)
42 {
43         ListBaseIterator *internal= iter->internal;
44
45         /* we are actually iterating a GroupObject list, so override get */
46         return rna_pointer_inherit_refine(&iter->parent, &RNA_Object, ((GroupObject*)internal->link)->ob);
47 }
48
49 static int rna_Group_objects_add(Group *group, bContext *C, Object *object)
50 {
51         return add_to_group(group, object, CTX_data_scene(C), NULL);
52 }
53
54 static int rna_Group_objects_remove(Group *group, bContext *C, Object *object)
55 {
56         return rem_from_group(group, object, CTX_data_scene(C), NULL);
57 }
58
59 #else
60
61 void RNA_def_group(BlenderRNA *brna)
62 {
63         StructRNA *srna;
64         PropertyRNA *prop;
65
66         srna= RNA_def_struct(brna, "Group", "ID");
67         RNA_def_struct_ui_text(srna, "Group", "Group of Object datablocks.");
68         RNA_def_struct_ui_icon(srna, ICON_GROUP);
69
70         prop= RNA_def_property(srna, "dupli_offset", PROP_FLOAT, PROP_TRANSLATION);
71         RNA_def_property_float_sdna(prop, NULL, "dupli_ofs");
72         RNA_def_property_ui_text(prop, "Dupli Offset", "Offset from the center to use when instancing as DupliGroup.");
73         RNA_def_property_ui_range(prop, -10000.0, 10000.0, 10, 4);
74         
75         prop= RNA_def_property(srna, "layer", PROP_BOOLEAN, PROP_LAYER);
76         RNA_def_property_boolean_sdna(prop, NULL, "layer", 1);
77         RNA_def_property_array(prop, 20);
78         RNA_def_property_ui_text(prop, "Dupli Layers", "Layers visible when this groups is instanced as a dupli.");
79
80
81         /* add object */
82         FunctionRNA *func;
83         PropertyRNA *parm;
84         func= RNA_def_function(srna, "add_object", "rna_Group_objects_add");
85         RNA_def_function_flag(func, FUNC_USE_CONTEXT);
86         RNA_def_function_ui_description(func, "Add this object to a group");
87         /* return type */
88         parm= RNA_def_boolean(func, "success", 0, "Success", "Newly created Group Target.");
89         RNA_def_function_return(func, parm);
90         /* object to add */
91         parm= RNA_def_pointer(func, "object", "Object", "", "Object to add.");
92         RNA_def_property_flag(parm, PROP_REQUIRED);
93
94         /* remove object */
95         func= RNA_def_function(srna, "remove_object", "rna_Group_objects_remove");
96         RNA_def_function_ui_description(func, "Remove this object to a group");
97         RNA_def_function_flag(func, FUNC_USE_CONTEXT);
98         /* return type */
99         parm= RNA_def_boolean(func, "success", 0, "Success", "Newly created Group Target.");
100         RNA_def_function_return(func, parm);
101         /* object to remove */
102         parm= RNA_def_pointer(func, "object", "Object", "", "Object to remove.");
103         RNA_def_property_flag(parm, PROP_REQUIRED);
104
105         prop= RNA_def_property(srna, "objects", PROP_COLLECTION, PROP_NONE);
106         RNA_def_property_collection_sdna(prop, NULL, "gobject", NULL);
107         RNA_def_property_struct_type(prop, "Object");
108         RNA_def_property_ui_text(prop, "Objects", "A collection of this groups objects.");
109         RNA_def_property_collection_funcs(prop, 0, 0, 0, "rna_Group_objects_get", 0, 0, 0, "add_object", "remove_object");
110 }
111
112 #endif
113