doxygen: add newline after \file
[blender.git] / source / blender / depsgraph / intern / builder / deg_builder_rna.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) 2019 Blender Foundation.
17  * All rights reserved.
18  */
19
20 /** \file
21  * \ingroup depsgraph
22  */
23
24 #pragma once
25
26 #include "intern/node/deg_node.h"
27 #include "intern/node/deg_node_operation.h"
28
29 struct GHash;
30 struct ID;
31 struct PointerRNA;
32 struct PropertyRNA;
33
34 namespace DEG {
35
36 struct Depsgraph;
37 struct Node;
38 struct RNANodeQueryIDData;
39
40 /* For queries which gives operation node or key defines whether we are
41  * interested in a result of the given property or whether we are linking some
42  * dependency to that property. */
43 enum class RNAPointerSource {
44         /* Query will return pointer to an entry operation of component which is
45          * responsible for evaluation of the given property. */
46         ENTRY,
47         /* Query will return pointer to an exit operation of component which is
48          * responsible for evaluation of the given property.
49          * More precisely, it will return operation at which the property is known
50          * to be evaluated. */
51         EXIT,
52 };
53
54 /* A helper structure which wraps all fields needed to find a node inside of
55  * the dependency graph. */
56 class RNANodeIdentifier {
57 public:
58         RNANodeIdentifier();
59
60         /* Check whether this identifier is valid and usable. */
61         bool is_valid() const;
62
63         ID *id;
64         NodeType type;
65         const char *component_name;
66         OperationCode operation_code;
67         const char *operation_name;
68         int operation_name_tag;
69 };
70
71 /* Helper class which performs optimized lookups of a node within a given
72  * dependency graph which satisfies given RNA pointer or RAN path. */
73 class RNANodeQuery {
74 public:
75         RNANodeQuery(Depsgraph *depsgraph);
76         ~RNANodeQuery();
77
78         Node *find_node(const PointerRNA *ptr,
79                         const PropertyRNA *prop,
80                         RNAPointerSource source);
81
82 protected:
83         Depsgraph *depsgraph_;
84
85         /* Indexed by an ID, returns RNANodeQueryIDData associated with that ID. */
86         GHash *id_data_map_;
87
88         /* Construct identifier of the node which correspods given configuration
89          * of RNA property. */
90         RNANodeIdentifier construct_node_identifier(const PointerRNA *ptr,
91                                                     const PropertyRNA *prop,
92                                                     RNAPointerSource source);
93
94         /* Make sure ID data exists for the given ID, and returns it. */
95         RNANodeQueryIDData *ensure_id_data(const ID *id);
96 };
97
98 }  // namespace DEG