Blender: blender::fn::multi_function::ParamsBuilder Class Reference

Blender V4.3

#include <FN_multi_function_params.hh>

Public Member Functions
	ParamsBuilder (const class MultiFunction &fn, const IndexMask *mask)

Friends
class	Params

#Paramsbuilder Inline Methods
template<typename T >
void	add_readonly_single_input_value (T value, StringRef expected_name="")

template<typename T >
void	add_readonly_single_input (const T *value, StringRef expected_name="")

void	add_readonly_single_input (const GSpan span, StringRef expected_name="")

void	add_readonly_single_input (GPointer value, StringRef expected_name="")

void	add_readonly_single_input (GVArray varray, StringRef expected_name="")

void	add_readonly_vector_input (const GVectorArray &vector_array, StringRef expected_name="")

void	add_readonly_vector_input (const GSpan single_vector, StringRef expected_name="")

void	add_readonly_vector_input (const GVVectorArray &ref, StringRef expected_name="")

template<typename T >
void	add_uninitialized_single_output (T *value, StringRef expected_name="")

void	add_uninitialized_single_output (GMutableSpan ref, StringRef expected_name="")

void	add_ignored_single_output (StringRef expected_name="")

void	add_vector_output (GVectorArray &vector_array, StringRef expected_name="")

void	add_single_mutable (GMutableSpan ref, StringRef expected_name="")

void	add_vector_mutable (GVectorArray &vector_array, StringRef expected_name="")

int	next_param_index () const

GMutableSpan	computed_array (int param_index)

GVectorArray &	computed_vector_array (int param_index)

Detailed Description

Definition at line 28 of file FN_multi_function_params.hh.

Constructor & Destructor Documentation

◆ ParamsBuilder()

blender::fn::multi_function::ParamsBuilder::ParamsBuilder	(	const class MultiFunction &	fn,
		const IndexMask *	mask )

The indices referenced by the #mask has to live longer than the params builder. This is because the it might have to destruct elements for all masked indices in the end.

Member Function Documentation

◆ add_ignored_single_output()

void blender::fn::multi_function::ParamsBuilder::add_ignored_single_output ( StringRef expected_name = "" )

inline

Definition at line 232 of file FN_multi_function_params.hh.

References BLI_assert, blender::fn::multi_function::ParamType::category(), blender::fn::multi_function::ParamType::data_type(), blender::fn::multi_function::Signature::params, blender::fn::multi_function::DataType::single_type(), blender::fn::multi_function::SingleOutput, and blender::fn::multi_function::SupportsUnusedOutput.

Referenced by blender::fn::multi_function::add_sliced_parameters().

◆ add_readonly_single_input() [1/4]

void blender::fn::multi_function::ParamsBuilder::add_readonly_single_input	(	const GSpan	span,
		StringRef	expected_name = "" )

inline

Definition at line 170 of file FN_multi_function_params.hh.

References BLI_assert, blender::fn::multi_function::ParamType::ForSingleInput(), blender::GSpan::size(), and blender::GSpan::type().

◆ add_readonly_single_input() [2/4]

template<typename T >

void blender::fn::multi_function::ParamsBuilder::add_readonly_single_input	(	const T *	value,
		StringRef	expected_name = "" )

inline

Definition at line 160 of file FN_multi_function_params.hh.

References blender::fn::multi_function::ParamType::ForSingleInput(), and blender::CPPType::get().

Referenced by blender::fn::multi_function::add_sliced_parameters().

◆ add_readonly_single_input() [3/4]

void blender::fn::multi_function::ParamsBuilder::add_readonly_single_input	(	GPointer	value,
		StringRef	expected_name = "" )

inline

Definition at line 177 of file FN_multi_function_params.hh.

References blender::fn::multi_function::ParamType::ForSingleInput().

◆ add_readonly_single_input() [4/4]

void blender::fn::multi_function::ParamsBuilder::add_readonly_single_input	(	GVArray	varray,
		StringRef	expected_name = "" )

inline

Definition at line 187 of file FN_multi_function_params.hh.

References BLI_assert, blender::fn::multi_function::ParamType::ForSingleInput(), blender::GVArrayCommon::size(), and blender::GVArrayCommon::type().

◆ add_readonly_single_input_value()

template<typename T >

void blender::fn::multi_function::ParamsBuilder::add_readonly_single_input_value	(	T	value,
		StringRef	expected_name = "" )

inline

Definition at line 149 of file FN_multi_function_params.hh.

References blender::fn::multi_function::ParamType::ForSingleInput(), and blender::CPPType::get().

◆ add_readonly_vector_input() [1/3]

void blender::fn::multi_function::ParamsBuilder::add_readonly_vector_input	(	const GSpan	single_vector,
		StringRef	expected_name = "" )

inline

Definition at line 202 of file FN_multi_function_params.hh.

References add_readonly_vector_input().

◆ add_readonly_vector_input() [2/3]

void blender::fn::multi_function::ParamsBuilder::add_readonly_vector_input	(	const GVectorArray &	vector_array,
		StringRef	expected_name = "" )

inline

Definition at line 194 of file FN_multi_function_params.hh.

References add_readonly_vector_input().

Referenced by add_readonly_vector_input(), and add_readonly_vector_input().

◆ add_readonly_vector_input() [3/3]

void blender::fn::multi_function::ParamsBuilder::add_readonly_vector_input	(	const GVVectorArray &	ref,
		StringRef	expected_name = "" )

inline

Definition at line 210 of file FN_multi_function_params.hh.

References BLI_assert, blender::fn::multi_function::ParamType::ForVectorInput(), blender::GVVectorArray::size(), and blender::GVVectorArray::type().

◆ add_single_mutable()

void blender::fn::multi_function::ParamsBuilder::add_single_mutable	(	GMutableSpan	ref,
		StringRef	expected_name = "" )

inline

Definition at line 258 of file FN_multi_function_params.hh.

References BLI_assert, blender::fn::multi_function::ParamType::ForMutableSingle(), blender::GMutableSpan::size(), and blender::GMutableSpan::type().

Referenced by blender::fn::multi_function::add_sliced_parameters().

◆ add_uninitialized_single_output() [1/2]

void blender::fn::multi_function::ParamsBuilder::add_uninitialized_single_output	(	GMutableSpan	ref,
		StringRef	expected_name = "" )

inline

Definition at line 224 of file FN_multi_function_params.hh.

References BLI_assert, blender::fn::multi_function::ParamType::ForSingleOutput(), blender::GMutableSpan::size(), and blender::GMutableSpan::type().

◆ add_uninitialized_single_output() [2/2]

template<typename T >

void blender::fn::multi_function::ParamsBuilder::add_uninitialized_single_output	(	T *	value,
		StringRef	expected_name = "" )

inline

Definition at line 219 of file FN_multi_function_params.hh.

References add_uninitialized_single_output(), and blender::CPPType::get().

Referenced by blender::fn::multi_function::add_sliced_parameters(), and add_uninitialized_single_output().

◆ add_vector_mutable()

void blender::fn::multi_function::ParamsBuilder::add_vector_mutable	(	GVectorArray &	vector_array,
		StringRef	expected_name = "" )

inline

Definition at line 265 of file FN_multi_function_params.hh.

References BLI_assert, blender::fn::multi_function::ParamType::ForMutableVector(), blender::GVectorArray::size(), and blender::GVectorArray::type().

◆ add_vector_output()

void blender::fn::multi_function::ParamsBuilder::add_vector_output	(	GVectorArray &	vector_array,
		StringRef	expected_name = "" )

inline

Definition at line 251 of file FN_multi_function_params.hh.

References BLI_assert, blender::fn::multi_function::ParamType::ForVectorOutput(), blender::GVectorArray::size(), and blender::GVectorArray::type().

◆ computed_array()

GMutableSpan blender::fn::multi_function::ParamsBuilder::computed_array ( int param_index )

inline

Definition at line 277 of file FN_multi_function_params.hh.

References BLI_assert, ELEM, blender::fn::multi_function::Signature::params, blender::fn::multi_function::SingleMutable, and blender::fn::multi_function::SingleOutput.

◆ computed_vector_array()

GVectorArray & blender::fn::multi_function::ParamsBuilder::computed_vector_array ( int param_index )

inline

Definition at line 285 of file FN_multi_function_params.hh.

References BLI_assert, ELEM, blender::fn::multi_function::Signature::params, blender::fn::multi_function::VectorMutable, and blender::fn::multi_function::VectorOutput.

◆ next_param_index()

int blender::fn::multi_function::ParamsBuilder::next_param_index ( ) const

inline

Definition at line 272 of file FN_multi_function_params.hh.

Friends And Related Symbol Documentation

◆ Params

friend class Params

friend

Definition at line 37 of file FN_multi_function_params.hh.

The documentation for this class was generated from the following files: