#include <FN_field_evaluation.hh>
Inherits blender::blender::NonMovable, and blender::blender::NonCopyable.
Utility class that makes it easier to evaluate fields.
Definition at line 21 of file FN_field_evaluation.hh.
◆ FieldEvaluator() [1/2]
◆ FieldEvaluator() [2/2]
◆ ~FieldEvaluator()
◆ add() [1/4]
- Parameters
-
| field | Field to add to the evaluator. |
| varray_ptr | Once 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 112 of file FN_field_evaluation.hh.
◆ add() [2/4]
◆ add() [3/4]
◆ add() [4/4]
◆ add_with_destination() [1/4]
- Parameters
-
| field | Field to add to the evaluator. |
| dst | Mutable 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 99 of file FN_field_evaluation.hh.
◆ add_with_destination() [2/4]
◆ add_with_destination() [3/4]
- Parameters
-
| field | Field to add to the evaluator. |
| dst | Mutable 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 556 of file field_evaluation.cc.
◆ add_with_destination() [4/4]
- Parameters
-
| field | Field to add to the evaluator. |
| dst | Mutable virtual array that the evaluated result for this field is be written into. |
Definition at line 548 of file field_evaluation.cc.
◆ evaluate()
Evaluate all fields on the evaluator. This can only be called once.
Definition at line 590 of file field_evaluation.cc.
◆ evaluation_mask()
◆ get_evaluated() [1/2]
◆ get_evaluated() [2/2]
◆ get_evaluated_as_mask()
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 622 of file field_evaluation.cc.
◆ get_evaluated_selection_as_mask()
◆ set_selection()
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 68 of file FN_field_evaluation.hh.
The documentation for this class was generated from the following files: