eve::IEditorHost类 参考

Declarative editor-host control (provided by the ui module). 更多...

#include <EditorHost.h>

Public 成员函数
virtual	~IEditorHost ()=default
virtual std::string	status () const =0
virtual std::string	openWindow (const std::string &title, int width, int height)=0
virtual std::string	closeWindow ()=0
virtual std::string	windowState () const =0
virtual std::string	applyEditor (const std::string &json)=0
virtual std::string	removeEditor (const std::string &id)=0
virtual std::string	listEditors () const =0
virtual std::string	editorState (const std::string &id) const =0
virtual std::string	setEditorValue (const std::string &editorId, const std::string &widgetId, const std::string &value)=0
virtual std::string	consumeEvents (const std::string &editorId)=0
virtual std::string	widgetRect (const std::string &editorId, const std::string &widgetId) const =0
virtual std::string	registerVM (const std::string &name, const std::string &source)=0
virtual std::string	unregisterVM (const std::string &name)=0
virtual std::string	saveEditor (const std::string &id)=0
virtual std::string	unloadEditor (const std::string &id)=0
virtual std::string	capture (const std::string &path)=0
virtual std::string	runScript (const std::string &source)=0
virtual void	requestExit ()=0
virtual bool	exitRequested ()=0
	True after requestExit() (main loop exit condition).
virtual void	frame ()=0
	Pump the host's per-frame update (frame loop).
virtual void	stop ()=0
	Shut the host down (stops window + workers).
virtual void	start (ssq::VM &vm, const std::string &gameRoot, bool allowWindow)=0
	Start the host against a Squirrel VM (cmdline integration).
virtual void	exposeScriptApi (ssq::VM &vm)=0
	Expose the host's script API on the VM.

静态 Public 属性
static constexpr const char *	capabilityName = "IEditorHost"

详细描述

Declarative editor-host control (provided by the ui module).

在文件 EditorHost.h 第 17 行定义.

构造及析构函数说明

~IEditorHost()

virtual eve::IEditorHost::~IEditorHost ( )

virtualdefault

成员函数说明

applyEditor()

virtual std::string eve::IEditorHost::applyEditor ( const std::string &  json )

pure virtual

capture()

virtual std::string eve::IEditorHost::capture ( const std::string &  path )

pure virtual

closeWindow()

virtual std::string eve::IEditorHost::closeWindow ( )

pure virtual

consumeEvents()

virtual std::string eve::IEditorHost::consumeEvents ( const std::string &  editorId )

pure virtual

editorState()

virtual std::string eve::IEditorHost::editorState ( const std::string &  id ) const

pure virtual

exitRequested()

virtual bool eve::IEditorHost::exitRequested ( )

pure virtual

True after requestExit() (main loop exit condition).

exposeScriptApi()

virtual void eve::IEditorHost::exposeScriptApi ( ssq::VM &  vm )

pure virtual

Expose the host's script API on the VM.

frame()

virtual void eve::IEditorHost::frame ( )

pure virtual

Pump the host's per-frame update (frame loop).

listEditors()

virtual std::string eve::IEditorHost::listEditors ( ) const

pure virtual

openWindow()

virtual std::string eve::IEditorHost::openWindow ( const std::string &  title, int  width, int  height  )

pure virtual

registerVM()

virtual std::string eve::IEditorHost::registerVM ( const std::string &  name, const std::string &  source  )

pure virtual

removeEditor()

virtual std::string eve::IEditorHost::removeEditor ( const std::string &  id )

pure virtual

requestExit()

virtual void eve::IEditorHost::requestExit ( )

pure virtual

runScript()

virtual std::string eve::IEditorHost::runScript ( const std::string &  source )

pure virtual

saveEditor()

virtual std::string eve::IEditorHost::saveEditor ( const std::string &  id )

pure virtual

setEditorValue()

virtual std::string eve::IEditorHost::setEditorValue ( const std::string &  editorId, const std::string &  widgetId, const std::string &  value  )

pure virtual

start()

virtual void eve::IEditorHost::start ( ssq::VM &  vm, const std::string &  gameRoot, bool  allowWindow  )

pure virtual

Start the host against a Squirrel VM (cmdline integration).

status()

virtual std::string eve::IEditorHost::status ( ) const

pure virtual

stop()

virtual void eve::IEditorHost::stop ( )

pure virtual

Shut the host down (stops window + workers).

unloadEditor()

virtual std::string eve::IEditorHost::unloadEditor ( const std::string &  id )

pure virtual

unregisterVM()

virtual std::string eve::IEditorHost::unregisterVM ( const std::string &  name )

pure virtual

widgetRect()

virtual std::string eve::IEditorHost::widgetRect ( const std::string &  editorId, const std::string &  widgetId  ) const

pure virtual

windowState()

virtual std::string eve::IEditorHost::windowState ( ) const

pure virtual

类成员变量说明

capabilityName

constexpr const char* eve::IEditorHost::capabilityName = "IEditorHost"

staticconstexpr

在文件 EditorHost.h 第 19 行定义.

---

该类的文档由以下文件生成:

• src/engine/common/EditorHost.h