Cleanup: remove redundant doxygen \file argument
[blender.git] / source / blender / depsgraph / intern / node / deg_node_id.h
1 /*
2  * This program is free software; you can redistribute it and/or
3  * modify it under the terms of the GNU General Public License
4  * as published by the Free Software Foundation; either version 2
5  * of the License, or (at your option) any later version.
6  *
7  * This program is distributed in the hope that it will be useful,
8  * but WITHOUT ANY WARRANTY; without even the implied warranty of
9  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
10  * GNU General Public License for more details.
11  *
12  * You should have received a copy of the GNU General Public License
13  * along with this program; if not, write to the Free Software Foundation,
14  * Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
15  *
16  * The Original Code is Copyright (C) 2013 Blender Foundation.
17  * All rights reserved.
18  */
19
20 /** \file \ingroup depsgraph
21  */
22
23 #pragma once
24
25 #include "intern/node/deg_node.h"
26 #include "BLI_sys_types.h"
27
28 namespace DEG {
29
30 struct ComponentNode;
31
32 typedef uint64_t IDComponentsMask;
33
34 /* NOTE: We use max comparison to mark an id node that is linked more than once
35  * So keep this enum ordered accordingly. */
36 enum eDepsNode_LinkedState_Type {
37         /* Generic indirectly linked id node. */
38         DEG_ID_LINKED_INDIRECTLY       = 0,
39         /* Id node present in the set (background) only. */
40         DEG_ID_LINKED_VIA_SET          = 1,
41         /* Id node directly linked via the SceneLayer. */
42         DEG_ID_LINKED_DIRECTLY         = 2,
43 };
44 const char *linkedStateAsString(eDepsNode_LinkedState_Type linked_state);
45
46 /* ID-Block Reference */
47 struct IDNode : public Node {
48         struct ComponentIDKey {
49                 ComponentIDKey(NodeType type, const char *name = "");
50                 bool operator==(const ComponentIDKey &other) const;
51
52                 NodeType type;
53                 const char *name;
54         };
55
56         virtual void init(const ID *id, const char *subdata) override;
57         void init_copy_on_write(ID *id_cow_hint = NULL);
58         ~IDNode();
59         void destroy();
60
61         virtual string identifier() const override;
62
63         ComponentNode *find_component(NodeType type,
64                                           const char *name = "") const;
65         ComponentNode *add_component(NodeType type,
66                                          const char *name = "");
67
68         virtual void tag_update(Depsgraph *graph, eUpdateSource source) override;
69
70         void finalize_build(Depsgraph *graph);
71
72         IDComponentsMask get_visible_components_mask() const;
73
74         /* ID Block referenced. */
75         ID *id_orig;
76         ID *id_cow;
77
78         /* Hash to make it faster to look up components. */
79         GHash *components;
80
81         /* Additional flags needed for scene evaluation.
82          * TODO(sergey): Only needed for until really granular updates
83          * of all the entities. */
84         uint32_t eval_flags;
85         uint32_t previous_eval_flags;
86
87         /* Extra customdata mask which needs to be evaluated for the mesh object. */
88         uint64_t customdata_mask;
89         uint64_t previous_customdata_mask;
90
91         eDepsNode_LinkedState_Type linked_state;
92
93         /* Indicates the datablock is visible in the evaluated scene. */
94         bool is_directly_visible;
95
96         /* For the collection type of ID, denotes whether collection was fully
97          * recursed into. */
98         bool is_collection_fully_expanded;
99
100         IDComponentsMask visible_components_mask;
101         IDComponentsMask previously_visible_components_mask;
102
103         DEG_DEPSNODE_DECLARE;
104 };
105
106 }  // namespace DEG