eve::editor::FieldBrushTool类 参考

Generic stroke tool composed from a brush kernel and field operation. 更多...

#include <FieldBrushTool.h>

类 eve::editor::FieldBrushTool 继承关系图:

Public 成员函数
	FieldBrushTool (std::string id, std::string label, const IBrushKernel *kernel, const IFieldBrushOperation *operation)
	Field brush tool.
const ToolDescriptor &	descriptor () const override
	Descriptor.
void	setKernel (const IBrushKernel *kernel)
	Replace the shape/falloff implementation used by later stamps.
void	setOperation (const IFieldBrushOperation *operation)
	Replace the edit semantics used by later stamps.
void	setRadius (float radius)
	Set brush radius in target coordinates.
void	setStrength (float strength)
	Set the operation strength; negative values are permitted.
float	radius () const
	Radius.
float	strength () const
	Strength.
ToolResponse	pointerEvent (EditorContext &context, const EditorPointerEvent &event) override
	Pointer event.
void	cancel (EditorContext &context) override
	Cancel.
void	drawOverlay (EditorContext &context, IEditorOverlay &overlay) override
	Draws overlay.
void	inspect (EditorContext &context, IEditorInspector &inspector) override
	Inspect.
Public 成员函数 继承自 eve::editor::IEditorTool
virtual	~IEditorTool ()=default
	Releases IEditorTool resources.
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	keyEvent (EditorContext &context, const EditorKeyEvent &event)
	Handle normalized keyboard input.
virtual void	update (EditorContext &context, float dt)
	Per-frame hook for an active tool.

详细描述

Generic stroke tool composed from a brush kernel and field operation.

Both collaborators are non-owning and may be replaced between strokes.

在文件 FieldBrushTool.h 第 55 行定义.

构造及析构函数说明

FieldBrushTool()

eve::editor::FieldBrushTool::FieldBrushTool	(	std::string	id,
		std::string	label,
		const IBrushKernel *	kernel,
		const IFieldBrushOperation *	operation
	)

Field brush tool.

在文件 FieldBrushTool.cpp 第 38 行定义.

成员函数说明

cancel()

void eve::editor::FieldBrushTool::cancel ( EditorContext &  context )

overridevirtual

Cancel.

重载 eve::editor::IEditorTool .

在文件 FieldBrushTool.cpp 第 76 行定义.

引用了 context.

descriptor()

const ToolDescriptor & eve::editor::FieldBrushTool::descriptor ( ) const

inlineoverridevirtual

Descriptor.

实现了 eve::editor::IEditorTool.

在文件 FieldBrushTool.h 第 61 行定义.

drawOverlay()

void eve::editor::FieldBrushTool::drawOverlay ( EditorContext &  context, IEditorOverlay &  overlay  )

overridevirtual

Draws overlay.

重载 eve::editor::IEditorTool .

在文件 FieldBrushTool.cpp 第 81 行定义.

引用了 eve::editor::IEditorOverlay::circle().

inspect()

void eve::editor::FieldBrushTool::inspect ( EditorContext &  context, IEditorInspector &  inspector  )

overridevirtual

Inspect.

重载 eve::editor::IEditorTool .

在文件 FieldBrushTool.cpp 第 85 行定义.

引用了 eve::editor::IEditorInspector::beginGroup(), eve::editor::IEditorInspector::endGroup() , 以及 eve::editor::IEditorInspector::scalar().

pointerEvent()

ToolResponse eve::editor::FieldBrushTool::pointerEvent ( EditorContext &  context, const EditorPointerEvent &  event  )

overridevirtual

Pointer event.

重载 eve::editor::IEditorTool .

在文件 FieldBrushTool.cpp 第 52 行定义.

引用了 context, eve::editor::EditorPointerEvent::phase, stamp, eve::editor::EditorPointerEvent::x , 以及 eve::editor::EditorPointerEvent::y.

radius()

float eve::editor::FieldBrushTool::radius ( ) const

inline

Radius.

在文件 FieldBrushTool.h 第 71 行定义.

setKernel()

void eve::editor::FieldBrushTool::setKernel ( const IBrushKernel *  kernel )

inline

Replace the shape/falloff implementation used by later stamps.

在文件 FieldBrushTool.h 第 63 行定义.

setOperation()

void eve::editor::FieldBrushTool::setOperation ( const IFieldBrushOperation *  operation )

inline

Replace the edit semantics used by later stamps.

在文件 FieldBrushTool.h 第 65 行定义.

引用了 operation.

setRadius()

void eve::editor::FieldBrushTool::setRadius

(

float

radius

)

Set brush radius in target coordinates.

在文件 FieldBrushTool.cpp 第 42 行定义.

引用了 radius.

setStrength()

void eve::editor::FieldBrushTool::setStrength ( float  strength )

inline

Set the operation strength; negative values are permitted.

在文件 FieldBrushTool.h 第 69 行定义.

引用了 strength.

strength()

float eve::editor::FieldBrushTool::strength ( ) const

inline

Strength.

在文件 FieldBrushTool.h 第 73 行定义.

---

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

• src/modules/editor/FieldBrushTool.h
• src/modules/editor/FieldBrushTool.cpp