IDataflowSimulationInterface Class Reference

#include <DataflowSimulationInterface.h>

Inheritance diagram for IDataflowSimulationInterface:

Public Member Functions
	IDataflowSimulationInterface ()
virtual FDataflowSimulationAsset &	GetSimulationAsset ()=0
virtual const FDataflowSimulationAsset &	GetSimulationAsset () const =0
virtual void	BuildSimulationProxy ()=0
virtual void	ResetSimulationProxy ()=0
virtual const FDataflowSimulationProxy *	GetSimulationProxy () const =0
virtual FDataflowSimulationProxy *	GetSimulationProxy ()=0
virtual FString	GetSimulationName () const =0
virtual void	PreProcessSimulation (const float DeltaTime)
virtual void	WriteToSimulation (const float DeltaTime, const bool bAsyncTask)
virtual void	ReadFromSimulation (const float DeltaTime, const bool bAsyncTask)
virtual void	ReadRestartData ()
virtual void	PostProcessSimulation (const float DeltaTime)
virtual FString	GetSimulationType () const
UE_API void	RegisterManagerInterface (const TObjectPtr< UWorld > &SimulationWorld)
UE_API void	UnregisterManagerInterface (const TObjectPtr< UWorld > &SimulationWorld) const
UE_API bool	IsInterfaceRegistered (const TObjectPtr< UWorld > &SimulationWorld) const

Detailed Description

Dataflow simulation interface to send/receive datas (GT <-> PT)

Constructor & Destructor Documentation

IDataflowSimulationInterface()

IDataflowSimulationInterface::IDataflowSimulationInterface ( )

inline

Member Function Documentation

BuildSimulationProxy()

virtual void IDataflowSimulationInterface::BuildSimulationProxy ( )

pure virtual

Build the simulation proxy

Implemented in AChaosSolverActor.

GetSimulationAsset() [1/2]

virtual const FDataflowSimulationAsset & IDataflowSimulationInterface::GetSimulationAsset ( ) const

pure virtual

Get the const dataflow simulation asset

Implemented in AChaosSolverActor.

GetSimulationAsset() [2/2]

virtual FDataflowSimulationAsset & IDataflowSimulationInterface::GetSimulationAsset ( )

pure virtual

Get the dataflow simulation asset

Implemented in AChaosSolverActor.

GetSimulationName()

virtual FString IDataflowSimulationInterface::GetSimulationName ( ) const

pure virtual

Get the simulation name

Implemented in AChaosSolverActor.

GetSimulationProxy() [1/2]

virtual const FDataflowSimulationProxy * IDataflowSimulationInterface::GetSimulationProxy ( ) const

pure virtual

Get the const simulation proxy

Implemented in AChaosSolverActor.

GetSimulationProxy() [2/2]

virtual FDataflowSimulationProxy * IDataflowSimulationInterface::GetSimulationProxy ( )

pure virtual

Get the simulation proxy

Implemented in AChaosSolverActor.

GetSimulationType()

virtual FString IDataflowSimulationInterface::GetSimulationType ( ) const

inlinevirtual

Get the simulation type

Reimplemented in IDataflowCollisionObjectInterface, IDataflowConstraintObjectInterface, IDataflowPhysicsObjectInterface, and IDataflowPhysicsSolverInterface.

IsInterfaceRegistered()

bool IDataflowSimulationInterface::IsInterfaceRegistered

(

const TObjectPtr< UWorld > &

SimulationWorld

)

const

Check if the interface has been registered to the manager

PostProcessSimulation()

virtual void IDataflowSimulationInterface::PostProcessSimulation ( const float  DeltaTime )

inlinevirtual

Postprocess data after simulation

PreProcessSimulation()

virtual void IDataflowSimulationInterface::PreProcessSimulation ( const float  DeltaTime )

inlinevirtual

Preprocess data before simulation

ReadFromSimulation()

virtual void IDataflowSimulationInterface::ReadFromSimulation ( const float  DeltaTime, const bool  bAsyncTask  )

inlinevirtual

Read data received from the simulation proxy

Reimplemented in AChaosSolverActor.

ReadRestartData()

virtual void IDataflowSimulationInterface::ReadRestartData ( )

inlinevirtual

Read restart data (positions) from simulation proxy

RegisterManagerInterface()

void IDataflowSimulationInterface::RegisterManagerInterface

(

const TObjectPtr< UWorld > &

SimulationWorld

)

Register simulation interface solver to manager

ResetSimulationProxy()

virtual void IDataflowSimulationInterface::ResetSimulationProxy ( )

pure virtual

Reset the simulation proxy

Implemented in AChaosSolverActor.

UnregisterManagerInterface()

void IDataflowSimulationInterface::UnregisterManagerInterface

(

const TObjectPtr< UWorld > &

SimulationWorld

)

const

Unregister simulation interface from the manager

WriteToSimulation()

virtual void IDataflowSimulationInterface::WriteToSimulation ( const float  DeltaTime, const bool  bAsyncTask  )

inlinevirtual

Write data to be sent to the simulation proxy

Reimplemented in AChaosSolverActor.

---

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

• Engine/Source/Runtime/Experimental/Dataflow/Simulation/Public/Dataflow/DataflowSimulationInterface.h
• Engine/Source/Runtime/Experimental/Dataflow/Simulation/Private/Dataflow/DataflowSimulationInterface.cpp