Blender V5.3
blender::bke::Field< T > Class Template Reference

#include <FN_field.hh>

Public Types

using base_type = T
using generic_type = GField

Static Public Member Functions

template<typename InputT, typename... Args>
static Field from_input (Args &&...args)

Inline Methods

 Field ()
 Field (FieldInputPtr node)
 Field (FieldOperationPtr node, int output_i=0)
 Field (T value)
 operator const GField & () const
bool depends_on_input () const
template<typename InputT, typename... Args>
Field< T > from_input (Args &&...args)
template<typename InputT>
const InputT * get_input_if () const
uint64_t hash () const
static Field from_non_owning_ref (const Field &field)

Detailed Description

template<typename T>
class blender::bke::Field< T >

A version of GField that should be used when the field type is known at compile time.

Definition at line 203 of file FN_field.hh.

Member Typedef Documentation

◆ base_type

template<typename T>
using blender::fn::Field< T >::base_type = T

Definition at line 205 of file FN_field.hh.

◆ generic_type

template<typename T>
using blender::fn::Field< T >::generic_type = GField

Definition at line 206 of file FN_field.hh.

Constructor & Destructor Documentation

◆ Field() [1/4]

template<typename T>
blender::fn::Field< T >::Field ( )
inline

Unlike GField, default construction is allowed here, because the type is known without extra arguments.

Definition at line 603 of file FN_field.hh.

◆ Field() [2/4]

template<typename T>
blender::fn::Field< T >::Field ( FieldInputPtr node)
inlineexplicit

Same as corresponding GField constructors.

Definition at line 605 of file FN_field.hh.

◆ Field() [3/4]

template<typename T>
blender::fn::Field< T >::Field ( FieldOperationPtr node,
int output_i = 0 )
inlineexplicit

Definition at line 609 of file FN_field.hh.

◆ Field() [4/4]

template<typename T>
blender::fn::Field< T >::Field ( T value)
inlineexplicit

Construct a field that just outputs the given value.

Definition at line 496 of file FN_field.hh.

Member Function Documentation

◆ depends_on_input()

template<typename T>
bool blender::fn::Field< T >::depends_on_input ( ) const
inline

These are the same as the corresponding GField methods.

Definition at line 513 of file FN_field.hh.

◆ from_input() [1/2]

template<typename T>
template<typename InputT, typename... Args>
Field< T > blender::fn::Field< T >::from_input ( Args &&... args)
inline

Definition at line 490 of file FN_field.hh.

◆ from_input() [2/2]

template<typename T>
template<typename InputT, typename... Args>
Field blender::fn::Field< T >::from_input ( Args &&... args)
static

◆ from_non_owning_ref()

template<typename T>
Field< T > blender::fn::Field< T >::from_non_owning_ref ( const Field< T > & field)
inlinestatic

Definition at line 477 of file FN_field.hh.

◆ get_input_if()

template<typename T>
template<typename InputT>
const InputT * blender::fn::Field< T >::get_input_if ( ) const
inline

Definition at line 649 of file FN_field.hh.

◆ hash()

template<typename T>
uint64_t blender::fn::Field< T >::hash ( ) const
inline

Definition at line 554 of file FN_field.hh.

◆ operator const GField &()

template<typename T>
blender::fn::Field< T >::operator const GField & ( ) const
inline

This is implicitly cast to GField which is always valid.

Definition at line 579 of file FN_field.hh.


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