Depsgraph: Remove confusing declaration of node method
[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                 eDepsNode_Type type;
56                 const char *tname;
57                 int id_recalc_tag;
58         };
59         /* Relationships between nodes
60          * The reason why all depsgraph nodes are descended from this type (apart
61          * from basic serialization benefits - from the typeinfo) is that we can have
62          * relationships between these nodes!
63          */
64         typedef vector<DepsRelation *> Relations;
65
66         const char *name;     /* Identifier - mainly for debugging purposes. */
67         eDepsNode_Type type;  /* Structural type of node. */
68         Relations inlinks;    /* Nodes which this one depends on. */
69         Relations outlinks;   /* Nodes which depend on this one. */
70         int done;    /* Generic tags for traversal algorithms. */
71
72         /* Methods. */
73         DepsNode();
74         virtual ~DepsNode();
75
76         virtual string identifier() const;
77
78         virtual void init(const ID * /*id*/,
79                           const char * /*subdata*/) {}
80
81         virtual void tag_update(Depsgraph * /*graph*/) {}
82
83         virtual OperationDepsNode *get_entry_operation() { return NULL; }
84         virtual OperationDepsNode *get_exit_operation() { return NULL; }
85
86         virtual eDepsNode_Class get_class() const;
87 };
88
89 /* Macros for common static typeinfo. */
90 #define DEG_DEPSNODE_DECLARE \
91         static const DepsNode::TypeInfo typeinfo
92 #define DEG_DEPSNODE_DEFINE(NodeType, type_, tname_) \
93         const DepsNode::TypeInfo NodeType::typeinfo = DepsNode::TypeInfo(type_, tname_)
94
95 void deg_register_base_depsnodes();
96
97 }  // namespace DEG