Depsgraph: Comb code to a better state all over
[blender.git] / source / blender / depsgraph / intern / node / 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/node/deg_node_id.h
28  *  \ingroup depsgraph
29  */
30
31 #pragma once
32
33 #include "intern/node/deg_node.h"
34 #include "BLI_sys_types.h"
35
36 namespace DEG {
37
38 struct ComponentNode;
39
40 typedef uint64_t IDComponentsMask;
41
42 /* NOTE: We use max comparison to mark an id node that is linked more than once
43  * So keep this enum ordered accordingly. */
44 enum eDepsNode_LinkedState_Type {
45         /* Generic indirectly linked id node. */
46         DEG_ID_LINKED_INDIRECTLY       = 0,
47         /* Id node present in the set (background) only. */
48         DEG_ID_LINKED_VIA_SET          = 1,
49         /* Id node directly linked via the SceneLayer. */
50         DEG_ID_LINKED_DIRECTLY         = 2,
51 };
52 const char *linkedStateAsString(eDepsNode_LinkedState_Type linked_state);
53
54 /* ID-Block Reference */
55 struct IDNode : public Node {
56         struct ComponentIDKey {
57                 ComponentIDKey(NodeType type, const char *name = "");
58                 bool operator==(const ComponentIDKey &other) const;
59
60                 NodeType type;
61                 const char *name;
62         };
63
64         virtual void init(const ID *id, const char *subdata) override;
65         void init_copy_on_write(ID *id_cow_hint = NULL);
66         ~IDNode();
67         void destroy();
68
69         virtual string identifier() const override;
70
71         ComponentNode *find_component(NodeType type,
72                                           const char *name = "") const;
73         ComponentNode *add_component(NodeType type,
74                                          const char *name = "");
75
76         virtual void tag_update(Depsgraph *graph, eUpdateSource source) override;
77
78         void finalize_build(Depsgraph *graph);
79
80         IDComponentsMask get_visible_components_mask() const;
81
82         /* ID Block referenced. */
83         ID *id_orig;
84         ID *id_cow;
85
86         /* Hash to make it faster to look up components. */
87         GHash *components;
88
89         /* Additional flags needed for scene evaluation.
90          * TODO(sergey): Only needed for until really granular updates
91          * of all the entities. */
92         uint32_t eval_flags;
93         uint32_t previous_eval_flags;
94
95         /* Extra customdata mask which needs to be evaluated for the mesh object. */
96         uint64_t customdata_mask;
97         uint64_t previous_customdata_mask;
98
99         eDepsNode_LinkedState_Type linked_state;
100
101         /* Indicates the datablock is visible in the evaluated scene. */
102         bool is_directly_visible;
103
104         /* For the collection type of ID, denotes whether collection was fully
105          * recursed into. */
106         bool is_collection_fully_expanded;
107
108         IDComponentsMask visible_components_mask;
109         IDComponentsMask previously_visible_components_mask;
110
111         DEG_DEPSNODE_DECLARE;
112 };
113
114 }  // namespace DEG