BKE_node_socket_value.hh

Go to the documentation of this file.

/* SPDX-FileCopyrightText: 2023 Blender Authors
 *
 * SPDX-License-Identifier: GPL-2.0-or-later */
 
#pragma once
 
#include "DNA_node_types.h"
 
#include "BLI_any.hh"
#include "BLI_cpp_type.hh"
#include "BLI_generic_pointer.hh"
 
namespace blender::bke {
 
class SocketValueVariant {
 private:
  enum class Kind {
    None,
    Single,
    Field,
    Grid,
  };
 
  Kind kind_ = Kind::None;
  eNodeSocketDatatype socket_type_;
  Any<void, 24> value_;
 
 public:
  SocketValueVariant() = default;
 
  template<typename T> explicit SocketValueVariant(T &&value);
 
  bool valid_for_socket(eNodeSocketDatatype socket_type) const;
 
  template<typename T> T extract();
 
  template<typename T> T get() const;
 
  template<typename T> void set(T &&value);
 
  bool is_context_dependent_field() const;
 
  bool is_volume_grid() const;
 
  void convert_to_single();
 
  GPointer get_single_ptr() const;
  GMutablePointer get_single_ptr();
 
  const void *get_single_ptr_raw() const;
 
  void store_single(eNodeSocketDatatype socket_type, const void *value);
 
  void *allocate_single(eNodeSocketDatatype socket_type);
 
  friend std::ostream &operator<<(std::ostream &stream, const SocketValueVariant &value_variant);
 
 private:
  template<typename T> void store_impl(T value);
};
 
template<typename T> inline SocketValueVariant::SocketValueVariant(T &&value)
{
  this->set(std::forward<T>(value));
}
 
template<typename T> inline void SocketValueVariant::set(T &&value)
{
  this->store_impl<std::decay_t<T>>(std::forward<T>(value));
}
 
inline const void *SocketValueVariant::get_single_ptr_raw() const
{
  BLI_assert(kind_ == Kind::Single);
  return value_.get();
}
 
}  // namespace blender::bke