UDocumentation UE5.7 10.02.2026 (Source)
API documentation for Unreal Engine 5.7
Public Member Functions | Static Public Member Functions | List of all members
FFieldNode< T > Class Template Referenceabstract

#include <FieldSystem.h>

+ Inheritance diagram for FFieldNode< T >:

Public Member Functions

virtual ~FFieldNode ()
 
virtual void Evaluate (FFieldContext &, TFieldArrayView< T > &Results) const =0
 
virtual EFieldType Type () const
 
virtual void FillSetupCount (int32 &NumOffsets, int32 &NumParams) const override
 
virtual void FillSetupDatas (TArray< int32 > &NodesOffsets, TArray< float > &NodesParams, const float CommandTime) const override
 
- Public Member Functions inherited from FFieldNodeBase
 FFieldNodeBase ()
 
virtual ~FFieldNodeBase ()
 
virtual ESerializationType SerializationType () const
 
virtual FFieldNodeBase * NewCopy () const =0
 
virtual void Serialize (FArchive &Ar)
 
virtual bool operator== (const FFieldNodeBase &Node)
 
virtual float EvalMaxMagnitude () const
 
virtual void ComputeFieldBounds (FVector &MinBounds, FVector &MaxBounds, FVector &CenterPosition) const
 
FName GetName () const
 
void SetName (const FName &NameIn)
 

Static Public Member Functions

static EFieldType StaticType ()
 

Additional Inherited Members

- Public Types inherited from FFieldNodeBase
enum  EFieldType {
  EField_None = 0 , EField_Results , EField_Int32 , EField_Float ,
  EField_FVector
}
 
enum  ESerializationType {
  FieldNode_Null = 0 , FieldNode_FUniformInteger , FieldNode_FRadialIntMask , FieldNode_FUniformScalar ,
  FieldNode_FRadialFalloff , FieldNode_FPlaneFalloff , FieldNode_FBoxFalloff , FieldNode_FNoiseField ,
  FieldNode_FUniformVector , FieldNode_FRadialVector , FieldNode_FRandomVector , FieldNode_FSumScalar ,
  FieldNode_FSumVector , FieldNode_FConversionField , FieldNode_FCullingField , FieldNode_FWaveScalar ,
  FieldNode_FReturnResultsTerminal
}
 

Detailed Description

template<class T>
class FFieldNode< T >

FieldNode<T>

Typed field nodes are used for the evaluation of specific types of data arrays. For exampe, The FFieldNode<FVector>::Evaluate(...) will expect resutls of type TFieldArrayView<FVector>, and an example implementation is the UniformVectorField.

Constructor & Destructor Documentation

◆ ~FFieldNode()

template<class T >
virtual FFieldNode< T >::~FFieldNode ( )
inlinevirtual

Member Function Documentation

◆ Evaluate()

template<class T >
virtual void FFieldNode< T >::Evaluate ( FFieldContext &  ,
TFieldArrayView< T > &  Results 
) const
pure virtual

Implemented in FUniformScalar, FWaveScalar, FRadialFalloff, FPlaneFalloff, FBoxFalloff, FNoiseField, FSumScalar, FUniformVector, FRadialVector, FRandomVector, FSumVector, FUniformInteger, FRadialIntMask, FConversionField< InT, OutT >, FCullingField< T >, and FReturnResultsTerminal< T >.

◆ FillSetupCount()

template<class T >
virtual void FFieldNode< T >::FillSetupCount ( int32 &  NumOffsets,
int32 &  NumParams 
) const
inlineoverridevirtual

Count the number of offsets/params that will be used by the world physics field

Reimplemented from FFieldNodeBase.

Reimplemented in FUniformInteger, FRadialIntMask, FUniformScalar, FWaveScalar, FRadialFalloff, FPlaneFalloff, FBoxFalloff, FNoiseField, FUniformVector, FRadialVector, FRandomVector, FSumScalar, FSumVector, FConversionField< InT, OutT >, and FCullingField< T >.

◆ FillSetupDatas()

template<class T >
virtual void FFieldNode< T >::FillSetupDatas ( TArray< int32 > &  NodesOffsets,
TArray< float > &  NodesParams,
const float  CommandTime 
) const
inlineoverridevirtual

Fill the offsets/params arrays that will be used by the world physics field

Reimplemented from FFieldNodeBase.

Reimplemented in FUniformInteger, FRadialIntMask, FUniformScalar, FWaveScalar, FRadialFalloff, FPlaneFalloff, FBoxFalloff, FNoiseField, FUniformVector, FRadialVector, FRandomVector, FSumScalar, FSumVector, FConversionField< InT, OutT >, and FCullingField< T >.

◆ StaticType()

template<class T >
static EFieldType FFieldNode< T >::StaticType ( )
static

◆ Type()

template<class T >
virtual EFieldType FFieldNode< T >::Type ( ) const
inlinevirtual

Reimplemented from FFieldNodeBase.

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