UDocumentation UE5.7 10.02.2026 (Source)
API documentation for Unreal Engine 5.7
FCullingField< T > Class Template Reference

#include <FieldSystemNodes.h>

+ Inheritance diagram for FCullingField< T >:

Public Member Functions

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

Public Attributes

TUniquePtr< FFieldNode< float > > Culling
 
TUniquePtr< FFieldNode< T > > Input
 
EFieldCullingOperationType Operation
 

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
}
 
- Static Public Member Functions inherited from FFieldNode< T >
static EFieldType StaticType ()
 

Detailed Description

template<class T>
class FCullingField< T >

FCullingField

Constructor & Destructor Documentation

◆ FCullingField()

template<class T >
FCullingField< T >::FCullingField ( FFieldNode< float > *  CullingIn = nullptr,
FFieldNode< T > *  InputIn = nullptr,
EFieldCullingOperationType  OperationIn = EFieldCullingOperationType::Field_Culling_Inside 
)
inline

◆ ~FCullingField()

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

Member Function Documentation

◆ ComputeFieldBounds()

template<class T >
void FCullingField< T >::ComputeFieldBounds ( FVector MinBounds,
FVector MaxBounds,
FVector CenterPosition 
) const
overridevirtual

Compute the min/max spatial bounds of the field

Reimplemented from FFieldNodeBase.

◆ EvalMaxMagnitude()

template<class T >
float FCullingField< T >::EvalMaxMagnitude ( ) const
overridevirtual

Evaluate the maximum magnitude of the field graph

Reimplemented from FFieldNodeBase.

◆ Evaluate()

template<class T >
void FCullingField< T >::Evaluate ( FFieldContext Context,
TFieldArrayView< T > &  Results 
) const
overridevirtual

FCullingField<T>

Implements FFieldNode< T >.

◆ FillSetupCount()

template<class T >
void FCullingField< T >::FillSetupCount ( int32 NumOffsets,
int32 NumParams 
) const
overridevirtual

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

Reimplemented from FFieldNode< T >.

◆ FillSetupDatas()

template<class T >
void FCullingField< T >::FillSetupDatas ( TArray< int32 > &  NodesOffsets,
TArray< float > &  NodesParams,
const float  CommandTime 
) const
overridevirtual

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

Reimplemented from FFieldNode< T >.

◆ NewCopy()

template<class T >
virtual FFieldNodeBase * FCullingField< T >::NewCopy ( ) const
inlineoverridevirtual

Implements FFieldNodeBase.

◆ operator==()

template<class T >
bool FCullingField< T >::operator== ( const FFieldNodeBase Node)
overridevirtual

Reimplemented from FFieldNodeBase.

◆ SerializationType()

template<class T >
virtual FFieldNodeBase::ESerializationType FCullingField< T >::SerializationType ( ) const
inlineoverridevirtual

Serialization API

Reimplemented from FFieldNodeBase.

◆ Serialize()

template<class T >
void FCullingField< T >::Serialize ( FArchive Ar)
overridevirtual

Reimplemented from FFieldNodeBase.

Member Data Documentation

◆ Culling

template<class T >
TUniquePtr< FFieldNode<float> > FCullingField< T >::Culling

◆ Input

template<class T >
TUniquePtr< FFieldNode<T> > FCullingField< T >::Input

◆ Operation

template<class T >
EFieldCullingOperationType FCullingField< T >::Operation

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