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

#include <FN_field.hh>

Inheritance diagram for blender::fn::FieldEvaluator:
blender::NonMovable blender::NonCopyable

Public Member Functions

 FieldEvaluator (const FieldContext &context, const IndexMask *mask)
 
 FieldEvaluator (const FieldContext &context, const int64_t size)
 
 ~FieldEvaluator ()
 
void set_selection (Field< bool > selection)
 
int add_with_destination (GField field, GVMutableArray dst)
 
template<typename T >
int add_with_destination (Field< T > field, VMutableArray< T > dst)
 
int add_with_destination (GField field, GMutableSpan dst)
 
template<typename T >
int add_with_destination (Field< T > field, MutableSpan< T > dst)
 
int add (GField field, GVArray *varray_ptr)
 
template<typename T >
int add (Field< T > field, VArray< T > *varray_ptr)
 
int add (GField field)
 
void evaluate ()
 
const GVArrayget_evaluated (const int field_index) const
 
template<typename T >
VArray< Tget_evaluated (const int field_index)
 
IndexMask get_evaluated_selection_as_mask ()
 
IndexMask get_evaluated_as_mask (int field_index)
 

Detailed Description

Utility class that makes it easier to evaluate fields.

Definition at line 319 of file FN_field.hh.

Constructor & Destructor Documentation

◆ FieldEvaluator() [1/2]

blender::fn::FieldEvaluator::FieldEvaluator ( const FieldContext context,
const IndexMask mask 
)
inline

Takes mask by pointer because the mask has to live longer than the evaluator.

Definition at line 342 of file FN_field.hh.

◆ FieldEvaluator() [2/2]

blender::fn::FieldEvaluator::FieldEvaluator ( const FieldContext context,
const int64_t  size 
)
inline

Construct a field evaluator for all indices less than size.

Definition at line 348 of file FN_field.hh.

◆ ~FieldEvaluator()

blender::fn::FieldEvaluator::~FieldEvaluator ( )
inline

Definition at line 352 of file FN_field.hh.

References BLI_assert.

Member Function Documentation

◆ add() [1/3]

template<typename T >
int blender::fn::FieldEvaluator::add ( Field< T field,
VArray< T > *  varray_ptr 
)
inline
Parameters
fieldField to add to the evaluator.
varray_ptrOnce evaluate is called, the resulting virtual array will be will be assigned to the given position.
Returns
Index of the field in the evaluator which can be used in the get_evaluated methods.

Definition at line 410 of file FN_field.hh.

References blender::Vector< T, InlineBufferCapacity, Allocator >::append(), blender::Vector< T, InlineBufferCapacity, Allocator >::append_and_get_index(), T, and UNUSED.

◆ add() [2/3]

int blender::fn::FieldEvaluator::add ( GField  field)
Returns
Index of the field in the evaluator which can be used in the get_evaluated methods.

Definition at line 742 of file field.cc.

References blender::Vector< T, InlineBufferCapacity, Allocator >::append().

◆ add() [3/3]

int blender::fn::FieldEvaluator::add ( GField  field,
GVArray varray_ptr 
)

◆ add_with_destination() [1/4]

template<typename T >
int blender::fn::FieldEvaluator::add_with_destination ( Field< T field,
MutableSpan< T dst 
)
inline
Parameters
fieldField to add to the evaluator.
dstMutable span that the evaluated result for this field is be written into.
Note
When the output may only be used as a single value, the version of this function with a virtual array result array should be used.

Definition at line 397 of file FN_field.hh.

References add_with_destination().

◆ add_with_destination() [2/4]

template<typename T >
int blender::fn::FieldEvaluator::add_with_destination ( Field< T field,
VMutableArray< T dst 
)
inline

Same as add_with_destination but typed.

Definition at line 378 of file FN_field.hh.

References add_with_destination().

◆ add_with_destination() [3/4]

int blender::fn::FieldEvaluator::add_with_destination ( GField  field,
GMutableSpan  dst 
)
Parameters
fieldField to add to the evaluator.
dstMutable span that the evaluated result for this field is be written into.
Note
When the output may only be used as a single value, the version of this function with a virtual array result array should be used.

Definition at line 726 of file field.cc.

References add_with_destination(), and blender::GVMutableArray::ForSpan().

◆ add_with_destination() [4/4]

int blender::fn::FieldEvaluator::add_with_destination ( GField  field,
GVMutableArray  dst 
)
Parameters
fieldField to add to the evaluator.
dstMutable virtual array that the evaluated result for this field is be written into.

Definition at line 718 of file field.cc.

References blender::Vector< T, InlineBufferCapacity, Allocator >::append().

Referenced by add_with_destination().

◆ evaluate()

void blender::fn::FieldEvaluator::evaluate ( )

◆ get_evaluated() [1/2]

template<typename T >
VArray<T> blender::fn::FieldEvaluator::get_evaluated ( const int  field_index)
inline

Definition at line 437 of file FN_field.hh.

References get_evaluated(), T, and blender::GVArray::typed().

◆ get_evaluated() [2/2]

const GVArray& blender::fn::FieldEvaluator::get_evaluated ( const int  field_index) const
inline

◆ get_evaluated_as_mask()

IndexMask blender::fn::FieldEvaluator::get_evaluated_as_mask ( int  field_index)

Retrieve the output of an evaluated boolean field and convert it to a mask, which can be used to avoid calculations for unnecessary elements later on. The evaluator will own the indices in some cases, so it must live at least as long as the returned mask.

Definition at line 784 of file field.cc.

References get_evaluated(), blender::VArrayCommon< T >::get_internal_single(), blender::fn::index_mask_from_selection(), blender::VArrayCommon< T >::is_single(), blender::VArrayCommon< T >::size(), and blender::GVArray::typed().

◆ get_evaluated_selection_as_mask()

IndexMask blender::fn::FieldEvaluator::get_evaluated_selection_as_mask ( )

◆ set_selection()

void blender::fn::FieldEvaluator::set_selection ( Field< bool selection)
inline

The selection field is evaluated first to determine which indices of the other fields should be evaluated. Calling this method multiple times will just replace the previously set selection field. Only the elements selected by both this selection and the selection provided in the constructor are calculated. If no selection field is set, it is assumed that all indices passed to the constructor are selected.

Definition at line 366 of file FN_field.hh.

Referenced by blender::nodes::node_geo_distribute_points_on_faces_cc::calc_full_density_factors_with_selection(), blender::nodes::node_geo_instances_to_points_cc::convert_instances_to_points(), blender::nodes::node_geo_duplicate_elements_cc::duplicate_faces(), blender::nodes::node_geo_scale_elements_cc::evaluate_axis_scale_fields(), blender::nodes::node_geo_scale_elements_cc::evaluate_uniform_scale_fields(), blender::nodes::node_geo_set_spline_cyclic_cc::set_cyclic_in_component(), blender::nodes::node_geo_set_id_cc::set_id_in_component(), blender::nodes::node_geo_set_material_index_cc::set_material_index_in_component(), blender::nodes::node_geo_set_curve_handles_cc::set_position_in_component(), blender::nodes::node_geo_set_position_cc::set_position_in_component(), blender::nodes::node_geo_set_curve_radius_cc::set_radius_in_component(), blender::nodes::node_geo_set_point_radius_cc::set_radius_in_component(), blender::nodes::node_geo_set_spline_resolution_cc::set_resolution_in_component(), blender::nodes::node_geo_set_shade_smooth_cc::set_smooth_in_component(), and blender::nodes::node_geo_set_curve_tilt_cc::set_tilt_in_component().


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