Blender V4.3
Public Types | List of all members
blender::fn::multi_function::ParamType Class Reference

#include <FN_multi_function_param_type.hh>

Public Types

enum  InterfaceType { Input , Output , Mutable }
 

#ParamType Inline Methods

 ParamType (InterfaceType interface_type, DataType data_type)
 
const DataType & data_type () const
 
InterfaceType interface_type () const
 
ParamCategory category () const
 
bool is_input_or_mutable () const
 
bool is_output_or_mutable () const
 
bool is_output () const
 
static ParamType ForSingleInput (const CPPType &type)
 
static ParamType ForVectorInput (const CPPType &base_type)
 
static ParamType ForSingleOutput (const CPPType &type)
 
static ParamType ForVectorOutput (const CPPType &base_type)
 
static ParamType ForMutableSingle (const CPPType &type)
 
static ParamType ForMutableVector (const CPPType &base_type)
 

Detailed Description

Definition at line 41 of file FN_multi_function_param_type.hh.

Member Enumeration Documentation

◆ InterfaceType

enum blender::fn::multi_function::ParamType::InterfaceType
Enumerator
Input 
Output 
Mutable 

Definition at line 43 of file FN_multi_function_param_type.hh.

Constructor & Destructor Documentation

◆ ParamType()

blender::fn::multi_function::ParamType::ParamType ( InterfaceType interface_type,
DataType data_type )
inline

Definition at line 78 of file FN_multi_function_param_type.hh.

Referenced by ForMutableSingle(), ForMutableVector(), ForSingleInput(), ForSingleOutput(), ForVectorInput(), and ForVectorOutput().

Member Function Documentation

◆ category()

ParamCategory blender::fn::multi_function::ParamType::category ( ) const
inline

Definition at line 123 of file FN_multi_function_param_type.hh.

References BLI_assert_unreachable, blender::fn::multi_function::DataType::category(), Input, Mutable, Output, blender::fn::multi_function::DataType::Single, blender::fn::multi_function::SingleInput, blender::fn::multi_function::SingleMutable, blender::fn::multi_function::SingleOutput, blender::fn::multi_function::DataType::Vector, blender::fn::multi_function::VectorInput, blender::fn::multi_function::VectorMutable, and blender::fn::multi_function::VectorOutput.

Referenced by blender::fn::multi_function::ParamsBuilder::add_ignored_single_output(), blender::fn::multi_function::VariableStates::add_initial_variable_states(), and blender::fn::multi_function::add_sliced_parameters().

◆ data_type()

const DataType & blender::fn::multi_function::ParamType::data_type ( ) const
inline

Definition at line 113 of file FN_multi_function_param_type.hh.

Referenced by blender::fn::multi_function::SignatureBuilder::add(), blender::fn::multi_function::VariableStates::add_as_param(), blender::fn::multi_function::VariableStates::add_as_param__one(), blender::fn::multi_function::ProcedureBuilder::add_call(), blender::fn::multi_function::ParamsBuilder::add_ignored_single_output(), blender::fn::multi_function::ProcedureBuilder::add_parameter(), blender::fn::build_multi_function_procedure_for_fields(), blender::fn::multi_function::CustomMF_DefaultOutput::call(), blender::fn::multi_function::CustomMF_GenericCopy::call(), blender::fn::multi_function::ProcedureExecutor::call(), blender::nodes::execute_multi_function_on_value_variant__single(), blender::fn::FieldOperation::output_cpp_type(), blender::fn::multi_function::CallInstruction::set_param_variable(), and blender::fn::multi_function::supports_threading_by_slicing_params().

◆ ForMutableSingle()

ParamType blender::fn::multi_function::ParamType::ForMutableSingle ( const CPPType & type)
inlinestatic

Definition at line 103 of file FN_multi_function_param_type.hh.

References blender::fn::multi_function::DataType::ForSingle(), Mutable, and ParamType().

Referenced by blender::fn::multi_function::ParamsBuilder::add_single_mutable(), and blender::fn::multi_function::ProcedureBuilder::add_single_mutable_parameter().

◆ ForMutableVector()

ParamType blender::fn::multi_function::ParamType::ForMutableVector ( const CPPType & base_type)
inlinestatic

Definition at line 108 of file FN_multi_function_param_type.hh.

References blender::fn::multi_function::DataType::ForVector(), Mutable, and ParamType().

Referenced by blender::fn::multi_function::ParamsBuilder::add_vector_mutable(), and blender::fn::multi_function::tests::TEST().

◆ ForSingleInput()

ParamType blender::fn::multi_function::ParamType::ForSingleInput ( const CPPType & type)
inlinestatic

Definition at line 83 of file FN_multi_function_param_type.hh.

References blender::fn::multi_function::DataType::ForSingle(), Input, and ParamType().

Referenced by blender::fn::multi_function::ParamsBuilder::add_readonly_single_input(), blender::fn::multi_function::ParamsBuilder::add_readonly_single_input(), blender::fn::multi_function::ParamsBuilder::add_readonly_single_input(), blender::fn::multi_function::ParamsBuilder::add_readonly_single_input(), blender::fn::multi_function::ParamsBuilder::add_readonly_single_input_value(), and blender::fn::multi_function::ProcedureBuilder::add_single_input_parameter().

◆ ForSingleOutput()

ParamType blender::fn::multi_function::ParamType::ForSingleOutput ( const CPPType & type)
inlinestatic

Definition at line 93 of file FN_multi_function_param_type.hh.

References blender::fn::multi_function::DataType::ForSingle(), Output, and ParamType().

Referenced by blender::fn::multi_function::ParamsBuilder::add_uninitialized_single_output().

◆ ForVectorInput()

ParamType blender::fn::multi_function::ParamType::ForVectorInput ( const CPPType & base_type)
inlinestatic

Definition at line 88 of file FN_multi_function_param_type.hh.

References blender::fn::multi_function::DataType::ForVector(), Input, and ParamType().

Referenced by blender::fn::multi_function::ParamsBuilder::add_readonly_vector_input().

◆ ForVectorOutput()

ParamType blender::fn::multi_function::ParamType::ForVectorOutput ( const CPPType & base_type)
inlinestatic

Definition at line 98 of file FN_multi_function_param_type.hh.

References blender::fn::multi_function::DataType::ForVector(), Output, and ParamType().

Referenced by blender::fn::multi_function::ParamsBuilder::add_vector_output().

◆ interface_type()

ParamType::InterfaceType blender::fn::multi_function::ParamType::interface_type ( ) const
inline

Definition at line 118 of file FN_multi_function_param_type.hh.

Referenced by blender::fn::multi_function::SignatureBuilder::add(), blender::fn::multi_function::VariableStates::add_as_param(), blender::fn::multi_function::VariableStates::add_as_param__one(), blender::fn::multi_function::ProcedureBuilder::add_call(), blender::fn::multi_function::ProcedureBuilder::add_parameter(), blender::fn::build_multi_function_procedure_for_fields(), blender::fn::multi_function::ProcedureExecutor::call(), blender::fn::multi_function::ProcedureDotExport::instruction_to_string(), and blender::fn::multi_function::supports_threading_by_slicing_params().

◆ is_input_or_mutable()

bool blender::fn::multi_function::ParamType::is_input_or_mutable ( ) const
inline

Definition at line 153 of file FN_multi_function_param_type.hh.

References ELEM, and Mutable.

◆ is_output()

bool blender::fn::multi_function::ParamType::is_output ( ) const
inline

Definition at line 163 of file FN_multi_function_param_type.hh.

References Output.

Referenced by blender::fn::multi_function::CustomMF_DefaultOutput::call(), and blender::fn::FieldOperation::output_cpp_type().

◆ is_output_or_mutable()

bool blender::fn::multi_function::ParamType::is_output_or_mutable ( ) const
inline

Definition at line 158 of file FN_multi_function_param_type.hh.

References ELEM, and Mutable.

The documentation for this class was generated from the following file:
Generated on Thu Feb 6 2025 07:36:39 for Blender by  doxygen 1.11.0