BKE_compute_contexts.hh

Go to the documentation of this file.

/* SPDX-FileCopyrightText: 2023 Blender Authors
 *
 * SPDX-License-Identifier: GPL-2.0-or-later */
 
#pragma once
 
#include <optional>
 
#include "BLI_compute_context.hh"
 
struct bNode;
struct bNodeTree;
 
namespace blender::bke {
 
class ModifierComputeContext : public ComputeContext {
 private:
  static constexpr const char *s_static_type = "MODIFIER";
 
  std::string modifier_name_;
 
 public:
  ModifierComputeContext(const ComputeContext *parent, std::string modifier_name);
 
  StringRefNull modifier_name() const
  {
    return modifier_name_;
  }
 
 private:
  void print_current_in_line(std::ostream &stream) const override;
};
 
class GroupNodeComputeContext : public ComputeContext {
 private:
  static constexpr const char *s_static_type = "NODE_GROUP";
 
  int32_t node_id_;
  const bNodeTree *caller_tree_ = nullptr;
  const bNode *caller_group_node_ = nullptr;
 
 public:
  GroupNodeComputeContext(const ComputeContext *parent,
                          int32_t node_id,
                          const std::optional<ComputeContextHash> &cached_hash = {});
  GroupNodeComputeContext(const ComputeContext *parent,
                          const bNode &node,
                          const bNodeTree &caller_tree);
 
  int32_t node_id() const
  {
    return node_id_;
  }
 
  const bNode *caller_group_node() const
  {
    return caller_group_node_;
  }
 
  const bNodeTree *caller_tree() const
  {
    return caller_tree_;
  }
 
 private:
  void print_current_in_line(std::ostream &stream) const override;
};
 
class SimulationZoneComputeContext : public ComputeContext {
 private:
  static constexpr const char *s_static_type = "SIMULATION_ZONE";
 
  int32_t output_node_id_;
 
 public:
  SimulationZoneComputeContext(const ComputeContext *parent, int output_node_id);
  SimulationZoneComputeContext(const ComputeContext *parent, const bNode &node);
 
  int32_t output_node_id() const
  {
    return output_node_id_;
  }
 
 private:
  void print_current_in_line(std::ostream &stream) const override;
};
 
class RepeatZoneComputeContext : public ComputeContext {
 private:
  static constexpr const char *s_static_type = "REPEAT_ZONE";
 
  int32_t output_node_id_;
  int iteration_;
 
 public:
  RepeatZoneComputeContext(const ComputeContext *parent, int32_t output_node_id, int iteration);
  RepeatZoneComputeContext(const ComputeContext *parent, const bNode &node, int iteration);
 
  int32_t output_node_id() const
  {
    return output_node_id_;
  }
 
  int iteration() const
  {
    return iteration_;
  }
 
 private:
  void print_current_in_line(std::ostream &stream) const override;
};
 
class ForeachGeometryElementZoneComputeContext : public ComputeContext {
 private:
  static constexpr const char *s_static_type = "FOREACH_GEOMETRY_ELEMENT_ZONE";
 
  int32_t output_node_id_;
  int index_;
 
 public:
  ForeachGeometryElementZoneComputeContext(const ComputeContext *parent,
                                           int32_t output_node_id,
                                           int index);
  ForeachGeometryElementZoneComputeContext(const ComputeContext *parent,
                                           const bNode &node,
                                           int index);
 
  int32_t output_node_id() const
  {
    return output_node_id_;
  }
 
  int index() const
  {
    return index_;
  }
 
 private:
  void print_current_in_line(std::ostream &stream) const override;
};
 
class OperatorComputeContext : public ComputeContext {
 private:
  static constexpr const char *s_static_type = "OPERATOR";
 
 public:
  OperatorComputeContext();
  OperatorComputeContext(const ComputeContext *parent);
 
 private:
  void print_current_in_line(std::ostream &stream) const override;
};
 
}  // namespace blender::bke