use bool for rna funcs.
[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 #include <stdlib.h>
28
29 #include "DNA_group_types.h"
30
31 #include "BLI_utildefines.h"
32
33 #include "RNA_define.h"
34
35 #include "rna_internal.h"
36
37 #ifdef RNA_RUNTIME
38
39 #include "DNA_scene_types.h"
40 #include "DNA_object_types.h"
41
42 #include "BKE_group.h"
43
44 #include "WM_api.h"
45 #include "WM_types.h"
46
47 static PointerRNA rna_Group_objects_get(CollectionPropertyIterator *iter)
48 {
49         ListBaseIterator *internal = iter->internal;
50
51         /* we are actually iterating a GroupObject list, so override get */
52         return rna_pointer_inherit_refine(&iter->parent, &RNA_Object, ((GroupObject *)internal->link)->ob);
53 }
54
55 static void rna_Group_objects_link(Group *group, bContext *C, ReportList *reports, Object *object)
56 {
57         if (!add_to_group(group, object, CTX_data_scene(C), NULL)) {
58                 BKE_reportf(reports, RPT_ERROR, "Object '%s' already in group '%s'", object->id.name + 2, group->id.name + 2);
59                 return;
60         }
61
62         WM_main_add_notifier(NC_OBJECT | ND_DRAW, &object->id);
63 }
64
65 static void rna_Group_objects_unlink(Group *group, bContext *C, ReportList *reports, Object *object)
66 {
67         if (!rem_from_group(group, object, CTX_data_scene(C), NULL)) {
68                 BKE_reportf(reports, RPT_ERROR, "Object '%s' not in group '%s'", object->id.name + 2, group->id.name + 2);
69                 return;
70         }
71
72         WM_main_add_notifier(NC_OBJECT | ND_DRAW, &object->id);
73 }
74
75 #else
76
77 /* group.objects */
78 static void rna_def_group_objects(BlenderRNA *brna, PropertyRNA *cprop)
79 {
80         StructRNA *srna;
81 /*      PropertyRNA *prop; */
82
83         FunctionRNA *func;
84         PropertyRNA *parm;
85         
86         RNA_def_property_srna(cprop, "GroupObjects");
87         srna = RNA_def_struct(brna, "GroupObjects", NULL);
88         RNA_def_struct_sdna(srna, "Group");
89         RNA_def_struct_ui_text(srna, "Group Objects", "Collection of group objects");
90
91         /* add object */
92         func = RNA_def_function(srna, "link", "rna_Group_objects_link");
93         RNA_def_function_flag(func, FUNC_USE_CONTEXT | FUNC_USE_REPORTS);
94         RNA_def_function_ui_description(func, "Add this object to a group");
95         /* object to add */
96         parm = RNA_def_pointer(func, "object", "Object", "", "Object to add");
97         RNA_def_property_flag(parm, PROP_REQUIRED | PROP_NEVER_NULL);
98
99         /* remove object */
100         func = RNA_def_function(srna, "unlink", "rna_Group_objects_unlink");
101         RNA_def_function_ui_description(func, "Remove this object to a group");
102         RNA_def_function_flag(func, FUNC_USE_CONTEXT | FUNC_USE_REPORTS);
103         /* object to remove */
104         parm = RNA_def_pointer(func, "object", "Object", "", "Object to remove");
105         RNA_def_property_flag(parm, PROP_REQUIRED);
106 }
107
108
109 void RNA_def_group(BlenderRNA *brna)
110 {
111         StructRNA *srna;
112         PropertyRNA *prop;
113
114         srna = RNA_def_struct(brna, "Group", "ID");
115         RNA_def_struct_ui_text(srna, "Group", "Group of Object datablocks");
116         RNA_def_struct_ui_icon(srna, ICON_GROUP);
117         /* this is done on save/load in readfile.c, removed if no objects are in the group */
118         RNA_def_struct_clear_flag(srna, STRUCT_ID_REFCOUNT);
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, RNA_TRANSLATION_PREC_DEFAULT);
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 group 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, NULL, NULL, NULL, "rna_Group_objects_get", NULL, NULL, NULL, NULL);
136
137         rna_def_group_objects(brna, prop);
138
139 }
140
141 #endif