 |
Blender V5.0
|
|
Blender V5.0
|
#include <BKE_node_socket_value.hh>
Public Member Functions | |
| SocketValueVariant ()=default | |
| SocketValueVariant (const SocketValueVariant &other)=default | |
| SocketValueVariant (SocketValueVariant &&other)=default | |
| template<typename T, BLI_ENABLE_IF((std::is_trivial_v< std::decay_t< T > >|| is_same_any_v< std::decay_t< T >, std::string >))> | |
| SocketValueVariant (T &&value) | |
| SocketValueVariant & | operator= (const SocketValueVariant &other)=default |
| SocketValueVariant & | operator= (SocketValueVariant &&other)=default |
| ~SocketValueVariant ()=default | |
| 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 |
| bool | is_single () const |
| bool | is_list () 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) |
Static Public Member Functions | |
| template<typename T> | |
| static SocketValueVariant & | ConstructIn (void *ptr, T &&value) |
| template<typename T> | |
| static SocketValueVariant | From (T &&value) |
Friends | |
| std::ostream & | operator<< (std::ostream &stream, const SocketValueVariant &value_variant) |
SocketValueVariant is used by geometry nodes in the lazy-function evaluator to pass data between nodes. Specifically, it is the container type for the following socket types: bool, float, integer, vector, rotation, color and string.
The data passed through e.g. an integer socket can be a single value, a field or a grid (and in the lists and images). Each of those is stored differently, but this container can store them all.
A key requirement for this container is that it is type-erased, i.e. not all code that uses it has to include all the headers required to process the other storage types. This is achieved by using the Any type and by providing templated accessors that are implemented outside of a header.
Definition at line 34 of file BKE_node_socket_value.hh.
Create an empty variant. This is not valid for any socket type yet.
|
default |
|
default |
|
inlineexplicit |
Create a variant based on the given value. This works for primitive types. For more complex types use set explicitly. Alternatively, one can use the From or ConstructIn utilities.
Definition at line 102 of file BKE_node_socket_value.hh.
| void * blender::bke::SocketValueVariant::allocate_single | ( | eNodeSocketDatatype | socket_type | ) |
Replaces the stored value with a new uninitialized single value for the given socket type. The caller is responsible to construct the value in the returned memory before it is used.
Definition at line 431 of file node_socket_value.cc.
|
inlinestatic |
Construct a SocketValueVariant at the given pointer from the given value.
Definition at line 205 of file BKE_node_socket_value.hh.
Convert the stored value into a single value. For simple value access, this is not necessary, because get does the conversion implicitly. However, it is necessary if one wants to use get_single_ptr. Context-dependent fields or grids will just result in a fallback value.
The caller has to make sure that the stored value is a single value, field or grid.
Definition at line 386 of file node_socket_value.cc.
| T blender::bke::SocketValueVariant::extract | ( | ) |
Get the stored value as a specific type. For convenience this allows accessing the stored type as a different type. For example, a stored single int can also be accessed as GField or Field<int> (but not float or Field<float>).
This method may leave the variant empty, in a moved from state or unchanged. Therefore, this should only be called once.
Definition at line 147 of file node_socket_value.cc.
|
inlinestatic |
Create a new SocketValueVariant from the given value.
Definition at line 212 of file BKE_node_socket_value.hh.
Referenced by blender::nodes::LazyFunctionForForeachGeometryElementZone::build_graph_contents(), make_socket_type_bundle(), make_socket_type_closure(), make_socket_type_collection(), make_socket_type_geometry(), make_socket_type_image(), make_socket_type_material(), make_socket_type_menu(), make_socket_type_object(), and make_socket_type_texture().
| T blender::bke::SocketValueVariant::get | ( | ) | const |
Same as extract, but always leaves the variant unchanged. So this method can be called multiple times.
Definition at line 224 of file node_socket_value.cc.
Definition at line 425 of file node_socket_value.cc.
Get a pointer to the embedded single value. The caller has to make sure that there actually is a single value stored, e.g. by calling convert_to_single.
Definition at line 416 of file node_socket_value.cc.
|
inline |
Similar to get_single_ptr, but returns an untyped pointer. This can only be used if the caller knows for sure which type is contained. In that case, it can be a bit faster though, because the corresponding CPPType does not have to be looked up based on the socket type.
Definition at line 225 of file BKE_node_socket_value.hh.
| bool blender::bke::SocketValueVariant::is_context_dependent_field | ( | ) | const |
If true, the stored value cannot be converted to a single value without loss of information.
Definition at line 359 of file node_socket_value.cc.
| bool blender::bke::SocketValueVariant::is_list | ( | ) | const |
The stored value is a list.
Definition at line 381 of file node_socket_value.cc.
| bool blender::bke::SocketValueVariant::is_single | ( | ) | const |
The stored value is a single value.
Definition at line 376 of file node_socket_value.cc.
| bool blender::bke::SocketValueVariant::is_volume_grid | ( | ) | const |
The stored value is a volume grid.
Definition at line 371 of file node_socket_value.cc.
|
default |
|
default |
|
inline |
Replaces the stored value with a new value of potentially a different type.
Definition at line 219 of file BKE_node_socket_value.hh.
| void blender::bke::SocketValueVariant::store_single | ( | eNodeSocketDatatype | socket_type, |
| const void * | value ) |
Replace the stored value with the given single value.
Definition at line 279 of file node_socket_value.cc.
| bool blender::bke::SocketValueVariant::valid_for_socket | ( | eNodeSocketDatatype | socket_type | ) | const |
Definition at line 493 of file node_socket_value.cc.
|
friend |
Definition at line 475 of file node_socket_value.cc.