Merging r46203 through r46413 from trunk into soc-2011-tomato
[blender.git] / source / blender / makesrna / intern / rna_group.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): Campbell Barton
19  *
20  * ***** END GPL LICENSE BLOCK *****
21  */
22
23 /** \file blender/makesrna/intern/rna_group.c
24  *  \ingroup RNA
25  */
26
27
28 #include <stdlib.h>
29
30 #include "RNA_define.h"
31
32 #include "rna_internal.h"
33
34 #include "DNA_group_types.h"
35
36 #ifdef RNA_RUNTIME
37
38 #include "DNA_scene_types.h"
39 #include "DNA_object_types.h"
40
41 #include "BKE_group.h"
42
43 #include "WM_api.h"
44 #include "WM_types.h"
45
46 static PointerRNA rna_Group_objects_get(CollectionPropertyIterator *iter)
47 {
48         ListBaseIterator *internal = iter->internal;
49
50         /* we are actually iterating a GroupObject list, so override get */
51         return rna_pointer_inherit_refine(&iter->parent, &RNA_Object, ((GroupObject*)internal->link)->ob);
52 }
53
54 static void rna_Group_objects_link(Group *group, bContext *C, ReportList *reports, Object *object)
55 {
56         if (!add_to_group(group, object, CTX_data_scene(C), NULL)) {
57                 BKE_reportf(reports, RPT_ERROR, "Object \"%s\" already in group \"%s\"", object->id.name+2, group->id.name+2);
58                 return;
59         }
60
61         WM_main_add_notifier(NC_OBJECT|ND_DRAW, &object->id);
62 }
63
64 static void rna_Group_objects_unlink(Group *group, bContext *C, ReportList *reports, Object *object)
65 {
66         if (!rem_from_group(group, object, CTX_data_scene(C), NULL)) {
67                 BKE_reportf(reports, RPT_ERROR, "Object \"%s\" not in group \"%s\"", object->id.name+2, group->id.name+2);
68                 return;
69         }
70
71         WM_main_add_notifier(NC_OBJECT|ND_DRAW, &object->id);
72 }
73
74 #else
75
76 /* group.objects */
77 static void rna_def_group_objects(BlenderRNA *brna, PropertyRNA *cprop)
78 {
79         StructRNA *srna;
80 /*      PropertyRNA *prop; */
81
82         FunctionRNA *func;
83         PropertyRNA *parm;
84         
85         RNA_def_property_srna(cprop, "GroupObjects");
86         srna = RNA_def_struct(brna, "GroupObjects", NULL);
87         RNA_def_struct_sdna(srna, "Group");
88         RNA_def_struct_ui_text(srna, "Group Objects", "Collection of group objects");
89
90         /* add object */
91         func = RNA_def_function(srna, "link", "rna_Group_objects_link");
92         RNA_def_function_flag(func, FUNC_USE_CONTEXT|FUNC_USE_REPORTS);
93         RNA_def_function_ui_description(func, "Add this object to a group");
94         /* object to add */
95         parm = RNA_def_pointer(func, "object", "Object", "", "Object to add");
96         RNA_def_property_flag(parm, PROP_REQUIRED|PROP_NEVER_NULL);
97
98         /* remove object */
99         func = RNA_def_function(srna, "unlink", "rna_Group_objects_unlink");
100         RNA_def_function_ui_description(func, "Remove this object to a group");
101         RNA_def_function_flag(func, FUNC_USE_CONTEXT|FUNC_USE_REPORTS);
102         /* object to remove */
103         parm = RNA_def_pointer(func, "object", "Object", "", "Object to remove");
104         RNA_def_property_flag(parm, PROP_REQUIRED);
105 }
106
107
108 void RNA_def_group(BlenderRNA *brna)
109 {
110         StructRNA *srna;
111         PropertyRNA *prop;
112
113         srna = RNA_def_struct(brna, "Group", "ID");
114         RNA_def_struct_ui_text(srna, "Group", "Group of Object datablocks");
115         RNA_def_struct_ui_icon(srna, ICON_GROUP);
116                 /* this is done on save/load in readfile.c, removed if no objects are in the group */
117         RNA_def_struct_clear_flag(srna, STRUCT_ID_REFCOUNT);
118
119         prop = RNA_def_property(srna, "dupli_offset", PROP_FLOAT, PROP_TRANSLATION);
120         RNA_def_property_float_sdna(prop, NULL, "dupli_ofs");
121         RNA_def_property_ui_text(prop, "Dupli Offset", "Offset from the origin to use when instancing as DupliGroup");
122         RNA_def_property_ui_range(prop, -10000.0, 10000.0, 10, RNA_TRANSLATION_PREC_DEFAULT);
123
124         prop = RNA_def_property(srna, "layers", PROP_BOOLEAN, PROP_LAYER);
125         RNA_def_property_boolean_sdna(prop, NULL, "layer", 1);
126         RNA_def_property_array(prop, 20);
127         RNA_def_property_ui_text(prop, "Dupli Layers", "Layers visible when this group is instanced as a dupli");
128
129
130         prop = RNA_def_property(srna, "objects", PROP_COLLECTION, PROP_NONE);
131         RNA_def_property_collection_sdna(prop, NULL, "gobject", NULL);
132         RNA_def_property_struct_type(prop, "Object");
133         RNA_def_property_ui_text(prop, "Objects", "A collection of this groups objects");
134         RNA_def_property_collection_funcs(prop, NULL, NULL, NULL, "rna_Group_objects_get", NULL, NULL, NULL, NULL);
135
136         rna_def_group_objects(brna, prop);
137
138 }
139
140 #endif