UPhysicsFieldComponent

PhysicsFieldComponent

Choose your operating system:

Windows

macOS

Linux

Inheritance Hierarchy

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

Public variable

FPhysicsFieldIn...

 

DebugInstance

The instance of the CPU field system.

Public variable

FPhysicsFieldIn...

 

FieldInstance

The instance of the GPU field system.

Public variable

FPhysicsFieldSc...

 

FieldProxy

Scene proxy to be sent to the render thread.

Public variable

TArray< FFieldS...

 

PersistentCommands

List of all the field persitent commands in the world

Public variable

TArray< FFieldS...

 

TransientCommands

List of all the field transient commands in the world

Constructors

Name Description

Public function

UPhysicsFieldComponent()

PhysicsFieldComponent

Functions

Name Description

Public function

void

 

AddPersistentCommand

(
    const FFieldSystemCommand& FieldCo...,
    const bool bIsGPUField
)

Add the persitent field command

Public function

void

 

AddTransientCommand

(
    const FFieldSystemCommand& FieldCo...,
    const bool bIsGPUField
)

Add the transient field command

Public function Static

void

 

BuildCommandBounds

(
    FFieldSystemCommand& FieldCommand
)

Build the command bounds

Public function Const

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

Public function Const

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

Public function

void

 

RemovePersistentCommand

(
    const FFieldSystemCommand& FieldCo...,
    const bool bIsGPUField
)

Remove the persitent field command

Public function

void

 

RemoveTransientCommand

(
    const FFieldSystemCommand& FieldCo...,
    const bool bIsGPUField
)

Remove the transient field command

Overridden from UActorComponent

Name Description

Public function Virtual

void

 

CreateRenderState_Concurrent

(
    FRegisterComponentContext* Con...
)

Used to create any rendering thread information for this component

Public function Virtual

void

 

DestroyRenderState_Concurrent()

Used to shut down any rendering thread structure for this component

Public function Virtual

void

 

OnRegister()

Called when a component is registered, after Scene is set, but before CreateRenderState_Concurrent or OnCreatePhysicsState are called.

Public function Virtual

void

 

OnUnregister()

Called when a component is unregistered.

Public function Virtual

void

 

SendRenderDynamicData_Concurrent()

Called to send dynamic data for this component to the rendering thread

Public function Virtual

void

 

TickComponent

(
    float DeltaTime,
    enum ELevelTick TickType,
    FActorComponentTickFunction* T...
)

Function called every frame on this ActorComponent.