UDocumentation UE5.7 10.02.2026 (Source)
API documentation for Unreal Engine 5.7
Public Member Functions | Public Attributes | List of all members
FWaveScalar Class Reference

#include <FieldSystemNodes.h>

+ Inheritance diagram for FWaveScalar:

Public Member Functions

 FWaveScalar (float MagnitudeIn=1.f, const FVector &PositionIn=FVector(0, 0, 0), const float WavelengthIn=1000, const float PeriodIn=1.0, const EWaveFunctionType FunctionIn=EWaveFunctionType::Field_Wave_Cosine, const EFieldFalloffType FallofffIn=EFieldFalloffType::Field_Falloff_Linear)
 
virtual FFieldNodeBase * NewCopy () const override
 
virtual ~FWaveScalar ()
 
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
 
FVector Position
 
float Wavelength
 
float Period
 
EWaveFunctionType Function
 
EFieldFalloffType Falloff
 

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

FWaveScalar

Constructor & Destructor Documentation

◆ FWaveScalar()

FWaveScalar::FWaveScalar ( float  MagnitudeIn = 1.f,
const FVector &  PositionIn = FVector(0,0,0),
const float  WavelengthIn = 1000,
const float  PeriodIn = 1.0,
const EWaveFunctionType  FunctionIn = EWaveFunctionType::Field_Wave_Cosine,
const EFieldFalloffType  FallofffIn = EFieldFalloffType::Field_Falloff_Linear 
)
inline

◆ ~FWaveScalar()

virtual FWaveScalar::~FWaveScalar ( )
inlinevirtual

Member Function Documentation

◆ ComputeFieldBounds()

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

Compute the min/max spatial bounds of the field

Reimplemented from FFieldNodeBase.

◆ EvalMaxMagnitude()

float FWaveScalar::EvalMaxMagnitude ( ) const
overridevirtual

Evaluate the maximum magnitude of the field graph

Reimplemented from FFieldNodeBase.

◆ Evaluate()

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

FWaveScalar

Implements FFieldNode< float >.

◆ FillSetupCount()

void FWaveScalar::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 FWaveScalar::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 * FWaveScalar::NewCopy ( ) const
inlineoverridevirtual

Implements FFieldNodeBase.

◆ operator==()

bool FWaveScalar::operator== ( const FFieldNodeBase &  Node)
overridevirtual

Reimplemented from FFieldNodeBase.

◆ SerializationType()

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

Serialization API

Reimplemented from FFieldNodeBase.

◆ Serialize()

void FWaveScalar::Serialize ( FArchive &  Ar)
overridevirtual

Reimplemented from FFieldNodeBase.

Member Data Documentation

◆ Falloff

EFieldFalloffType FWaveScalar::Falloff

◆ Function

EWaveFunctionType FWaveScalar::Function

◆ Magnitude

float FWaveScalar::Magnitude

◆ Period

float FWaveScalar::Period

◆ Position

FVector FWaveScalar::Position

◆ Wavelength

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