ezLongOpProxy Class Reference

Proxy long ops represent a long operation on the editor side. More...

#include <LongOps.h>

Inheritance diagram for ezLongOpProxy:

Public Member Functions
virtual void	InitializeRegistered (const ezUuid &documentGuid, const ezUuid &componentGuid)
	Called once by ezLongOpControllerManager::RegisterLongOp() to inform the proxy to which ezDocument and component (ezDocumentObject) it is linked.
virtual const char *	GetDisplayName () const =0
	Called by the ezQtLongOpsPanel to determine the display string to be shown in the UI.
virtual void	GetReplicationInfo (ezStringBuilder &out_sReplicationOpType, ezStreamWriter &inout_config)=0
	Called every time the long op shall be executed. More...
virtual void	Finalize (ezResult result, const ezDataBuffer &resultData)
	Called once the corresponding ezLongOpWorker has finished. More...
Public Member Functions inherited from ezReflectedClass
virtual const ezRTTI *	GetDynamicRTTI () const
bool	IsInstanceOf (const ezRTTI *pType) const
	Returns whether the type of this instance is of the given type or derived from it.
template<typename T >
EZ_ALWAYS_INLINE bool	IsInstanceOf () const
	Returns whether the type of this instance is of the given type or derived from it.

Additional Inherited Members
Static Public Member Functions inherited from ezNoBase
static const ezRTTI *	GetStaticRTTI ()

Detailed Description

Proxy long ops represent a long operation on the editor side.

Proxy long ops have little functionality other than naming which ezLongOpWorker to execute in the engine process and to feed it with the necessary parameters. Since the proxy long op runs in the editor process, it may access ezDocumentObject's and extract data from them.

Member Function Documentation

Finalize()

virtual void ezLongOpProxy::Finalize ( ezResult  result, const ezDataBuffer &  resultData  )

inlinevirtual

Called once the corresponding ezLongOpWorker has finished.

Parameters

result	Whether the operation succeeded or failed (e.g. via user cancellation).
resultData	Optional data written by ezLongOpWorker::Execute().

Reimplemented in ezLongOpProxy_BuildNavMesh, and ezLongOpProxy_BakeScene.

GetReplicationInfo()

virtual void ezLongOpProxy::GetReplicationInfo ( ezStringBuilder &  out_sReplicationOpType, ezStreamWriter &  inout_config  )

pure virtual

Called every time the long op shall be executed.

Parameters

out_sReplicationOpType	must name the ezLongOpWorker that shall be executed in the engine process.
config	can be optionally written to. The data is transmitted to the ezLongOpWorker on the other side and fed to it in ezLongOpWorker::InitializeExecution().

Implemented in ezLongOpProxy_BuildNavMesh, and ezLongOpProxy_BakeScene.

---

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

• /home/runner/work/ezEngine/ezEngine/Code/Editor/EditorEngineProcessFramework/LongOps/LongOps.h