[Bf-blender-cvs] [e1cc9aa7f28] master: Nodes: efficient node tree queries and inlining
Jacques Lucke
noreply at git.blender.org
Tue Jun 9 17:12:52 CEST 2020
Commit: e1cc9aa7f2813004cad34a580e2faa1b7ca21db1
Author: Jacques Lucke
Date: Tue Jun 9 17:08:41 2020 +0200
Branches: master
https://developer.blender.org/rBe1cc9aa7f2813004cad34a580e2faa1b7ca21db1
Nodes: efficient node tree queries and inlining
This adds two data structures that wrap a node tree. However, they work
on different abstraction levels.
`NodeTreeRef` is an immutable structure that makes working with a node
tree in C++ much more efficient and convenient. It supports various
queries efficiently, that are not easily possible using just `bNodeTree`.
`DerivedNodeTree` builds on top of `NodeTreeRef`. It contains a flattened
view on the node tree, i.e. with node groups being inlined. Every inlined
node still knows its "call stack". It supports pretty much the same queries
as `NodeTreeRef`.
Both data structures come with a dot graph exporter for debugging purposes.
Reviewers: brecht
Differential Revision: https://developer.blender.org/D7628
===================================================================
A source/blender/blenkernel/BKE_derived_node_tree.hh
A source/blender/blenkernel/BKE_node_tree_ref.hh
M source/blender/blenkernel/CMakeLists.txt
A source/blender/blenkernel/intern/derived_node_tree.cc
A source/blender/blenkernel/intern/node_tree_ref.cc
===================================================================
diff --git a/source/blender/blenkernel/BKE_derived_node_tree.hh b/source/blender/blenkernel/BKE_derived_node_tree.hh
new file mode 100644
index 00000000000..009d9b747f9
--- /dev/null
+++ b/source/blender/blenkernel/BKE_derived_node_tree.hh
@@ -0,0 +1,453 @@
+/*
+ * This program is free software; you can redistribute it and/or
+ * modify it under the terms of the GNU General Public License
+ * as published by the Free Software Foundation; either version 2
+ * of the License, or (at your option) any later version.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+ * GNU General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public License
+ * along with this program; if not, write to the Free Software Foundation,
+ * Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
+ */
+
+#ifndef __BKE_DERIVED_NODE_TREE_HH__
+#define __BKE_DERIVED_NODE_TREE_HH__
+
+/** \file
+ * \ingroup bke
+ *
+ * DerivedNodeTree provides a flattened view on a bNodeTree, i.e. node groups are inlined. It
+ * builds on top of NodeTreeRef and supports similar queries efficiently.
+ *
+ * Every inlined node remembers its path to the parent ("call stack").
+ *
+ * Unlinked group node inputs are handled separately from other sockets.
+ *
+ * There is a dot graph exporter for debugging purposes.
+ */
+
+#include "BKE_node_tree_ref.hh"
+
+namespace BKE {
+
+class DSocket;
+class DInputSocket;
+class DOutputSocket;
+class DNode;
+class DParentNode;
+class DGroupInput;
+class DerivedNodeTree;
+
+class DSocket : blender::NonCopyable, blender::NonMovable {
+ protected:
+ DNode *m_node;
+ const SocketRef *m_socket_ref;
+ uint m_id;
+
+ friend DerivedNodeTree;
+
+ public:
+ const DNode &node() const;
+
+ uint id() const;
+ uint index() const;
+
+ bool is_input() const;
+ bool is_output() const;
+
+ const DSocket &as_base() const;
+ const DInputSocket &as_input() const;
+ const DOutputSocket &as_output() const;
+
+ PointerRNA *rna() const;
+ StringRefNull idname() const;
+ StringRefNull name() const;
+};
+
+class DInputSocket : public DSocket {
+ private:
+ Vector<DOutputSocket *> m_linked_sockets;
+ Vector<DGroupInput *> m_linked_group_inputs;
+
+ friend DerivedNodeTree;
+
+ public:
+ const InputSocketRef &socket_ref() const;
+
+ Span<const DOutputSocket *> linked_sockets() const;
+ Span<const DGroupInput *> linked_group_inputs() const;
+
+ bool is_linked() const;
+};
+
+class DOutputSocket : public DSocket {
+ private:
+ Vector<DInputSocket *> m_linked_sockets;
+
+ friend DerivedNodeTree;
+
+ public:
+ const OutputSocketRef &socket_ref() const;
+ Span<const DInputSocket *> linked_sockets() const;
+};
+
+class DGroupInput : blender::NonCopyable, blender::NonMovable {
+ private:
+ const InputSocketRef *m_socket_ref;
+ DParentNode *m_parent;
+ Vector<DInputSocket *> m_linked_sockets;
+ uint m_id;
+
+ friend DerivedNodeTree;
+
+ public:
+ const InputSocketRef &socket_ref() const;
+ const DParentNode *parent() const;
+ Span<const DInputSocket *> linked_sockets() const;
+ uint id() const;
+ StringRefNull name() const;
+};
+
+class DNode : blender::NonCopyable, blender::NonMovable {
+ private:
+ const NodeRef *m_node_ref;
+ DParentNode *m_parent;
+
+ Span<DInputSocket *> m_inputs;
+ Span<DOutputSocket *> m_outputs;
+
+ uint m_id;
+
+ friend DerivedNodeTree;
+
+ public:
+ const NodeRef &node_ref() const;
+ const DParentNode *parent() const;
+
+ Span<const DInputSocket *> inputs() const;
+ Span<const DOutputSocket *> outputs() const;
+
+ const DInputSocket &input(uint index) const;
+ const DOutputSocket &output(uint index) const;
+
+ uint id() const;
+
+ PointerRNA *rna() const;
+ StringRefNull idname() const;
+ StringRefNull name() const;
+
+ private:
+ void destruct_with_sockets();
+};
+
+class DParentNode : blender::NonCopyable, blender::NonMovable {
+ private:
+ const NodeRef *m_node_ref;
+ DParentNode *m_parent;
+ uint m_id;
+
+ friend DerivedNodeTree;
+
+ public:
+ const DParentNode *parent() const;
+ const NodeRef &node_ref() const;
+ uint id() const;
+};
+
+using NodeTreeRefMap = Map<bNodeTree *, std::unique_ptr<const NodeTreeRef>>;
+
+class DerivedNodeTree : blender::NonCopyable, blender::NonMovable {
+ private:
+ LinearAllocator<> m_allocator;
+ bNodeTree *m_btree;
+ Vector<DNode *> m_nodes_by_id;
+ Vector<DGroupInput *> m_group_inputs;
+ Vector<DParentNode *> m_parent_nodes;
+
+ Vector<DSocket *> m_sockets_by_id;
+ Vector<DInputSocket *> m_input_sockets;
+ Vector<DOutputSocket *> m_output_sockets;
+
+ Map<std::string, Vector<DNode *>> m_nodes_by_idname;
+
+ public:
+ DerivedNodeTree(bNodeTree *btree, NodeTreeRefMap &node_tree_refs);
+ ~DerivedNodeTree();
+
+ Span<const DNode *> nodes() const;
+ Span<const DNode *> nodes_with_idname(StringRef idname) const;
+
+ Span<const DSocket *> sockets() const;
+ Span<const DInputSocket *> input_sockets() const;
+ Span<const DOutputSocket *> output_sockets() const;
+
+ std::string to_dot() const;
+
+ private:
+ /* Utility functions used during construction. */
+ void insert_nodes_and_links_in_id_order(const NodeTreeRef &tree_ref,
+ DParentNode *parent,
+ Vector<DNode *> &all_nodes);
+ DNode &create_node(const NodeRef &node_ref,
+ DParentNode *parent,
+ MutableSpan<DSocket *> r_sockets_map);
+ void expand_groups(Vector<DNode *> &all_nodes,
+ Vector<DGroupInput *> &all_group_inputs,
+ Vector<DParentNode *> &all_parent_nodes,
+ NodeTreeRefMap &node_tree_refs);
+ void expand_group_node(DNode &group_node,
+ Vector<DNode *> &all_nodes,
+ Vector<DGroupInput *> &all_group_inputs,
+ Vector<DParentNode *> &all_parent_nodes,
+ NodeTreeRefMap &node_tree_refs);
+ void create_group_inputs_for_unlinked_inputs(DNode &node,
+ Vector<DGroupInput *> &all_group_inputs);
+ void relink_group_inputs(const NodeTreeRef &group_ref,
+ Span<DNode *> nodes_by_id,
+ DNode &group_node);
+ void relink_group_outputs(const NodeTreeRef &group_ref,
+ Span<DNode *> nodes_by_id,
+ DNode &group_node);
+ void remove_expanded_group_interfaces(Vector<DNode *> &all_nodes);
+ void remove_unused_group_inputs(Vector<DGroupInput *> &all_group_inputs);
+ void store_in_this_and_init_ids(Vector<DNode *> &&all_nodes,
+ Vector<DGroupInput *> &&all_group_inputs,
+ Vector<DParentNode *> &&all_parent_nodes);
+};
+
+/* --------------------------------------------------------------------
+ * DSocket inline methods.
+ */
+
+inline const DNode &DSocket::node() const
+{
+ return *m_node;
+}
+
+inline uint DSocket::id() const
+{
+ return m_id;
+}
+
+inline uint DSocket::index() const
+{
+ return m_socket_ref->index();
+}
+
+inline bool DSocket::is_input() const
+{
+ return m_socket_ref->is_input();
+}
+
+inline bool DSocket::is_output() const
+{
+ return m_socket_ref->is_output();
+}
+
+inline const DSocket &DSocket::as_base() const
+{
+ return *this;
+}
+
+inline const DInputSocket &DSocket::as_input() const
+{
+ return *(DInputSocket *)this;
+}
+
+inline const DOutputSocket &DSocket::as_output() const
+{
+ return *(DOutputSocket *)this;
+}
+
+inline PointerRNA *DSocket::rna() const
+{
+ return m_socket_ref->rna();
+}
+
+inline StringRefNull DSocket::idname() const
+{
+ return m_socket_ref->idname();
+}
+
+inline StringRefNull DSocket::name() const
+{
+ return m_socket_ref->name();
+}
+
+/* --------------------------------------------------------------------
+ * DInputSocket inline methods.
+ */
+
+inline const InputSocketRef &DInputSocket::socket_ref() const
+{
+ return m_socket_ref->as_input();
+}
+
+inline Span<const DOutputSocket *> DInputSocket::linked_sockets() const
+{
+ return m_linked_sockets.as_span();
+}
+
+inline Span<const DGroupInput *> DInputSocket::linked_group_inputs() const
+{
+ return m_linked_group_inputs.as_span();
+}
+
+inline bool DInputSocket::is_linked() const
+{
+ return m_linked_sockets.size() > 0 || m_linked_group_inputs.size() > 0;
+}
+
+/* --------------------------------------------------------------------
+ * DOutputSocket inline methods.
+ */
+
+inline const OutputSocketRef &DOutputSocket::socket_ref() const
+{
+ return m_socket_ref->as_output();
+}
+
+inline Span<const DInputSocket *> DOutputSocket::linked_sockets() const
+{
+ return m_linked_sockets.as_span();
+}
+
+/* --------------------------------------------------------------------
+ * DGroupInput inline methods.
+ */
+
+inline const InputSocketRef &DGroupInput::socket_ref() const
+{
+ return *m_socket_ref;
+}
+
+inline const DParentNode *DGroupInput::parent() const
+{
+ return m_parent;
+}
+
+inline Span<const DInputSocket *> DGroupInput::linked_sockets() const
+{
+ return m_linked_sockets.as_span();
+}
+
+inline uint DGroupInput::id() const
+{
+ return m_id;
+}
+
+inline StringRefNull DGroupInput::name() const
+{
+ return m_socket_ref->name();
+}
+
+/* --------------------------------------------------------------------
+ * DNode inline methods.
+ */
+
+inline const NodeRef &DNode::node_ref() const
+{
+ return *m_node_ref;
+}
+
+inline const DParentNode *DNode::parent() const
+{
+ return m_parent;
+}
+
+inline Span<const DInputSocket *> DNode::inputs() const
+{
+ return m_inputs;
+}
+
+inline Span<const DOutputSocket *> DNode::outputs() const
+{
+ return m_outputs;
+}
+
+inline const DInputSocket &DNode::input(uint index) const
+{
+ return *m_inputs[index];
+}
+
+inline const DOutputSocket &DNode::output(uint index) const
+{
+ return *m_outputs[index];
+}
+
+inline uint DNode::id() const
+{
+ return m_id;
+}
+
+inline PointerRNA *DNode::rna() const
+{
+ return m_node_ref->rna();
+}
+
+inline StringRef
@@ Diff output truncated at 10240 characters. @@
More information about the Bf-blender-cvs
mailing list