Blender  V3.3
Public Member Functions | List of all members
blender::fn::MFSignatureBuilder Class Reference

#include <FN_multi_function_signature.hh>

Public Member Functions

 MFSignatureBuilder (const char *function_name)
 
MFSignature build () const
 
template<typename T >
void single_input (const char *name)
 
void single_input (const char *name, const CPPType &type)
 
template<typename T >
void vector_input (const char *name)
 
void vector_input (const char *name, const CPPType &base_type)
 
void input (const char *name, MFDataType data_type)
 
template<typename T >
void single_output (const char *name)
 
void single_output (const char *name, const CPPType &type)
 
template<typename T >
void vector_output (const char *name)
 
void vector_output (const char *name, const CPPType &base_type)
 
void output (const char *name, MFDataType data_type)
 
template<typename T >
void single_mutable (const char *name)
 
void single_mutable (const char *name, const CPPType &type)
 
template<typename T >
void vector_mutable (const char *name)
 
void vector_mutable (const char *name, const CPPType &base_type)
 
void mutable_ (const char *name, MFDataType data_type)
 
void add (const char *name, const MFParamType &param_type)
 
template<MFParamCategory Category, typename T >
void add (MFParamTag< Category, T >, const char *name)
 
void depends_on_context ()
 

Detailed Description

Definition at line 47 of file FN_multi_function_signature.hh.

Constructor & Destructor Documentation

◆ MFSignatureBuilder()

blender::fn::MFSignatureBuilder::MFSignatureBuilder ( const char *  function_name)
inline

Definition at line 52 of file FN_multi_function_signature.hh.

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

Member Function Documentation

◆ add() [1/2]

void blender::fn::MFSignatureBuilder::add ( const char *  name,
const MFParamType &  param_type 
)
inline

Definition at line 161 of file FN_multi_function_signature.hh.

References blender::fn::MFParamType::data_type(), blender::fn::MFParamType::Input, input(), blender::fn::MFParamType::interface_type(), blender::fn::MFParamType::Mutable, mutable_(), blender::fn::MFParamType::Output, and output().

◆ add() [2/2]

template<MFParamCategory Category, typename T >
void blender::fn::MFSignatureBuilder::add ( MFParamTag< Category, T >  ,
const char *  name 
)
inline

Definition at line 177 of file FN_multi_function_signature.hh.

References BLI_assert_unreachable, blender::fn::SingleInput, blender::fn::SingleMutable, blender::fn::SingleOutput, blender::fn::VectorInput, blender::fn::VectorMutable, and blender::fn::VectorOutput.

◆ build()

MFSignature blender::fn::MFSignatureBuilder::build ( ) const
inline

Definition at line 57 of file FN_multi_function_signature.hh.

◆ depends_on_context()

void blender::fn::MFSignatureBuilder::depends_on_context ( )
inline

This indicates that the function accesses the context. This disables optimizations that depend on the fact that the function always performers the same operation.

Definition at line 206 of file FN_multi_function_signature.hh.

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

◆ input()

void blender::fn::MFSignatureBuilder::input ( const char *  name,
MFDataType  data_type 
)
inline

Definition at line 80 of file FN_multi_function_signature.hh.

References blender::Vector< T, InlineBufferCapacity, Allocator >::append(), blender::fn::MFDataType::category(), blender::fn::MFParamType::Input, blender::fn::MFSignature::param_data_indices, blender::fn::MFSignature::param_names, blender::fn::MFSignature::param_types, blender::fn::MFDataType::Single, blender::fn::MFDataType::Vector, blender::fn::MFSignature::virtual_array_num, and blender::fn::MFSignature::virtual_vector_array_num.

Referenced by add(), single_input(), and vector_input().

◆ mutable_()

void blender::fn::MFSignatureBuilder::mutable_ ( const char *  name,
MFDataType  data_type 
)
inline

Definition at line 146 of file FN_multi_function_signature.hh.

References blender::Vector< T, InlineBufferCapacity, Allocator >::append(), blender::fn::MFDataType::category(), blender::fn::MFParamType::Mutable, blender::fn::MFSignature::param_data_indices, blender::fn::MFSignature::param_names, blender::fn::MFSignature::param_types, blender::fn::MFDataType::Single, blender::fn::MFSignature::span_num, blender::fn::MFDataType::Vector, and blender::fn::MFSignature::vector_array_num.

Referenced by add(), single_mutable(), and vector_mutable().

◆ output()

void blender::fn::MFSignatureBuilder::output ( const char *  name,
MFDataType  data_type 
)
inline

Definition at line 113 of file FN_multi_function_signature.hh.

References blender::Vector< T, InlineBufferCapacity, Allocator >::append(), blender::fn::MFDataType::category(), blender::fn::MFParamType::Output, blender::fn::MFSignature::param_data_indices, blender::fn::MFSignature::param_names, blender::fn::MFSignature::param_types, blender::fn::MFDataType::Single, blender::fn::MFSignature::span_num, blender::fn::MFDataType::Vector, and blender::fn::MFSignature::vector_array_num.

Referenced by add(), single_output(), and vector_output().

◆ single_input() [1/2]

template<typename T >
void blender::fn::MFSignatureBuilder::single_input ( const char *  name)
inline

Definition at line 64 of file FN_multi_function_signature.hh.

Referenced by blender::nodes::node_fn_align_euler_to_vector_cc::MF_AlignEulerToVector::create_signature(), blender::nodes::node_geo_proximity_cc::ProximityFunction::create_signature(), blender::nodes::node_geo_raycast_cc::RaycastFunction::create_signature(), and blender::nodes::node_geo_transfer_attribute_cc::IndexTransferFunction::create_signature().

◆ single_input() [2/2]

void blender::fn::MFSignatureBuilder::single_input ( const char *  name,
const CPPType &  type 
)
inline

Definition at line 68 of file FN_multi_function_signature.hh.

References blender::fn::MFDataType::ForSingle(), input(), and type.

◆ single_mutable() [1/2]

template<typename T >
void blender::fn::MFSignatureBuilder::single_mutable ( const char *  name)
inline

Definition at line 130 of file FN_multi_function_signature.hh.

◆ single_mutable() [2/2]

void blender::fn::MFSignatureBuilder::single_mutable ( const char *  name,
const CPPType &  type 
)
inline

Definition at line 134 of file FN_multi_function_signature.hh.

References blender::fn::MFDataType::ForSingle(), mutable_(), and type.

◆ single_output() [1/2]

template<typename T >
void blender::fn::MFSignatureBuilder::single_output ( const char *  name)
inline

Definition at line 97 of file FN_multi_function_signature.hh.

◆ single_output() [2/2]

void blender::fn::MFSignatureBuilder::single_output ( const char *  name,
const CPPType &  type 
)
inline

Definition at line 101 of file FN_multi_function_signature.hh.

References blender::fn::MFDataType::ForSingle(), output(), and type.

◆ vector_input() [1/2]

template<typename T >
void blender::fn::MFSignatureBuilder::vector_input ( const char *  name)
inline

Definition at line 72 of file FN_multi_function_signature.hh.

◆ vector_input() [2/2]

void blender::fn::MFSignatureBuilder::vector_input ( const char *  name,
const CPPType &  base_type 
)
inline

Definition at line 76 of file FN_multi_function_signature.hh.

References blender::fn::MFDataType::ForVector(), and input().

◆ vector_mutable() [1/2]

template<typename T >
void blender::fn::MFSignatureBuilder::vector_mutable ( const char *  name)
inline

Definition at line 138 of file FN_multi_function_signature.hh.

◆ vector_mutable() [2/2]

void blender::fn::MFSignatureBuilder::vector_mutable ( const char *  name,
const CPPType &  base_type 
)
inline

Definition at line 142 of file FN_multi_function_signature.hh.

References blender::fn::MFDataType::ForVector(), and mutable_().

◆ vector_output() [1/2]

template<typename T >
void blender::fn::MFSignatureBuilder::vector_output ( const char *  name)
inline

Definition at line 105 of file FN_multi_function_signature.hh.

◆ vector_output() [2/2]

void blender::fn::MFSignatureBuilder::vector_output ( const char *  name,
const CPPType &  base_type 
)
inline

Definition at line 109 of file FN_multi_function_signature.hh.

References blender::fn::MFDataType::ForVector(), and output().

The documentation for this class was generated from the following file:
Generated on Tue Oct 22 2024 13:18:25 for Blender by  doxygen 1.9.1