Depsgraph: remove EvaluationContext, pass Depsgraph instead.
[blender.git] / source / blender / blenkernel / BKE_group.h
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  * The Original Code is Copyright (C) 2001-2002 by NaN Holding BV.
19  * All rights reserved.
20  *
21  * The Original Code is: all of this file.
22  *
23  * Contributor(s): none yet.
24  *
25  * ***** END GPL LICENSE BLOCK *****
26  */
27 #ifndef __BKE_GROUP_H__
28 #define __BKE_GROUP_H__
29
30 /** \file BKE_group.h
31  *  \ingroup bke
32  *  \since March 2001
33  *  \author nzc
34  */
35
36 struct Base;
37 struct Depsgraph;
38 struct Group;
39 struct Main;
40 struct Object;
41 struct Scene;
42
43 void          BKE_group_free(struct Group *group);
44 void          BKE_group_init(struct Group *group);
45 struct Group *BKE_group_add(struct Main *bmain, const char *name);
46 void          BKE_group_copy_data(struct Main *bmain, struct Group *group_dst, const struct Group *group_src, const int flag);
47 struct Group *BKE_group_copy(struct Main *bmain, const struct Group *group);
48 void          BKE_group_make_local(struct Main *bmain, struct Group *group, const bool lib_local);
49 bool          BKE_group_object_add(struct Group *group, struct Object *ob);
50 bool          BKE_group_object_unlink(struct Group *group, struct Object *ob);
51 struct Group *BKE_group_object_find(struct Group *group, struct Object *ob);
52 bool          BKE_group_object_exists(struct Group *group, struct Object *ob);
53 bool          BKE_group_object_cyclic_check(struct Main *bmain, struct Object *object, struct Group *group);
54 bool          BKE_group_is_animated(struct Group *group, struct Object *parent);
55
56 void          BKE_group_handle_recalc_and_update(struct Depsgraph *depsgraph, struct Scene *scene, struct Object *parent, struct Group *group);
57
58 /* Dependency graph evaluation. */
59
60 void BKE_group_eval_view_layers(struct Depsgraph *depsgraph,
61                                 struct Group *group);
62
63 /* Helper macros. */
64
65 #define FOREACH_GROUP_BASE_BEGIN(_group, _base)                   \
66         for (Base *_base = (Base *)(_group)->view_layer->object_bases.first; \
67              _base;                                                   \
68              _base = _base->next)                                     \
69         {
70
71 #define FOREACH_GROUP_BASE_END                                    \
72         }
73
74 #define FOREACH_GROUP_OBJECT_BEGIN(_group, _object)               \
75         for (Base *_base = (Base *)(_group)->view_layer->object_bases.first; \
76              _base;                                                   \
77              _base = _base->next)                                     \
78         {                                                             \
79                 Object *_object = _base->object;                          \
80                 BLI_assert(_object != NULL);
81
82 #define FOREACH_GROUP_OBJECT_END                                  \
83         } ((void)0)
84
85 #endif  /* __BKE_GROUP_H__ */