Blender V5.3
FN_field.hh File Reference

Go to the source code of this file.

Classes

class  blender::fn::GField
struct  blender::fn::GField::Input
struct  blender::fn::GField::MultiFn
struct  blender::fn::GField::FieldRef
struct  blender::fn::GField::ConstantRef
struct  blender::fn::GField::TrivialInlineConstant
struct  blender::fn::GField::OwnedConstant
class  blender::fn::Field< T >
class  blender::fn::GFieldRef
struct  blender::fn::GFieldRef::Value
struct  blender::fn::GFieldRef::Input
struct  blender::fn::GFieldRef::MultiFn
class  blender::fn::FieldContext
struct  blender::fn::FieldHashDeep
class  blender::fn::FieldInputs
class  blender::fn::FieldInput
class  blender::fn::FieldOperation
class  blender::fn::IndexFieldInput

Namespaces

namespace  blender
 BMesh Iterators.
namespace  blender::fn

Typedefs

using blender::fn::FieldInputPtr = ImplicitSharingPtr<FieldInput>
using blender::fn::FieldOperationPtr = ImplicitSharingPtr<FieldOperation>
using blender::fn::FieldInputsPtr = ImplicitSharingPtr<FieldInputs>

Functions

bool blender::fn::operator== (const GField &a, const GField &b)
bool blender::fn::operator== (const GFieldRef &a, const GFieldRef &b)
Field< bool > blender::fn::invert_boolean_field (const Field< bool > &field)
Inline Methods
template<typename T>
bool blender::fn::operator== (const Field< T > &a, const Field< T > &b)
bool blender::fn::operator== (const FieldInput &a, const FieldInput &b)

Variables

template<typename T>
constexpr bool blender::fn::is_field_v = false
template<typename T>
constexpr bool blender::fn::is_field_v< Field< T > > = true

Detailed Description

A #Field represents a function that outputs a value based on an arbitrary number of inputs. The inputs for a specific field evaluation are provided by a #FieldContext.

A typical example is a field that computes a displacement vector for every vertex on a mesh based on its position.

Fields can be built, composed and evaluated at run-time. They are stored in a directed tree graph data structure. A field may generally depend on other fields.

When fields are evaluated, they are converted into a multi-function procedure which allows efficient computation. In the future, we might support different field evaluation mechanisms for e.g. the following scenarios:

  • Latency of a single evaluation is more important than throughput.
  • Evaluation should happen on other hardware like GPUs.

Whenever possible, multiple fields should be evaluated together to avoid duplicate work when they share common sub-fields and a common context.

Definition in file FN_field.hh.