c845233d1c
This struct is currently defined in the `functions` module but not actually used there. It's only used by the geometry nodes module, with an indirect dependency from blenkernel via simulation zone baking. This scope is problematic when adding grids as socket data, which should not be part of the functions module. The `ValueOrField` struct is now moved to blenkernel, so it can be more easily extended to other kinds of data that might be passed around by geometry nodes sockets in future. No functional changes. Pull Request: https://projects.blender.org/blender/blender/pulls/115087
71 lines
1.4 KiB
C++
71 lines
1.4 KiB
C++
/* SPDX-FileCopyrightText: 2023 Blender Authors
|
|
*
|
|
* SPDX-License-Identifier: GPL-2.0-or-later */
|
|
|
|
/** \file
|
|
* \ingroup bke
|
|
*/
|
|
|
|
#pragma once
|
|
|
|
#include "FN_field.hh"
|
|
|
|
namespace blender::bke {
|
|
|
|
/* -------------------------------------------------------------------- */
|
|
/** \name Value or Field Class
|
|
*
|
|
* Utility class that wraps a single value and a field, to simplify accessing both of the types.
|
|
* \{ */
|
|
|
|
template<typename T> struct ValueOrField {
|
|
using Field = fn::Field<T>;
|
|
|
|
/** Value that is used when the field is empty. */
|
|
T value{};
|
|
Field field;
|
|
|
|
ValueOrField() = default;
|
|
|
|
ValueOrField(T value) : value(std::move(value)) {}
|
|
|
|
ValueOrField(Field field) : field(std::move(field)) {}
|
|
|
|
bool is_field() const
|
|
{
|
|
return bool(this->field);
|
|
}
|
|
|
|
Field as_field() const
|
|
{
|
|
if (this->field) {
|
|
return this->field;
|
|
}
|
|
return fn::make_constant_field(this->value);
|
|
}
|
|
|
|
T as_value() const
|
|
{
|
|
if (this->field) {
|
|
/* This returns a default value when the field is not constant. */
|
|
return fn::evaluate_constant_field(this->field);
|
|
}
|
|
return this->value;
|
|
}
|
|
|
|
friend std::ostream &operator<<(std::ostream &stream, const ValueOrField<T> &value_or_field)
|
|
{
|
|
if (value_or_field.field) {
|
|
stream << "ValueOrField<T>";
|
|
}
|
|
else {
|
|
stream << value_or_field.value;
|
|
}
|
|
return stream;
|
|
}
|
|
};
|
|
|
|
/** \} */
|
|
|
|
} // namespace blender::bke
|