FPlaneFalloff Class Reference

#include <FieldSystemNodes.h>

Inheritance diagram for FPlaneFalloff:

Public Member Functions
	FPlaneFalloff (float MagnitudeIn=1.f, float MinRangeIn=0.f, float MaxRangeIn=1.f, float DefaultIn=0.f, float DistanceIn=0.f, FVector PositionIn=FVector(0, 0, 0), FVector NormalIn=FVector(0, 0, 1), EFieldFalloffType FalloffIn=EFieldFalloffType::Field_Falloff_Linear)
virtual FFieldNodeBase *	NewCopy () const override
virtual	~FPlaneFalloff ()
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	Distance
FVector	Position
FVector	Normal
EFieldFalloffType	Falloff

Protected Member Functions
template<EFieldFalloffType >
void	Evaluator (const FFieldContext &Context, const FPlane &Plane, 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

FPlaneFalloff

Constructor & Destructor Documentation

FPlaneFalloff()

FPlaneFalloff::FPlaneFalloff ( float  MagnitudeIn = 1.f, float  MinRangeIn = 0.f, float  MaxRangeIn = 1.f, float  DefaultIn = 0.f, float  DistanceIn = 0.f, FVector  PositionIn = FVector(0, 0, 0), FVector  NormalIn = FVector(0, 0, 1), EFieldFalloffType  FalloffIn = EFieldFalloffType::Field_Falloff_Linear  )

inline

~FPlaneFalloff()

virtual FPlaneFalloff::~FPlaneFalloff ( )

inlinevirtual

Member Function Documentation

ComputeFieldBounds()

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

overridevirtual

Compute the min/max spatial bounds of the field

Reimplemented from FFieldNodeBase.

EvalMaxMagnitude()

float FPlaneFalloff::EvalMaxMagnitude ( ) const

overridevirtual

Evaluate the maximum magnitude of the field graph

Reimplemented from FFieldNodeBase.

Evaluate()

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

overridevirtual

Implements FFieldNode< float >.

Evaluator()

template<EFieldFalloffType FalloffType>

void FPlaneFalloff::Evaluator ( const FFieldContext &  Context, const FPlane &  Plane, TFieldArrayView< float > &  Results  ) const

protected

FPlaneFalloff

FillSetupCount()

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

inlineoverridevirtual

Implements FFieldNodeBase.

operator==()

bool FPlaneFalloff::operator== ( const FFieldNodeBase &  Node )

overridevirtual

Reimplemented from FFieldNodeBase.

SerializationType()

virtual FFieldNodeBase::ESerializationType FPlaneFalloff::SerializationType ( ) const

inlineoverridevirtual

Serialization API

Reimplemented from FFieldNodeBase.

Serialize()

void FPlaneFalloff::Serialize ( FArchive &  Ar )

overridevirtual

Reimplemented from FFieldNodeBase.

Member Data Documentation

Default

float FPlaneFalloff::Default

Distance

float FPlaneFalloff::Distance

Falloff

EFieldFalloffType FPlaneFalloff::Falloff

Magnitude

float FPlaneFalloff::Magnitude

MaxRange

float FPlaneFalloff::MaxRange

MinRange

float FPlaneFalloff::MinRange

Normal

FVector FPlaneFalloff::Normal

Position

FVector FPlaneFalloff::Position

---

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

• Engine/Source/Runtime/Experimental/Chaos/Public/Field/FieldSystemNodes.h
• Engine/Source/Runtime/Experimental/Chaos/Private/Field/FieldSystemNodes.cpp