plEditorEngineProcessConnection Class Reference

Classes
struct	Event

Public Member Functions
void	SetFileSystemConfig (const plApplicationFileSystemConfig &cfg)
	The given file system configuration will be used by the engine process to setup the runtime data directories. This only takes effect if the editor process is restarted.
void	SetPluginConfig (const plApplicationPluginConfig &cfg)
	The given plugin configuration will be used by the engine process to load runtime plugins. This only takes effect if the editor process is restarted.
void	Update ()
plResult	RestartProcess ()
void	ShutdownProcess ()
bool	IsProcessCrashed () const
plEditorEngineConnection *	CreateEngineConnection (plAssetDocument *pDocument)
void	DestroyEngineConnection (plAssetDocument *pDocument)
bool	SendMessage (plProcessMessage *pMessage)
plResult	WaitForMessage (const plRTTI *pMessageType, plTime timeout, plProcessCommunicationChannel ::WaitForMessageCallback *pCallback=nullptr)
plResult	WaitForDocumentMessage (const plUuid &assetGuid, const plRTTI *pMessageType, plTime timeout, plProcessCommunicationChannel::WaitForMessageCallback *pCallback=nullptr)
bool	IsEngineSetup () const
void	ActivateRemoteProcess (const plAssetDocument *pDocument, plUInt32 uiViewID)
plProcessCommunicationChannel &	GetCommunicationChannel ()

Static Public Attributes
static plEvent< const Event & >	s_Events

Member Function Documentation

WaitForDocumentMessage()

plResult plEditorEngineProcessConnection::WaitForDocumentMessage	(	const plUuid &	assetGuid,
		const plRTTI *	pMessageType,
		plTime	timeout,
		plProcessCommunicationChannel::WaitForMessageCallback *	pCallback = nullptr )

/brief Same as WaitForMessage but the message must be to a specific document. Therefore, pMessageType must be derived from plEditorEngineDocumentMsg and the function will only return if the received message matches both type, document and is accepted by pCallback.

WaitForMessage()

plResult plEditorEngineProcessConnection::WaitForMessage	(	const plRTTI *	pMessageType,
		plTime	timeout,
		plProcessCommunicationChannel ::WaitForMessageCallback *	pCallback = nullptr )

/brief Waits for a message of type pMessageType. If tTimeout is zero, the function will not timeout. If the timeout is valid and is it, PL_FAILURE is returned. If the message type matches and pCallback is valid, the function will be called and the return values decides whether the message is to be accepted and the waiting has ended.

---

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

• Code/Editor/EditorFramework/IPC/EngineProcessConnection.h
• Code/Editor/EditorFramework/IPC/EngineProcessConnection.cpp