Merge branch 'master' into blender2.8
[blender.git] / source / blender / depsgraph / intern / nodes / deg_node_id.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) 2013 Blender Foundation.
19  * All rights reserved.
20  *
21  * Original Author: Joshua Leung
22  * Contributor(s): None Yet
23  *
24  * ***** END GPL LICENSE BLOCK *****
25  */
26
27 /** \file depsgraph/intern/nodes/deg_node_id.h
28  *  \ingroup depsgraph
29  */
30
31 #pragma once
32
33 #include "intern/nodes/deg_node.h"
34
35 namespace DEG {
36
37 struct ComponentDepsNode;
38
39 /* ID-Block Reference */
40 struct IDDepsNode : public DepsNode {
41         struct ComponentIDKey {
42                 ComponentIDKey(eDepsNode_Type type, const char *name = "");
43                 bool operator==(const ComponentIDKey &other) const;
44
45                 eDepsNode_Type type;
46                 const char *name;
47         };
48
49         void init(const ID *id, const char *subdata);
50         void init_copy_on_write(ID *id_cow_hint = NULL);
51         ~IDDepsNode();
52         void destroy();
53
54         ComponentDepsNode *find_component(eDepsNode_Type type,
55                                           const char *name = "") const;
56         ComponentDepsNode *add_component(eDepsNode_Type type,
57                                          const char *name = "");
58
59         void tag_update(Depsgraph *graph);
60
61         void finalize_build(Depsgraph *graph);
62
63         /* ID Block referenced. */
64         ID *id_orig;
65         ID *id_cow;
66
67         /* Hash to make it faster to look up components. */
68         GHash *components;
69
70         /* Additional flags needed for scene evaluation.
71          * TODO(sergey): Only needed for until really granular updates
72          * of all the entities.
73          */
74         int eval_flags;
75
76         eDepsNode_LinkedState_Type linked_state;
77
78         DEG_DEPSNODE_DECLARE;
79 };
80
81 }  // namespace DEG