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