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

#include <LongOps.h>

Inheritance diagram for xiiLongOpProxy:

Public Member Functions
virtual void	InitializeRegistered (const xiiUuid &documentGuid, const xiiUuid &componentGuid)
	Called once by xiiLongOpControllerManager::RegisterLongOp() to inform the proxy to which xiiDocument and component (xiiDocumentObject) it is linked.

virtual xiiStringView	GetDisplayName () const =0
	Called by the xiiQtLongOpsPanel to determine the display string to be shown in the UI.

virtual void	GetReplicationInfo (xiiStringBuilder &out_sReplicationOpType, xiiStreamWriter &inout_config)=0
	Called every time the long op shall be executed.

virtual void	Finalize (xiiResult result, const xiiDataBuffer &resultData)
	Called once the corresponding xiiLongOpWorker has finished.

Public Member Functions inherited from xiiReflectedClass
virtual const xiiRTTI *	GetDynamicRTTI () const

bool	IsInstanceOf (const xiiRTTI *pType) const
	Returns whether the type of this instance is of the given type or derived from it.

template<typename T>
XII_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 xiiNoBase
static const xiiRTTI *	GetStaticRTTI ()

Detailed Description

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

Proxy long ops have little functionality other than naming which xiiLongOpWorker 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 xiiDocumentObject's and extract data from them.

Member Function Documentation

◆ Finalize()

virtual void xiiLongOpProxy::Finalize	(	xiiResult	result,
		const xiiDataBuffer &	resultData )

inlinevirtual

Called once the corresponding xiiLongOpWorker has finished.

Parameters

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

Reimplemented in xiiLongOpProxy_BakeScene.

◆ GetDisplayName()

virtual xiiStringView xiiLongOpProxy::GetDisplayName ( ) const

pure virtual

Called by the xiiQtLongOpsPanel to determine the display string to be shown in the UI.

Implemented in xiiLongOpProxy_BakeScene.

◆ GetReplicationInfo()

virtual void xiiLongOpProxy::GetReplicationInfo	(	xiiStringBuilder &	out_sReplicationOpType,
		xiiStreamWriter &	inout_config )

pure virtual

Called every time the long op shall be executed.

Parameters

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

Implemented in xiiLongOpProxy_BakeScene.

◆ InitializeRegistered()

virtual void xiiLongOpProxy::InitializeRegistered	(	const xiiUuid &	documentGuid,
		const xiiUuid &	componentGuid )

inlinevirtual

Called once by xiiLongOpControllerManager::RegisterLongOp() to inform the proxy to which xiiDocument and component (xiiDocumentObject) it is linked.