Merge branch 'master' into blender2.8
[blender.git] / source / blender / depsgraph / intern / nodes / deg_node.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.h
28  *  \ingroup depsgraph
29  */
30
31 #pragma once
32
33 #include "intern/depsgraph_types.h"
34
35 #include "BLI_utildefines.h"
36
37 struct ID;
38 struct GHash;
39 struct Scene;
40
41 namespace DEG {
42
43 struct Depsgraph;
44 struct DepsRelation;
45 struct OperationDepsNode;
46
47 /* *********************************** */
48 /* Base-Defines for Nodes in Depsgraph */
49
50 /* All nodes in Depsgraph are descended from this. */
51 struct DepsNode {
52         /* Helper class for static typeinfo in subclasses. */
53         struct TypeInfo {
54                 TypeInfo(eDepsNode_Type type, const char *tname, int id_recalc_tag = 0);
55
56                 eDepsNode_Type type;
57                 eDepsNode_Class tclass;
58                 const char *tname;
59
60                 int id_recalc_tag;
61         };
62
63         /* Identifier - mainly for debugging purposes. */
64         const char *name;
65
66         /* Structural type of node. */
67         eDepsNode_Type type;
68
69         /* Type of data/behaviour represented by node... */
70         eDepsNode_Class tclass;
71
72         /* Relationships between nodes
73          * The reason why all depsgraph nodes are descended from this type (apart
74          * from basic serialization benefits - from the typeinfo) is that we can have
75          * relationships between these nodes!
76          */
77         typedef vector<DepsRelation *> Relations;
78
79         /* Nodes which this one depends on. */
80         Relations inlinks;
81
82         /* Nodes which depend on this one. */
83         Relations outlinks;
84
85         /* Generic tags for traversal algorithms. */
86         int done;
87         int tag;
88
89         /* Methods. */
90
91         DepsNode();
92         virtual ~DepsNode();
93
94         virtual string identifier() const;
95         string full_identifier() const;
96
97         virtual void init(const ID * /*id*/,
98                           const char * /*subdata*/) {}
99
100         virtual void tag_update(Depsgraph * /*graph*/) {}
101
102         virtual OperationDepsNode *get_entry_operation() { return NULL; }
103         virtual OperationDepsNode *get_exit_operation() { return NULL; }
104 };
105
106 /* Macros for common static typeinfo. */
107 #define DEG_DEPSNODE_DECLARE \
108         static const DepsNode::TypeInfo typeinfo
109 #define DEG_DEPSNODE_DEFINE(NodeType, type_, tname_) \
110         const DepsNode::TypeInfo NodeType::typeinfo = DepsNode::TypeInfo(type_, tname_)
111
112 /* Generic Nodes ======================= */
113
114 struct ComponentDepsNode;
115 struct IDDepsNode;
116
117 /* Time Source Node. */
118 struct TimeSourceDepsNode : public DepsNode {
119         /* New "current time". */
120         float cfra;
121
122         /* time-offset relative to the "official" time source that this one has. */
123         float offset;
124
125         // TODO: evaluate() operation needed
126
127         void tag_update(Depsgraph *graph);
128
129         DEG_DEPSNODE_DECLARE;
130 };
131
132 /* ID-Block Reference */
133 struct IDDepsNode : public DepsNode {
134         struct ComponentIDKey {
135                 ComponentIDKey(eDepsNode_Type type, const char *name = "");
136                 bool operator==(const ComponentIDKey &other) const;
137
138                 eDepsNode_Type type;
139                 const char *name;
140         };
141
142         void init(const ID *id, const char *subdata);
143         void init_copy_on_write(ID *id_cow_hint = NULL);
144         ~IDDepsNode();
145         void destroy();
146
147         ComponentDepsNode *find_component(eDepsNode_Type type,
148                                           const char *name = "") const;
149         ComponentDepsNode *add_component(eDepsNode_Type type,
150                                          const char *name = "");
151
152         void tag_update(Depsgraph *graph);
153
154         void finalize_build(Depsgraph *graph);
155
156         /* ID Block referenced. */
157         ID *id_orig;
158         ID *id_cow;
159
160         /* Hash to make it faster to look up components. */
161         GHash *components;
162
163         /* Additional flags needed for scene evaluation.
164          * TODO(sergey): Only needed for until really granular updates
165          * of all the entities.
166          */
167         int eval_flags;
168
169         eDepsNode_LinkedState_Type linked_state;
170
171         DEG_DEPSNODE_DECLARE;
172 };
173
174 void deg_register_base_depsnodes();
175
176 }  // namespace DEG