Merge branch 'master' into blender2.8
[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 #include "WM_types.h"
38
39 #ifdef RNA_RUNTIME
40
41 #include "DNA_scene_types.h"
42 #include "DNA_object_types.h"
43
44 #include "BKE_group.h"
45
46 #include "WM_api.h"
47
48 static PointerRNA rna_Group_objects_get(CollectionPropertyIterator *iter)
49 {
50         ListBaseIterator *internal = &iter->internal.listbase;
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, ReportList *reports, Object *object)
57 {
58         if (!BKE_group_object_add(group, object)) {
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, ReportList *reports, Object *object)
67 {
68         if (!BKE_group_object_unlink(group, object)) {
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_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_parameter_flags(parm, PROP_NEVER_NULL, PARM_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_REPORTS);
104         /* object to remove */
105         parm = RNA_def_pointer(func, "object", "Object", "", "Object to remove");
106         RNA_def_parameter_flags(parm, 0, PARM_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 data-blocks");
117         RNA_def_struct_ui_icon(srna, ICON_GROUP);
118         /* this is done on save/load in readfile.c, removed if no objects are in the group */
119         RNA_def_struct_clear_flag(srna, STRUCT_ID_REFCOUNT);
120
121         prop = RNA_def_property(srna, "dupli_offset", PROP_FLOAT, PROP_TRANSLATION);
122         RNA_def_property_float_sdna(prop, NULL, "dupli_ofs");
123         RNA_def_property_ui_text(prop, "Dupli Offset", "Offset from the origin to use when instancing as DupliGroup");
124         RNA_def_property_ui_range(prop, -10000.0, 10000.0, 10, RNA_TRANSLATION_PREC_DEFAULT);
125         RNA_def_property_update(prop, NC_OBJECT | ND_DRAW, NULL);
126
127         prop = RNA_def_property(srna, "layers", PROP_BOOLEAN, PROP_LAYER);
128         RNA_def_property_boolean_sdna(prop, NULL, "layer", 1);
129         RNA_def_property_array(prop, 20);
130         RNA_def_property_ui_text(prop, "Dupli Layers", "Layers visible when this group is instanced as a dupli");
131         RNA_def_property_update(prop, NC_OBJECT | ND_DRAW, NULL);
132
133         prop = RNA_def_property(srna, "objects", PROP_COLLECTION, PROP_NONE);
134         RNA_def_property_collection_sdna(prop, NULL, "gobject", NULL);
135         RNA_def_property_struct_type(prop, "Object");
136         RNA_def_property_ui_text(prop, "Objects", "A collection of this groups objects");
137         RNA_def_property_collection_funcs(prop, NULL, NULL, NULL, "rna_Group_objects_get", NULL, NULL, NULL, NULL);
138
139         rna_def_group_objects(brna, prop);
140
141 }
142
143 #endif