UDocumentation UE5.7 10.02.2026 (Source)
API documentation for Unreal Engine 5.7
FRadialFalloff Class Reference

#include <FieldSystemNodes.h>

+ Inheritance diagram for FRadialFalloff:

Public Member Functions

 FRadialFalloff (float MagnitudeIn=1.f, float MinRangeIn=0.f, float MaxRangeIn=1.f, float DefaultIn=0.f, float RadiusIn=0.f, FVector PositionIn=FVector(0, 0, 0), EFieldFalloffType FalloffIn=EFieldFalloffType::Field_Falloff_Linear)
 
virtual FFieldNodeBaseNewCopy () const override
 
virtual ~FRadialFalloff ()
 
virtual CHAOS_API void Evaluate (FFieldContext &, TFieldArrayView< float > &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< float >
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

float Magnitude
 
float MinRange
 
float MaxRange
 
float Default
 
float Radius
 
FVector Position
 
EFieldFalloffType Falloff
 

Protected Member Functions

template<EFieldFalloffType >
void Evaluator (const FFieldContext &Context, TFieldArrayView< float > &Results) const
 

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< float >
static EFieldType StaticType ()
 

Detailed Description

RadialFalloff

Constructor & Destructor Documentation

◆ FRadialFalloff()

FRadialFalloff::FRadialFalloff ( float  MagnitudeIn = 1.f,
float  MinRangeIn = 0.f,
float  MaxRangeIn = 1.f,
float  DefaultIn = 0.f,
float  RadiusIn = 0.f,
FVector  PositionIn = FVector(0, 0, 0),
EFieldFalloffType  FalloffIn = EFieldFalloffType::Field_Falloff_Linear 
)
inline

◆ ~FRadialFalloff()

virtual FRadialFalloff::~FRadialFalloff ( )
inlinevirtual

Member Function Documentation

◆ ComputeFieldBounds()

void FRadialFalloff::ComputeFieldBounds ( FVector MinBounds,
FVector MaxBounds,
FVector CenterPosition 
) const
overridevirtual

Compute the min/max spatial bounds of the field

Reimplemented from FFieldNodeBase.

◆ EvalMaxMagnitude()

float FRadialFalloff::EvalMaxMagnitude ( ) const
overridevirtual

Evaluate the maximum magnitude of the field graph

Reimplemented from FFieldNodeBase.

◆ Evaluate()

void FRadialFalloff::Evaluate ( FFieldContext Context,
TFieldArrayView< float > &  Results 
) const
overridevirtual

Implements FFieldNode< float >.

◆ Evaluator()

template<EFieldFalloffType FalloffType>
void FRadialFalloff::Evaluator ( const FFieldContext Context,
TFieldArrayView< float > &  Results 
) const
protected

◆ FillSetupCount()

void FRadialFalloff::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< float >.

◆ FillSetupDatas()

void FRadialFalloff::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< float >.

◆ NewCopy()

virtual FFieldNodeBase * FRadialFalloff::NewCopy ( ) const
inlineoverridevirtual

Implements FFieldNodeBase.

◆ operator==()

bool FRadialFalloff::operator== ( const FFieldNodeBase Node)
overridevirtual

Reimplemented from FFieldNodeBase.

◆ SerializationType()

virtual FFieldNodeBase::ESerializationType FRadialFalloff::SerializationType ( ) const
inlineoverridevirtual

Serialization API

Reimplemented from FFieldNodeBase.

◆ Serialize()

void FRadialFalloff::Serialize ( FArchive Ar)
overridevirtual

Reimplemented from FFieldNodeBase.

Member Data Documentation

◆ Default

float FRadialFalloff::Default

◆ Falloff

EFieldFalloffType FRadialFalloff::Falloff

◆ Magnitude

float FRadialFalloff::Magnitude

◆ MaxRange

float FRadialFalloff::MaxRange

◆ MinRange

float FRadialFalloff::MinRange

◆ Position

FVector FRadialFalloff::Position

◆ Radius

float FRadialFalloff::Radius

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