FFieldSystemCommand Class Reference

#include <FieldSystem.h>

Public Member Functions
	FFieldSystemCommand ()
	FFieldSystemCommand (const FName &TargetAttributeIn, FFieldNodeBase *RootNodeIn)
	FFieldSystemCommand (const EFieldPhysicsType PhsyicsTypeIn, FFieldNodeBase *RootNodeIn)
	FFieldSystemCommand (const FFieldSystemCommand &Other)
bool	HasMetaData (const FFieldSystemMetaData::EMetaType Key) const
const TUniquePtr< FFieldSystemMetaData > &	GetMetaData (const FFieldSystemMetaData::EMetaType Key) const
template<class TMetaData >
const TMetaData *	GetMetaDataAs (const FFieldSystemMetaData::EMetaType Key) const
void	SetMetaData (const FFieldSystemMetaData::EMetaType Key, TUniquePtr< FFieldSystemMetaData > &&Value)
void	SetMetaData (const FFieldSystemMetaData::EMetaType Key, FFieldSystemMetaData *Value)
void	InitFieldNodes (const double TimeSeconds, const FName &Name)
CHAOS_API void	Serialize (FArchive &Ar)
CHAOS_API bool	operator== (const FFieldSystemCommand &) const
bool	operator!= (const FFieldSystemCommand &Other) const

Public Attributes
FName	TargetAttribute
TUniquePtr< FFieldNodeBase >	RootNode
FName	CommandName
float	TimeCreation
FBox	BoundingBox
EFieldPhysicsType	PhysicsType
float	MaxMagnitude
FVector	CenterPosition
TMap< FFieldSystemMetaData::EMetaType, TUniquePtr< FFieldSystemMetaData > >	MetaData

Detailed Description

FieldCommand

Field commands are issued on the game thread and trigger field evaluation during game play. The Commands will store the root node in the evaluation graph, and will trigger a full evaluation of all the nodes in the graph. The MetaData within the command will be passed to the evaluation of the field.

Constructor & Destructor Documentation

FFieldSystemCommand() [1/4]

FFieldSystemCommand::FFieldSystemCommand ( )

inline

FFieldSystemCommand() [2/4]

FFieldSystemCommand::FFieldSystemCommand ( const FName &  TargetAttributeIn, FFieldNodeBase *  RootNodeIn  )

inline

FFieldSystemCommand() [3/4]

FFieldSystemCommand::FFieldSystemCommand ( const EFieldPhysicsType  PhsyicsTypeIn, FFieldNodeBase *  RootNodeIn  )

inline

FFieldSystemCommand() [4/4]

FFieldSystemCommand::FFieldSystemCommand ( const FFieldSystemCommand &  Other )

inline

Member Function Documentation

GetMetaData()

const TUniquePtr< FFieldSystemMetaData > & FFieldSystemCommand::GetMetaData ( const FFieldSystemMetaData::EMetaType  Key ) const

inline

GetMetaDataAs()

template<class TMetaData >

const TMetaData * FFieldSystemCommand::GetMetaDataAs ( const FFieldSystemMetaData::EMetaType  Key ) const

inline

HasMetaData()

bool FFieldSystemCommand::HasMetaData ( const FFieldSystemMetaData::EMetaType  Key ) const

inline

InitFieldNodes()

void FFieldSystemCommand::InitFieldNodes ( const double  TimeSeconds, const FName &  Name  )

inline

operator!=()

bool FFieldSystemCommand::operator!= ( const FFieldSystemCommand &  Other ) const

inline

operator==()

bool FFieldSystemCommand::operator==

(

const FFieldSystemCommand &

CommandIn

)

const

Serialize()

void FFieldSystemCommand::Serialize

(

FArchive &

Ar

)

SetMetaData() [1/2]

void FFieldSystemCommand::SetMetaData ( const FFieldSystemMetaData::EMetaType  Key, FFieldSystemMetaData *  Value  )

inline

SetMetaData() [2/2]

void FFieldSystemCommand::SetMetaData ( const FFieldSystemMetaData::EMetaType  Key, TUniquePtr< FFieldSystemMetaData > &&  Value  )

inline

Member Data Documentation

BoundingBox

FBox FFieldSystemCommand::BoundingBox

CenterPosition

FVector FFieldSystemCommand::CenterPosition

CommandName

FName FFieldSystemCommand::CommandName

MaxMagnitude

float FFieldSystemCommand::MaxMagnitude

MetaData

TMap<FFieldSystemMetaData::EMetaType, TUniquePtr<FFieldSystemMetaData> > FFieldSystemCommand::MetaData

PhysicsType

EFieldPhysicsType FFieldSystemCommand::PhysicsType

RootNode

TUniquePtr<FFieldNodeBase> FFieldSystemCommand::RootNode

TargetAttribute

FName FFieldSystemCommand::TargetAttribute

TimeCreation

float FFieldSystemCommand::TimeCreation

---

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

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