载入中...
搜索中...
未找到
Public 成员函数 | 所有成员列表
eve::editor::IEditorTool类 参考abstract

Protocol implemented by every editor tool. 更多...

#include <EditorTool.h>

类 eve::editor::IEditorTool 继承关系图:
eve::editor::ArchSpaceItemPlaceTool eve::editor::ArchSpaceOpeningPlaceTool eve::editor::ArchSpaceWallDrawTool eve::editor::BuildingEdgeCurveTool eve::editor::FieldBrushTool eve::editor::ScriptEditorTool eve::editor::VolumeBrushTool

Public 成员函数

virtual ~IEditorTool ()=default
 Releases IEditorTool resources.
 
virtual const ToolDescriptor & descriptor () const =0
 Stable tool identity and presentation metadata.
 
virtual void activate (EditorContext &context)
 Called exactly once when this tool becomes active.
 
virtual void deactivate (EditorContext &context)
 Called exactly once before this tool stops being active.
 
virtual ToolResponse pointerEvent (EditorContext &context, const EditorPointerEvent &event)
 Handle normalized pointer input.
 
virtual ToolResponse keyEvent (EditorContext &context, const EditorKeyEvent &event)
 Handle normalized keyboard input.
 
virtual void update (EditorContext &context, float dt)
 Per-frame hook for an active tool.
 
virtual void drawOverlay (EditorContext &context, IEditorOverlay &overlay)
 Emit renderer-independent feedback for the active viewport.
 
virtual void inspect (EditorContext &context, IEditorInspector &inspector)
 Expose configurable settings through a host-provided inspector.
 
virtual void cancel (EditorContext &context)
 Cancel the active gesture while keeping the tool selected.
 

详细描述

Protocol implemented by every editor tool.

EditorSession only depends on this lifecycle. Tile, terrain, object and game- specific tools are peers and can be added without modifying the session.

在文件 EditorTool.h 第 110 行定义.

构造及析构函数说明

◆ ~IEditorTool()

virtual eve::editor::IEditorTool::~IEditorTool ( )
virtualdefault

Releases IEditorTool resources.

成员函数说明

◆ activate()

virtual void eve::editor::IEditorTool::activate ( EditorContext &  context)
inlinevirtual

Called exactly once when this tool becomes active.

被 eve::editor::ScriptEditorTool 重载.

在文件 EditorTool.h 第 119 行定义.

引用了 context.

被这些函数引用 eve::editor::EditorSession::activateTool().

◆ cancel()

virtual void eve::editor::IEditorTool::cancel ( EditorContext &  context)
inlinevirtual

Cancel the active gesture while keeping the tool selected.

被 eve::editor::ArchSpaceWallDrawTool, eve::editor::ArchSpaceOpeningPlaceTool, eve::editor::ArchSpaceItemPlaceTool, eve::editor::BuildingEdgeCurveTool, eve::editor::FieldBrushTool, eve::editor::ScriptEditorTool , 以及 eve::editor::VolumeBrushTool 重载.

在文件 EditorTool.h 第 158 行定义.

引用了 context.

被这些函数引用 eve::editor::EditorSession::cancelActiveTool().

◆ deactivate()

virtual void eve::editor::IEditorTool::deactivate ( EditorContext &  context)
inlinevirtual

Called exactly once before this tool stops being active.

被 eve::editor::ArchSpaceWallDrawTool, eve::editor::ArchSpaceOpeningPlaceTool, eve::editor::ArchSpaceItemPlaceTool, eve::editor::BuildingEdgeCurveTool , 以及 eve::editor::ScriptEditorTool 重载.

在文件 EditorTool.h 第 121 行定义.

引用了 context.

◆ descriptor()

virtual const ToolDescriptor & eve::editor::IEditorTool::descriptor ( ) const
pure virtual

Stable tool identity and presentation metadata.

在 eve::editor::ArchSpaceWallDrawTool, eve::editor::ArchSpaceOpeningPlaceTool, eve::editor::ArchSpaceItemPlaceTool, eve::editor::BuildingEdgeCurveTool, eve::editor::FieldBrushTool, eve::editor::ScriptEditorTool , 以及 eve::editor::VolumeBrushTool 内被实现.

被这些函数引用 eve::editor::EditorSession::activeToolId() , 以及 eve::editor::EditorSession::addTool().

◆ drawOverlay()

virtual void eve::editor::IEditorTool::drawOverlay ( EditorContext &  context,
IEditorOverlay &  overlay 
)
inlinevirtual

Emit renderer-independent feedback for the active viewport.

被 eve::editor::ArchSpaceWallDrawTool, eve::editor::ArchSpaceOpeningPlaceTool, eve::editor::ArchSpaceItemPlaceTool, eve::editor::BuildingEdgeCurveTool , 以及 eve::editor::FieldBrushTool 重载.

在文件 EditorTool.h 第 146 行定义.

引用了 context.

被这些函数引用 eve::editor::EditorSession::drawOverlay().

◆ inspect()

virtual void eve::editor::IEditorTool::inspect ( EditorContext &  context,
IEditorInspector &  inspector 
)
inlinevirtual

Expose configurable settings through a host-provided inspector.

被 eve::editor::ArchSpaceWallDrawTool, eve::editor::ArchSpaceOpeningPlaceTool, eve::editor::ArchSpaceItemPlaceTool, eve::editor::FieldBrushTool , 以及 eve::editor::VolumeBrushTool 重载.

在文件 EditorTool.h 第 152 行定义.

引用了 context.

被这些函数引用 eve::editor::EditorSession::inspect().

◆ keyEvent()

virtual ToolResponse eve::editor::IEditorTool::keyEvent ( EditorContext &  context,
const EditorKeyEvent &  event 
)
inlinevirtual

Handle normalized keyboard input.

Ignored.

被 eve::editor::ScriptEditorTool 重载.

在文件 EditorTool.h 第 132 行定义.

引用了 context , 以及 eve::editor::ToolResponse::ignored().

被这些函数引用 eve::editor::EditorSession::dispatchKey().

◆ pointerEvent()

virtual ToolResponse eve::editor::IEditorTool::pointerEvent ( EditorContext &  context,
const EditorPointerEvent &  event 
)
inlinevirtual

Handle normalized pointer input.

Ignored.

被 eve::editor::ArchSpaceWallDrawTool, eve::editor::ArchSpaceOpeningPlaceTool, eve::editor::ArchSpaceItemPlaceTool, eve::editor::BuildingEdgeCurveTool, eve::editor::FieldBrushTool, eve::editor::ScriptEditorTool , 以及 eve::editor::VolumeBrushTool 重载.

在文件 EditorTool.h 第 124 行定义.

引用了 context , 以及 eve::editor::ToolResponse::ignored().

被这些函数引用 eve::editor::EditorSession::dispatchPointer().

◆ update()

virtual void eve::editor::IEditorTool::update ( EditorContext &  context,
float  dt 
)
inlinevirtual

Per-frame hook for an active tool.

被 eve::editor::ScriptEditorTool 重载.

在文件 EditorTool.h 第 140 行定义.

引用了 context.

被这些函数引用 eve::editor::EditorSession::update().

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