COM_NodeOperationBuilder.h

Go to the documentation of this file.

/* SPDX-FileCopyrightText: 2013 Blender Authors
 *
 * SPDX-License-Identifier: GPL-2.0-or-later */
 
#pragma once
 
#include "BLI_map.hh"
#include "BLI_vector.hh"
 
#include "COM_NodeGraph.h"
 
namespace blender::compositor {
 
class CompositorContext;
 
class Node;
class NodeInput;
class NodeOutput;
 
class ExecutionSystem;
class NodeOperation;
class NodeOperationInput;
class NodeOperationOutput;
 
class PreviewOperation;
class ViewerOperation;
class ConstantOperation;
 
class NodeOperationBuilder {
 public:
  class Link {
   private:
    NodeOperationOutput *from_;
    NodeOperationInput *to_;
 
   public:
    Link(NodeOperationOutput *from, NodeOperationInput *to) : from_(from), to_(to) {}
 
    NodeOperationOutput *from() const
    {
      return from_;
    }
    NodeOperationInput *to() const
    {
      return to_;
    }
  };
 
 private:
  const CompositorContext *context_;
  NodeGraph graph_;
  ExecutionSystem *exec_system_;
 
  Vector<NodeOperation *> operations_;
  Vector<Link> links_;
 
  Map<NodeOperationInput *, NodeInput *> input_map_;
  Map<NodeOutput *, NodeOperationOutput *> output_map_;
 
  Node *current_node_;
 
  ViewerOperation *active_viewer_;
 
 public:
  NodeOperationBuilder(const CompositorContext *context,
                       bNodeTree *b_nodetree,
                       ExecutionSystem *system);
 
  const CompositorContext &context() const
  {
    return *context_;
  }
 
  void convert_to_operations(ExecutionSystem *system);
 
  void add_operation(NodeOperation *operation);
  void replace_operation_with_constant(NodeOperation *operation,
                                       ConstantOperation *constant_operation);
 
  void map_input_socket(NodeInput *node_socket, NodeOperationInput *operation_socket);
  void map_output_socket(NodeOutput *node_socket, NodeOperationOutput *operation_socket);
 
  void add_link(NodeOperationOutput *from, NodeOperationInput *to);
  void remove_input_link(NodeOperationInput *to);
 
  void add_preview(NodeOperationOutput *output);
  void add_node_input_preview(NodeInput *input);
 
  void register_viewer(ViewerOperation *viewer);
  ViewerOperation *active_viewer() const
  {
    return active_viewer_;
  }
 
  Span<NodeOperation *> get_operations() const
  {
    return operations_;
  }
 
  Span<Link> get_links() const
  {
    return links_;
  }
 
 protected:
  void add_datatype_conversions();
 
  void add_operation_input_constants();
  void add_input_constant_value(NodeOperationInput *input, const NodeInput *node_input);
 
  void resolve_proxies();
 
  void determine_canvases();
 
  Vector<NodeOperationInput *> cache_output_links(NodeOperationOutput *output) const;
 
  void prune_operations();
 
  void sort_operations();
 
 private:
  PreviewOperation *make_preview_operation() const;
  void unlink_inputs_and_relink_outputs(NodeOperation *unlinked_op, NodeOperation *linked_op);
  void merge_equal_operations();
  void merge_equal_operations(NodeOperation *from, NodeOperation *into);
  void save_graphviz(StringRefNull name = "");
#ifdef WITH_CXX_GUARDEDALLOC
  MEM_CXX_CLASS_ALLOC_FUNCS("COM:NodeCompilerImpl")
#endif
};
 
std::ostream &operator<<(std::ostream &os, const NodeOperationBuilder &builder);
std::ostream &operator<<(std::ostream &os, const NodeOperationBuilder::Link &link);
 
}  // namespace blender::compositor