Unreal Engine 4.26 Documentation

Unreal Engine 4.27 Documentation

Unreal Engine 5.0 Documentation

Unreal Engine 5.1 Documentation

Unreal Engine 5.2 Documentation

Unreal Engine 5.3 Documentation

Light Theme

Dark Theme

UPhysicsFieldComponent

PhysicsFieldComponent

Windows

MacOS

Linux

Inheritance Hierarchy

UObjectBase

UObjectBaseUtility

UObject

UActorComponent

USceneComponent

UPhysicsFieldComponent

References

Module	Engine
Header	/Engine/Source/Runtime/Engine/Classes/PhysicsField/PhysicsFieldComponent.h
Include	#include "PhysicsField/PhysicsFieldComponent.h"

Syntax

class UPhysicsFieldComponent : public USceneComponent

Remarks

PhysicsFieldComponent

Variables

	Name	Description
FPhysicsFieldIn...	FieldInstance	The instance of the field system.
FPhysicsFieldSc...	FieldProxy	Scene proxy to be sent to the render thread.
TArray< FFieldS...	PersistentCommands	List of all the field persitent commands in the world
TArray< FFieldS...	TransientCommands	List of all the field transient commands in the world

Constructors

	Name	Description
	UPhysicsFieldComponent()	PhysicsFieldComponent

Functions

	Name	Description
void	AddPersistentCommand ( const FFieldSystemCommand& FieldCo..., const bool bIsGPUField )	Add the persitent field command
void	AddTransientCommand ( const FFieldSystemCommand& FieldCo..., const bool bIsGPUField )	Add the transient field command
void	BuildCommandBounds ( FFieldSystemCommand& FieldCommand )	Build the command bounds
void	FillPersistentCommands ( const bool bIsWorldField, const FBox& BoundingBox, const float TimeSeconds, TArray< FFieldSystemCommand >& Out... )	Fill the persistent commands intersecting the bounding box from the physics field
void	FillTransientCommands ( const bool bIsWorldField, const FBox& BoundingBox, const float TimeSeconds, TArray< FFieldSystemCommand >& Out... )	Fill the transient commands intersecting the bounding box from the physics field
void	RemovePersistentCommand ( const FFieldSystemCommand& FieldCo..., const bool bIsGPUField )	Remove the persitent field command
void	RemoveTransientCommand ( const FFieldSystemCommand& FieldCo..., const bool bIsGPUField )	Remove the transient field command

Overridden from UActorComponent

	Name	Description
void	CreateRenderState_Concurrent ( FRegisterComponentContext* Con... )	Used to create any rendering thread information for this component
void	DestroyRenderState_Concurrent()	Used to shut down any rendering thread structure for this component
void	OnRegister()	Called when a component is registered, after Scene is set, but before CreateRenderState_Concurrent or OnCreatePhysicsState are called.
void	OnUnregister()	Called when a component is unregistered.
void	SendRenderDynamicData_Concurrent()	Called to send dynamic data for this component to the rendering thread
void	TickComponent ( float DeltaTime, enum ELevelTick TickType, FActorComponentTickFunction* T... )	Function called every frame on this ActorComponent.

Help shape the future of Unreal Engine documentation! Tell us how we're doing so we can serve you better.

Take our survey

Dismiss