1. Epic GamesDeveloper
  3. UMoverNetworkPhysicsLiaisonComponentBase

UMoverNetworkPhysicsLiaisonComponentBase

Base class for liaison components to act as a middleman between an actor's Mover component and the Chaos physics network prediction system to move the Mover's updated component on the physics thread (PT).

API > API/Plugins > API/Plugins/Mover

Base class for liaison components to act as a middleman between an actor's Mover component and the Chaos physics network prediction system to move the Mover's updated component on the physics thread (PT).

This is accomplished by registering a FPhysicsMoverManagerAsyncCallback and exposing the game thread (GT) and PT methods for the TSimCallback to virtual methods on this liaison.

   
Name UMoverNetworkPhysicsLiaisonComponentBase
Type class
Header File /Engine/Plugins/Experimental/Mover/Source/Mover/Public/Backends/MoverNetworkPhysicsLiaisonBase.h
Include Path #include "Backends/MoverNetworkPhysicsLiaisonBase.h"

Syntax

UCLASS (MinimalAPI, Abstract, Within=MoverComponent)  
class UMoverNetworkPhysicsLiaisonComponentBase :  
    public UActorComponent ,  
    public IMoverBackendLiaisonInterface

Inheritance Hierarchy

Implements Interfaces

Derived Classes

Constructors

Name Remarks Include Path Unreal Specifiers

UMoverNetworkPhysicsLiaisonComponentBase()

   Backends/MoverNetworkPhysicsLiaisonBase.h  

Functions

Public

Name Remarks Include Path Unreal Specifiers

virtual bool CanCreatePhysics()

   Backends/MoverNetworkPhysicsLiaisonBase.h  

virtual void ConsumeOutput_External ( const FPhysicsMoverAsyncOutput& Output,
double OutputTimeInSeconds
)

   Backends/MoverNetworkPhysicsLiaisonBase.h  

void GetCurrentInputData ( FMoverInputCmdContext& InputCmd
) const

 Required for Network Physics Rewind/Resim data. Backends/MoverNetworkPhysicsLiaisonBase.h  

void GetCurrentStateData ( FMoverSyncState& SyncState
) const

   Backends/MoverNetworkPhysicsLiaisonBase.h  

Chaos::FUniqueIdx GetUniqueIdx()

 Used by the manager to uniquely identify the component. Backends/MoverNetworkPhysicsLiaisonBase.h  

virtual void OnContactModification_Internal ( const FPhysicsMoverAsyncInput& Input,
Chaos::FCollisionContactModifier& Modifier
) const

   Backends/MoverNetworkPhysicsLiaisonBase.h  

virtual void PostPhysicsUpdate_External()

   Backends/MoverNetworkPhysicsLiaisonBase.h  

void PreSimulate_Internal ( const FPhysicsMoverSimulationTickParams& TickParams,
const FPhysicsMoverAsyncInput& Input,
FPhysicsMoverAsyncOutput& Output
) const

   Backends/MoverNetworkPhysicsLiaisonBase.h  

void ProcessInputs_Internal ( int32 PhysicsStep,
float DeltaTime,
const FPhysicsMoverAsyncInput& Input
) const

 "Internal" = Called on the Physics Thread (PT) Backends/MoverNetworkPhysicsLiaisonBase.h  

void ProduceInput_External ( int32 PhysicsStep,
int32 NumSteps,
FPhysicsMoverAsyncInput& Input
)

 "External" = Called on the Game Thread (GT) Backends/MoverNetworkPhysicsLiaisonBase.h  

void SetCurrentInputData ( const FMoverInputCmdContext& InputCmd
)

   Backends/MoverNetworkPhysicsLiaisonBase.h  

void SetCurrentStateData ( const FMoverSyncState& SyncState
)

   Backends/MoverNetworkPhysicsLiaisonBase.h  

bool ValidateInputData ( FMoverInputCmdContext& InputCmd
) const

   Backends/MoverNetworkPhysicsLiaisonBase.h  

Overridden from UActorComponent

Name Remarks Include Path Unreal Specifiers

virtual void BeginPlay()

   Backends/MoverNetworkPhysicsLiaisonBase.h  

virtual void EndPlay ( const EEndPlayReason::Type EndPlayReason
)

   Backends/MoverNetworkPhysicsLiaisonBase.h  

virtual void InitializeComponent()

   Backends/MoverNetworkPhysicsLiaisonBase.h  

virtual void OnRegister()

   Backends/MoverNetworkPhysicsLiaisonBase.h  

virtual void OnUnregister()

   Backends/MoverNetworkPhysicsLiaisonBase.h  

virtual bool ShouldCreatePhysicsState()

   Backends/MoverNetworkPhysicsLiaisonBase.h  

virtual void UninitializeComponent()

   Backends/MoverNetworkPhysicsLiaisonBase.h  

Overridden from IMoverBackendLiaisonInterface

Name Remarks Include Path Unreal Specifiers

virtual int32 GetCurrentSimFrame()

   Backends/MoverNetworkPhysicsLiaisonBase.h  

virtual float GetCurrentSimTimeMs()

   Backends/MoverNetworkPhysicsLiaisonBase.h  

virtual EDataValidationResult ValidateData ( FDataValidationContext& Context,
const UMoverComponent& ValidationMoverComp
) const

   Backends/MoverNetworkPhysicsLiaisonBase.h  

Protected

Name Remarks Include Path Unreal Specifiers

virtual bool CanProcessInputs_Internal ( const FPhysicsMoverAsyncInput& Input
) const

 Called at the beginning of PreSimulate_Internal to verify that everything is in order. Backends/MoverNetworkPhysicsLiaisonBase.h  

virtual bool CanSimulate_Internal ( const FPhysicsMoverSimulationTickParams& TickParams,
const FPhysicsMoverAsyncInput& Input
) const

 Called at the beginning of PreSimulate_Internal to verify that everything is in order. Backends/MoverNetworkPhysicsLiaisonBase.h  

Chaos::FPBDRigidParticle * GetControlledParticle_External()

 Convenience getters to skip the read interface boilerplate on the Game (aka External) or Physics (aka Internal) threads Backends/MoverNetworkPhysicsLiaisonBase.h  

Chaos::FPBDRigidParticleHandle * GetControlledParticle_Internal()

   Backends/MoverNetworkPhysicsLiaisonBase.h  

virtual Chaos::FPhysicsObject * GetControlledPhysicsObject()

 Override in child classes to return the chaos particle for the component the Mover wants to move. Backends/MoverNetworkPhysicsLiaisonBase.h  

FMoverTimeStep GetCurrentAsyncMoverTimeStep_External()

 Time step on the game thread when using async physics. Uses physics results time. Backends/MoverNetworkPhysicsLiaisonBase.h  

FMoverTimeStep GetCurrentAsyncMoverTimeStep_Internal()

 Time step on the physics thread when using async physics. Backends/MoverNetworkPhysicsLiaisonBase.h  

FMoverTimeStep GetCurrentMoverTimeStep ( float DeltaSeconds
) const

 Time step on the game thread when using non-async physics. Backends/MoverNetworkPhysicsLiaisonBase.h  

UMoverComponent & GetMoverComponent()

   Backends/MoverNetworkPhysicsLiaisonBase.h  

int32 GetNetworkPhysicsTickOffset_External()

   Backends/MoverNetworkPhysicsLiaisonBase.h  

int32 GetNetworkPhysicsTickOffset_Internal()

   Backends/MoverNetworkPhysicsLiaisonBase.h  

Chaos::FPhysicsSolver * GetPhysicsSolver()

   Backends/MoverNetworkPhysicsLiaisonBase.h  

virtual void HandleComponentPhysicsStateChanged ( UPrimitiveComponent* ChangedComponent,
EComponentPhysicsStateChange StateChange
)

   Backends/MoverNetworkPhysicsLiaisonBase.h  

void HandleOwningPawnControllerChanged_Server ( APawn* OwnerPawn,
AController* OldController,
AController* NewController
)

   Backends/MoverNetworkPhysicsLiaisonBase.h  

virtual bool HasValidState()

 Catchall to verify that the state of this object is valid (called from both the PT and the GT) Backends/MoverNetworkPhysicsLiaisonBase.h  

void InitializeSimOutputData()

   Backends/MoverNetworkPhysicsLiaisonBase.h  
Actually do the PreSimulate work on the PT. Backends/MoverNetworkPhysicsLiaisonBase.h  

virtual void PerformProcessInputs_Internal ( int32 PhysicsStep,
float DeltaTime,
const FPhysicsMoverAsyncInput& Input
) const

 Actually do the ProcessInputs work on the PT. Backends/MoverNetworkPhysicsLiaisonBase.h  

virtual void PerformProduceInput_External ( float DeltaTime,
FPhysicsMoverAsyncInput& Input
)

   Backends/MoverNetworkPhysicsLiaisonBase.h  

void TeleportParticleBy_Internal ( Chaos::FGeometryParticleHandle& Particle,
const FVector& PositionDelta,
const FQuat& RotationDelta
) const

   Backends/MoverNetworkPhysicsLiaisonBase.h  

void WakeParticleIfSleeping ( Chaos::FGeometryParticleHandle* Particle
) const

   Backends/MoverNetworkPhysicsLiaisonBase.h  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page