UPhysicsFieldComponent Class Reference

#include <PhysicsFieldComponent.h>

Inheritance diagram for UPhysicsFieldComponent:

Public Member Functions
ENGINE_API	UPhysicsFieldComponent ()
virtual ENGINE_API void	OnRegister () override
virtual ENGINE_API void	OnUnregister () override
virtual ENGINE_API void	TickComponent (float DeltaTime, enum ELevelTick TickType, FActorComponentTickFunction *ThisTickFunction) override
virtual ENGINE_API void	SendRenderDynamicData_Concurrent () override
virtual ENGINE_API void	CreateRenderState_Concurrent (FRegisterComponentContext *Context) override
virtual ENGINE_API void	DestroyRenderState_Concurrent () override
ENGINE_API void	AddTransientCommand (const FFieldSystemCommand &FieldCommand, const bool bIsGPUField)
ENGINE_API void	AddPersistentCommand (const FFieldSystemCommand &FieldCommand, const bool bIsGPUField)
ENGINE_API void	AddConstructionCommand (const FFieldSystemCommand &FieldCommand)
ENGINE_API void	RemoveTransientCommand (const FFieldSystemCommand &FieldCommand, const bool bIsGPUField)
ENGINE_API void	RemovePersistentCommand (const FFieldSystemCommand &FieldCommand, const bool bIsGPUField)
ENGINE_API void	FillTransientCommands (const bool bIsWorldField, const FBox &BoundingBox, const float TimeSeconds, TArray< FFieldSystemCommand > &OutputCommands) const
ENGINE_API void	FillPersistentCommands (const bool bIsWorldField, const FBox &BoundingBox, const float TimeSeconds, TArray< FFieldSystemCommand > &OutputCommands) const

Static Public Member Functions
static ENGINE_API void	BuildCommandBounds (FFieldSystemCommand &FieldCommand)

Public Attributes
TArray< FFieldSystemCommand >	TransientCommands [(uint8)(EFieldCommandBuffer::NumFieldBuffers)]
TArray< FFieldSystemCommand >	PersistentCommands [(uint8)(EFieldCommandBuffer::NumFieldBuffers)]
TArray< FFieldSystemCommand >	ConstructionCommands [(uint8)(EFieldCommandBuffer::NumFieldBuffers)]
FPhysicsFieldInstance *	FieldInstance = nullptr
FPhysicsFieldInstance *	DebugInstance = nullptr
class FPhysicsFieldSceneProxy *	FieldProxy = nullptr

Detailed Description

PhysicsFieldComponent

Constructor & Destructor Documentation

UPhysicsFieldComponent()

UPhysicsFieldComponent::UPhysicsFieldComponent

(

)

PhysicsFieldComponent

Member Function Documentation

AddConstructionCommand()

void UPhysicsFieldComponent::AddConstructionCommand

(

const FFieldSystemCommand &

FieldCommand

)

Add the construction field command

AddPersistentCommand()

void UPhysicsFieldComponent::AddPersistentCommand	(	const FFieldSystemCommand &	FieldCommand,
		const bool	bIsGPUField
	)

Add the persistent field command

AddTransientCommand()

void UPhysicsFieldComponent::AddTransientCommand	(	const FFieldSystemCommand &	FieldCommand,
		const bool	bIsGPUField
	)

Add the transient field command

BuildCommandBounds()

void UPhysicsFieldComponent::BuildCommandBounds ( FFieldSystemCommand &  FieldCommand )

static

Build the command bounds

CreateRenderState_Concurrent()

void UPhysicsFieldComponent::CreateRenderState_Concurrent ( FRegisterComponentContext *  Context )

overridevirtual

DestroyRenderState_Concurrent()

void UPhysicsFieldComponent::DestroyRenderState_Concurrent ( )

overridevirtual

FillPersistentCommands()

void UPhysicsFieldComponent::FillPersistentCommands	(	const bool	bIsWorldField,
		const FBox &	BoundingBox,
		const float	TimeSeconds,
		TArray< FFieldSystemCommand > &	OutputCommands
	)		const

Fill the persistent commands intersecting the bounding box from the physics field

FillTransientCommands()

void UPhysicsFieldComponent::FillTransientCommands	(	const bool	bIsWorldField,
		const FBox &	BoundingBox,
		const float	TimeSeconds,
		TArray< FFieldSystemCommand > &	OutputCommands
	)		const

Fill the transient commands intersecting the bounding box from the physics field

OnRegister()

void UPhysicsFieldComponent::OnRegister ( )

overridevirtual

OnUnregister()

void UPhysicsFieldComponent::OnUnregister ( )

overridevirtual

RemovePersistentCommand()

void UPhysicsFieldComponent::RemovePersistentCommand	(	const FFieldSystemCommand &	FieldCommand,
		const bool	bIsGPUField
	)

Remove the persistent field command

RemoveTransientCommand()

void UPhysicsFieldComponent::RemoveTransientCommand	(	const FFieldSystemCommand &	FieldCommand,
		const bool	bIsGPUField
	)

Remove the transient field command

SendRenderDynamicData_Concurrent()

void UPhysicsFieldComponent::SendRenderDynamicData_Concurrent ( )

overridevirtual

TickComponent()

void UPhysicsFieldComponent::TickComponent ( float  DeltaTime, enum ELevelTick  TickType, FActorComponentTickFunction *  ThisTickFunction  )

overridevirtual

Member Data Documentation

ConstructionCommands

TArray<FFieldSystemCommand> UPhysicsFieldComponent::ConstructionCommands[(uint8)(EFieldCommandBuffer::NumFieldBuffers)]

List of all the field construction commands in the world

DebugInstance

FPhysicsFieldInstance* UPhysicsFieldComponent::DebugInstance = nullptr

The instance of the CPU field system.

FieldInstance

FPhysicsFieldInstance* UPhysicsFieldComponent::FieldInstance = nullptr

The instance of the GPU field system.

FieldProxy

class FPhysicsFieldSceneProxy* UPhysicsFieldComponent::FieldProxy = nullptr

Scene proxy to be sent to the render thread.

PersistentCommands

TArray<FFieldSystemCommand> UPhysicsFieldComponent::PersistentCommands[(uint8)(EFieldCommandBuffer::NumFieldBuffers)]

List of all the field persistent commands in the world

TransientCommands

TArray<FFieldSystemCommand> UPhysicsFieldComponent::TransientCommands[(uint8)(EFieldCommandBuffer::NumFieldBuffers)]

List of all the field transient commands in the world

---

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

• Engine/Source/Runtime/Engine/Classes/PhysicsField/PhysicsFieldComponent.h
• Engine/Source/Runtime/Engine/Private/PhysicsField/PhysicsFieldComponent.cpp