Blender: blender::fn::multi_function::Procedure Class Reference

Blender V5.0

#include <FN_multi_function_procedure.hh>

Inherits blender::NonCopyable, and blender::NonMovable.

Public Member Functions
	Procedure ()=default
	~Procedure ()
Variable &	new_variable (DataType data_type, std::string name="")
CallInstruction &	new_call_instruction (const MultiFunction &fn)
BranchInstruction &	new_branch_instruction ()
DestructInstruction &	new_destruct_instruction ()
DummyInstruction &	new_dummy_instruction ()
ReturnInstruction &	new_return_instruction ()
void	add_parameter (ParamType::InterfaceType interface_type, Variable &variable)
void	set_entry (Instruction &entry)
std::string	to_dot () const
bool	validate () const
#Procedure Inline Methods
Span< ConstParameter >	params () const
template<typename T, typename... Args>
const MultiFunction &	construct_function (Args &&...args)
Instruction *	entry ()
const Instruction *	entry () const
Span< Variable * >	variables ()
Span< const Variable * >	variables () const

Friends
class	ProcedureDotExport

Detailed Description

A multi-function procedure allows composing multi-functions in arbitrary ways. It consists of variables and instructions that operate on those variables. Branching and looping within the procedure is supported as well.

Typically, a Procedure should be constructed using a ProcedureBuilder, which has many more utility methods for common use cases.

Definition at line 239 of file FN_multi_function_procedure.hh.

Constructor & Destructor Documentation

◆ Procedure()

blender::fn::multi_function::Procedure::Procedure ( )

default

References entry(), name, and T.

◆ ~Procedure()

blender::fn::multi_function::Procedure::~Procedure ( )

Definition at line 245 of file multi_function_procedure.cc.

Member Function Documentation

◆ add_parameter()

void blender::fn::multi_function::Procedure::add_parameter	(	ParamType::InterfaceType	interface_type,
		Variable &	variable )

Definition at line 231 of file multi_function_procedure.cc.

◆ construct_function()

template<typename T, typename... Args>

const MultiFunction & blender::fn::multi_function::Procedure::construct_function ( Args &&... args )

inline

Definition at line 524 of file FN_multi_function_procedure.hh.

References T.

◆ entry() [1/2]

Instruction * blender::fn::multi_function::Procedure::entry ( )

inline

Definition at line 503 of file FN_multi_function_procedure.hh.

Referenced by blender::fn::multi_function::InstructionCursor::next(), Procedure(), and set_entry().

◆ entry() [2/2]

const Instruction * blender::fn::multi_function::Procedure::entry ( ) const

inline

Definition at line 508 of file FN_multi_function_procedure.hh.

◆ new_branch_instruction()

BranchInstruction & blender::fn::multi_function::Procedure::new_branch_instruction ( )

Definition at line 199 of file multi_function_procedure.cc.

References blender::fn::multi_function::Branch, and blender::fn::multi_function::Instruction::type_.

◆ new_call_instruction()

CallInstruction & blender::fn::multi_function::Procedure::new_call_instruction ( const MultiFunction & fn )

Definition at line 188 of file multi_function_procedure.cc.

References blender::fn::multi_function::Call, and blender::fn::multi_function::Instruction::type_.

◆ new_destruct_instruction()

DestructInstruction & blender::fn::multi_function::Procedure::new_destruct_instruction ( )

Definition at line 207 of file multi_function_procedure.cc.

References blender::fn::multi_function::Destruct, and blender::fn::multi_function::Instruction::type_.

◆ new_dummy_instruction()

DummyInstruction & blender::fn::multi_function::Procedure::new_dummy_instruction ( )

Definition at line 215 of file multi_function_procedure.cc.

References blender::fn::multi_function::Dummy, and blender::fn::multi_function::Instruction::type_.

◆ new_return_instruction()

ReturnInstruction & blender::fn::multi_function::Procedure::new_return_instruction ( )

Definition at line 223 of file multi_function_procedure.cc.

References blender::fn::multi_function::Return, and blender::fn::multi_function::Instruction::type_.

◆ new_variable()

Variable & blender::fn::multi_function::Procedure::new_variable	(	DataType	data_type,
		std::string	name = "" )

Definition at line 178 of file multi_function_procedure.cc.

References name.

Referenced by blender::fn::multi_function::tests::TEST().

◆ params()

Span< ConstParameter > blender::fn::multi_function::Procedure::params ( ) const

inline

Definition at line 497 of file FN_multi_function_procedure.hh.

References blender::Span< T >::cast().

Referenced by blender::fn::multi_function::VariableStates::add_initial_variable_states(), and blender::fn::multi_function::ProcedureExecutor::ProcedureExecutor().

◆ set_entry()

void blender::fn::multi_function::Procedure::set_entry ( Instruction & entry )

Definition at line 236 of file multi_function_procedure.cc.

References entry(), and blender::fn::multi_function::InstructionCursor::ForEntry().

Referenced by blender::fn::multi_function::InstructionCursor::set_next().

◆ to_dot()

std::string blender::fn::multi_function::Procedure::to_dot ( ) const

Definition at line 865 of file multi_function_procedure.cc.

References ProcedureDotExport.

◆ validate()

bool blender::fn::multi_function::Procedure::validate ( ) const

Definition at line 267 of file multi_function_procedure.cc.

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

◆ variables() [1/2]

Span< Variable * > blender::fn::multi_function::Procedure::variables ( )

inline

Definition at line 513 of file FN_multi_function_procedure.hh.

◆ variables() [2/2]

Span< const Variable * > blender::fn::multi_function::Procedure::variables ( ) const

inline

Definition at line 518 of file FN_multi_function_procedure.hh.

◆ ProcedureDotExport

friend class ProcedureDotExport

friend

Definition at line 252 of file FN_multi_function_procedure.hh.

References ProcedureDotExport.

Referenced by ProcedureDotExport, and to_dot().

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