#include <FN_lazy_function.hh>
Inherited by blender::fn::lazy_function::GraphExecutor, blender::fn::lazy_function::tests::AddLazyFunction, blender::fn::lazy_function::tests::PartialEvaluationTestFunction, blender::fn::lazy_function::tests::StoreValueFunction, blender::nodes::LazyFunctionForAnonymousAttributeSetExtract, blender::nodes::LazyFunctionForAnonymousAttributeSetJoin, blender::nodes::LazyFunctionForBakeInputsUsage, blender::nodes::LazyFunctionForForeachGeometryElementZone, blender::nodes::LazyFunctionForGeometryNode, blender::nodes::LazyFunctionForGizmoInputsUsage, blender::nodes::LazyFunctionForGizmoNode, blender::nodes::LazyFunctionForGroupNode, blender::nodes::LazyFunctionForImplicitInput, blender::nodes::LazyFunctionForIndexSwitchSocketUsage, blender::nodes::LazyFunctionForLogicalOr, blender::nodes::LazyFunctionForMultiFunctionConversion, blender::nodes::LazyFunctionForMultiFunctionNode, blender::nodes::LazyFunctionForMultiInput, blender::nodes::LazyFunctionForMutedNode, blender::nodes::LazyFunctionForReduceForeachGeometryElement, blender::nodes::LazyFunctionForRepeatZone, blender::nodes::LazyFunctionForRerouteNode, blender::nodes::LazyFunctionForSimulationInputsUsage, blender::nodes::LazyFunctionForSimulationZone, blender::nodes::LazyFunctionForSwitchSocketUsage, blender::nodes::LazyFunctionForUndefinedNode, blender::nodes::LazyFunctionForViewerInputUsage, blender::nodes::LazyFunctionForViewerNode, blender::nodes::node_geo_bake_cc::LazyFunctionForBakeNode, blender::nodes::node_geo_index_switch_cc::LazyFunctionForIndexSwitchNode, blender::nodes::node_geo_menu_switch_cc::LazyFunctionForMenuSwitchNode, blender::nodes::node_geo_menu_switch_cc::LazyFunctionForMenuSwitchSocketUsage, blender::nodes::node_geo_simulation_cc::sim_input_node::LazyFunctionForSimulationInputNode, blender::nodes::node_geo_simulation_cc::sim_output_node::LazyFunctionForSimulationOutputNode, blender::nodes::node_geo_switch_cc::LazyFunctionForSwitchNode, and blender::nodes::node_geo_warning_cc::LazyFunctionForWarningNode.
A function that can compute outputs and request inputs lazily. For more details see the comment at the top of the file.
Definition at line 272 of file FN_lazy_function.hh.
◆ ~LazyFunction()
| virtual blender::fn::lazy_function::LazyFunction::~LazyFunction |
( |
| ) |
|
|
virtualdefault |
◆ allow_missing_requested_inputs()
| bool blender::fn::lazy_function::LazyFunction::allow_missing_requested_inputs |
( |
| ) |
const |
|
inline |
If true, the function can be executed even when some requested inputs are not available yet. This allows the function to make some progress and maybe to compute some outputs that are passed into this function again (lazy-function graphs may contain cycles as long as there aren't actually data dependencies).
Definition at line 339 of file FN_lazy_function.hh.
◆ always_used_inputs_available()
| bool blender::fn::lazy_function::LazyFunction::always_used_inputs_available |
( |
const Params & | params | ) |
const |
◆ destruct_storage()
| void blender::fn::lazy_function::LazyFunction::destruct_storage |
( |
void * | storage | ) |
const |
|
virtual |
◆ execute()
| void blender::fn::lazy_function::LazyFunction::execute |
( |
Params & | params, |
|
|
const Context & | context ) const |
|
inline |
During execution the function retrieves inputs and sets outputs in params. For some functions, this method is called more than once. After execution, the function either has computed all required outputs or is waiting for more inputs.
Definition at line 366 of file FN_lazy_function.hh.
◆ init_storage()
| void * blender::fn::lazy_function::LazyFunction::init_storage |
( |
LinearAllocator<> & | allocator | ) |
const |
|
virtual |
Allocates storage for this function. The storage will be passed to every call to execute. If the function does not keep track of any state, this does not have to be implemented.
Definition at line 30 of file lazy_function.cc.
◆ input_name()
| std::string blender::fn::lazy_function::LazyFunction::input_name |
( |
int | index | ) |
const |
|
virtual |
◆ inputs()
| Span< Input > blender::fn::lazy_function::LazyFunction::inputs |
( |
| ) |
const |
|
inline |
◆ name()
| std::string blender::fn::lazy_function::LazyFunction::name |
( |
| ) |
const |
|
virtual |
Get a name of the function or an input or output. This is mainly used for debugging. These are virtual functions because the names are often not used outside of debugging workflows. This way the names are only generated when they are actually needed.
Definition at line 15 of file lazy_function.cc.
◆ output_name()
| std::string blender::fn::lazy_function::LazyFunction::output_name |
( |
int | index | ) |
const |
|
virtual |
◆ outputs()
| Span< Output > blender::fn::lazy_function::LazyFunction::outputs |
( |
| ) |
const |
|
inline |
◆ possible_output_dependencies()
| void blender::fn::lazy_function::LazyFunction::possible_output_dependencies |
( |
int | output_index, |
|
|
FunctionRef< void(Span< int >)> | fn ) const |
|
virtual |
Calls fn with the input indices that the given output_index may depend on. By default every output depends on every input.
Definition at line 41 of file lazy_function.cc.
◆ allow_missing_requested_inputs_
| bool blender::fn::lazy_function::LazyFunction::allow_missing_requested_inputs_ = false |
|
protected |
Allow executing the function even if previously requested values are not yet available.
Definition at line 280 of file FN_lazy_function.hh.
◆ debug_name_
| const char* blender::fn::lazy_function::LazyFunction::debug_name_ = "unknown" |
|
protected |
◆ inputs_
| Vector<Input> blender::fn::lazy_function::LazyFunction::inputs_ |
|
protected |
◆ outputs_
| Vector<Output> blender::fn::lazy_function::LazyFunction::outputs_ |
|
protected |
The documentation for this class was generated from the following files:
