Blender: blender::fn::MultiFunction Class Reference

Blender V2.93

#include <FN_multi_function.hh>

Inherited by ColorBandFunction, MF_SeparateXYZ, MapRangeFunction, MapRangeSmootherstepFunction, MapRangeSmoothstepFunction, MapRangeSteppedFunction, ObjectSocketMultiFunction, RandomFloatFunction, SeparateRGBFunction, blender::fn::CustomMF_Constant< T >, blender::fn::CustomMF_Convert< From, To >, blender::fn::CustomMF_DefaultOutput, blender::fn::CustomMF_GenericConstant, blender::fn::CustomMF_GenericConstantArray, blender::fn::CustomMF_SI_SI_SI_SI_SO< In1, In2, In3, In4, Out1 >, blender::fn::CustomMF_SI_SI_SI_SO< In1, In2, In3, Out1 >, blender::fn::CustomMF_SI_SI_SO< In1, In2, Out1 >, blender::fn::CustomMF_SI_SO< In1, Out1 >, blender::fn::CustomMF_SM< Mut1 >, blender::fn::DummyMultiFunction, and blender::fn::MFNetworkEvaluator.

Public Member Functions
virtual	~MultiFunction ()

virtual void	call (IndexMask mask, MFParams params, MFContext context) const =0

virtual uint64_t	hash () const

virtual bool	equals (const MultiFunction &UNUSED(other)) const

int	param_amount () const

IndexRange	param_indices () const

MFParamType	param_type (int param_index) const

StringRefNull	param_name (int param_index) const

StringRefNull	name () const

bool	depends_on_context () const

const MFSignature &	signature () const

Protected Member Functions
void	set_signature (const MFSignature *signature)

Detailed Description

Definition at line 54 of file FN_multi_function.hh.

Constructor & Destructor Documentation

◆ ~MultiFunction()

virtual blender::fn::MultiFunction::~MultiFunction ( )

inlinevirtual

Definition at line 59 of file FN_multi_function.hh.

Member Function Documentation

◆ call()

virtual void blender::fn::MultiFunction::call	(	IndexMask	mask,
		MFParams	params,
		MFContext	context
	)		const

pure virtual

Implemented in blender::fn::MFNetworkEvaluator, blender::fn::CustomMF_DefaultOutput, blender::fn::CustomMF_GenericConstantArray, blender::fn::CustomMF_GenericConstant, and ObjectSocketMultiFunction.

◆ depends_on_context()

bool blender::fn::MultiFunction::depends_on_context ( ) const

inline

Definition at line 100 of file FN_multi_function.hh.

References blender::fn::MFSignature::depends_on_context.

◆ equals()

virtual bool blender::fn::MultiFunction::equals ( const MultiFunction & UNUSEDother ) const

inlinevirtual

Definition at line 70 of file FN_multi_function.hh.

◆ hash()

virtual uint64_t blender::fn::MultiFunction::hash ( ) const

inlinevirtual

Reimplemented in blender::fn::CustomMF_Constant< T >, and blender::fn::CustomMF_GenericConstant.

Definition at line 65 of file FN_multi_function.hh.

References blender::get_default_hash().

◆ name()

StringRefNull blender::fn::MultiFunction::name ( ) const

inline

Definition at line 95 of file FN_multi_function.hh.

References blender::fn::MFSignature::function_name.

Referenced by blender::fn::CustomMF_Convert< From, To >::create_signature(), blender::fn::CustomMF_DefaultOutput::CustomMF_DefaultOutput(), blender::fn::CustomMF_SI_SI_SI_SI_SO< In1, In2, In3, In4, Out1 >::CustomMF_SI_SI_SI_SI_SO(), blender::fn::CustomMF_SI_SI_SI_SO< In1, In2, In3, Out1 >::CustomMF_SI_SI_SI_SO(), blender::fn::CustomMF_SI_SI_SO< In1, In2, Out1 >::CustomMF_SI_SI_SO(), blender::fn::CustomMF_SI_SO< In1, Out1 >::CustomMF_SI_SO(), blender::fn::CustomMF_SM< Mut1 >::CustomMF_SM(), and blender::fn::MFFunctionNode::name().

◆ param_amount()

int blender::fn::MultiFunction::param_amount ( ) const

inline

Definition at line 75 of file FN_multi_function.hh.

References blender::fn::MFSignature::param_types.

◆ param_indices()

IndexRange blender::fn::MultiFunction::param_indices ( ) const

inline

Definition at line 80 of file FN_multi_function.hh.

References blender::fn::MFSignature::param_types.

Referenced by blender::fn::mf_network_optimization::add_constant_folded_sockets(), blender::fn::CustomMF_DefaultOutput::call(), and blender::fn::mf_network_optimization::prepare_params_for_constant_folding().

◆ param_name()

StringRefNull blender::fn::MultiFunction::param_name ( int param_index ) const

inline

Definition at line 90 of file FN_multi_function.hh.

References blender::fn::MFSignature::param_names.

◆ param_type()

MFParamType blender::fn::MultiFunction::param_type ( int param_index ) const

inline

Definition at line 85 of file FN_multi_function.hh.

References blender::fn::MFSignature::param_types.

Referenced by blender::fn::mf_network_optimization::add_constant_folded_sockets(), blender::fn::CustomMF_DefaultOutput::call(), and blender::fn::mf_network_optimization::prepare_params_for_constant_folding().

◆ set_signature()

void blender::fn::MultiFunction::set_signature ( const MFSignature * signature )

inlineprotected

Definition at line 116 of file FN_multi_function.hh.

References BLI_assert, and signature().

Referenced by ColorBandFunction::ColorBandFunction(), blender::fn::CustomMF_Constant< T >::CustomMF_Constant(), blender::fn::CustomMF_Convert< From, To >::CustomMF_Convert(), blender::fn::CustomMF_DefaultOutput::CustomMF_DefaultOutput(), blender::fn::CustomMF_GenericConstant::CustomMF_GenericConstant(), blender::fn::CustomMF_GenericConstantArray::CustomMF_GenericConstantArray(), blender::fn::CustomMF_SI_SI_SI_SI_SO< In1, In2, In3, In4, Out1 >::CustomMF_SI_SI_SI_SI_SO(), blender::fn::CustomMF_SI_SI_SI_SO< In1, In2, In3, Out1 >::CustomMF_SI_SI_SI_SO(), blender::fn::CustomMF_SI_SI_SO< In1, In2, Out1 >::CustomMF_SI_SI_SO(), blender::fn::CustomMF_SI_SO< In1, Out1 >::CustomMF_SI_SO(), blender::fn::CustomMF_SM< Mut1 >::CustomMF_SM(), blender::fn::DummyMultiFunction::DummyMultiFunction(), MapRangeFunction::MapRangeFunction(), MapRangeSmootherstepFunction::MapRangeSmootherstepFunction(), MapRangeSmoothstepFunction::MapRangeSmoothstepFunction(), MapRangeSteppedFunction::MapRangeSteppedFunction(), MF_SeparateXYZ::MF_SeparateXYZ(), blender::fn::MFNetworkEvaluator::MFNetworkEvaluator(), ObjectSocketMultiFunction::ObjectSocketMultiFunction(), RandomFloatFunction::RandomFloatFunction(), and SeparateRGBFunction::SeparateRGBFunction().

◆ signature()

const MFSignature& blender::fn::MultiFunction::signature ( ) const

inline

Definition at line 105 of file FN_multi_function.hh.

References BLI_assert.

Referenced by ColorBandFunction::ColorBandFunction(), blender::fn::CustomMF_Convert< From, To >::create_signature(), blender::fn::DummyMultiFunction::create_signature(), RandomFloatFunction::create_signature(), ObjectSocketMultiFunction::create_signature(), MapRangeFunction::create_signature(), MapRangeSteppedFunction::create_signature(), MapRangeSmoothstepFunction::create_signature(), MapRangeSmootherstepFunction::create_signature(), SeparateRGBFunction::create_signature(), MF_SeparateXYZ::create_signature(), ColorBandFunction::create_signature(), blender::fn::CustomMF_Constant< T >::CustomMF_Constant(), blender::fn::CustomMF_Convert< From, To >::CustomMF_Convert(), blender::fn::CustomMF_DefaultOutput::CustomMF_DefaultOutput(), blender::fn::CustomMF_GenericConstant::CustomMF_GenericConstant(), blender::fn::CustomMF_GenericConstantArray::CustomMF_GenericConstantArray(), blender::fn::CustomMF_SI_SI_SI_SI_SO< In1, In2, In3, In4, Out1 >::CustomMF_SI_SI_SI_SI_SO(), blender::fn::CustomMF_SI_SI_SI_SO< In1, In2, In3, Out1 >::CustomMF_SI_SI_SI_SO(), blender::fn::CustomMF_SI_SI_SO< In1, In2, Out1 >::CustomMF_SI_SI_SO(), blender::fn::CustomMF_SI_SO< In1, Out1 >::CustomMF_SI_SO(), blender::fn::CustomMF_SM< Mut1 >::CustomMF_SM(), blender::fn::DummyMultiFunction::DummyMultiFunction(), MapRangeFunction::MapRangeFunction(), MapRangeSmootherstepFunction::MapRangeSmootherstepFunction(), MapRangeSmoothstepFunction::MapRangeSmoothstepFunction(), MapRangeSteppedFunction::MapRangeSteppedFunction(), MF_SeparateXYZ::MF_SeparateXYZ(), blender::fn::MFNetworkEvaluator::MFNetworkEvaluator(), ObjectSocketMultiFunction::ObjectSocketMultiFunction(), RandomFloatFunction::RandomFloatFunction(), SeparateRGBFunction::SeparateRGBFunction(), and set_signature().

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

FN_multi_function.hh