FFieldNodeBase Class Reference

#include <FieldSystem.h>

Inheritance diagram for FFieldNodeBase:

Public Types
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 }

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

Detailed Description

FFieldNodeBase

Abstract base class for the field node evaluation.

Member Enumeration Documentation

EFieldType

enum FFieldNodeBase::EFieldType

Enumerator
EField_None
EField_Results
EField_Int32
EField_Float
EField_FVector

ESerializationType

enum FFieldNodeBase::ESerializationType

Enumerator
FieldNode_Null
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

Constructor & Destructor Documentation

FFieldNodeBase()

FFieldNodeBase::FFieldNodeBase ( )

inline

~FFieldNodeBase()

virtual FFieldNodeBase::~FFieldNodeBase ( )

inlinevirtual

Member Function Documentation

ComputeFieldBounds()

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

inlinevirtual

Compute the min/max spatial bounds of the field

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

EvalMaxMagnitude()

virtual float FFieldNodeBase::EvalMaxMagnitude ( ) const

inlinevirtual

Evaluate the maximum magnitude of the field graph

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

FillSetupCount()

virtual void FFieldNodeBase::FillSetupCount ( int32 &  NumOffsets, int32 &  NumParams  ) const

inlinevirtual

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

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

FillSetupDatas()

virtual void FFieldNodeBase::FillSetupDatas ( TArray< int32 > &  NodesOffsets, TArray< float > &  NodesParams, const float  CommandTime  ) const

inlinevirtual

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

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

GetName()

FName FFieldNodeBase::GetName ( ) const

inline

NewCopy()

virtual FFieldNodeBase * FFieldNodeBase::NewCopy ( ) const

pure virtual

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

operator==()

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

inlinevirtual

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

SerializationType()

virtual ESerializationType FFieldNodeBase::SerializationType ( ) const

inlinevirtual

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

Serialize()

virtual void FFieldNodeBase::Serialize ( FArchive &  Ar )

inlinevirtual

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

SetName()

void FFieldNodeBase::SetName ( const FName &  NameIn )

inline

Type()

virtual EFieldType FFieldNodeBase::Type ( ) const

inlinevirtual

Reimplemented in FFieldNode< T >, FFieldNode< float >, FFieldNode< FVector >, FFieldNode< int32 >, and FFieldNode< OutT >.

---

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

• Engine/Source/Runtime/Experimental/Chaos/Public/Field/FieldSystem.h