Reuses existing property/operation targets as scene component payloads. 更多...

#include <SceneComponentPayload.h>

类 eve::scene_editing::SceneComponentPropertyBindings 继承关系图:

Public 类型
using	Validator = std::function< std::vector< EditorDiagnostic >()>

Public 成员函数
	SceneComponentPropertyBindings (std::string componentType)
	Create bindings for one stable component type.

const std::string &	componentType () const override
	Component type.

Result< void >	bind (SceneComponentPayloadRef component, SelectionItem moduleSelection, IPropertyProvider properties, IDomainOperationTarget operations, Validator validator={})
	Bind one stable scene component to an existing module editor target.

SceneComponentChange	unbind (const TargetId &scene, const StableId &component)
	Remove one exact scene component binding.

std::vector< SceneComponentPayloadRef >	components (const TargetId &scene, const ObjectId &object) const override
	Components.

Result< IDomainOperationTarget * >	payloadOperationTarget (const SelectionSnapshot &selection) const override
	Payload operation target.

std::vector< EditorDiagnostic >	validateComponent (const SceneComponentPayloadRef &component) const override
	Validate component.

eve::Result< eve::Revision >	currentRevision (const SelectionSnapshot &selection) const override
	Current revision.

PropertySchema	schema (const SelectionSnapshot &selection) const override
	Schema.

PropertyReadResult	read (const SelectionSnapshot &selection, const PropertyPath &path) const override
	Reads .

Result< DomainOperation >	makeSet (const SelectionSnapshot &selection, const PropertyPath &path, const EditorValue &value, PropertySetMode mode) const override
	Make set.

Result< DomainOperation >	makeReset (const SelectionSnapshot &selection, const PropertyPath &path) const override
	Make reset.

Public 成员函数继承自 eve::scene_editing::ISceneComponentPayloadProvider
	~ISceneComponentPayloadProvider () override=default
	Releases ISceneComponentPayloadProvider resources.

Public 成员函数继承自 eve::editing::IPropertyProvider
virtual	~IPropertyProvider ()=default
	Releases IPropertyProvider resources.

virtual Result< DomainOperation >	makeSet (const SelectionSnapshot &selection, const PropertyPath &path, const Value &value, PropertySetMode mode) const =0
	Make set.

额外继承的成员函数
静态 Public 成员函数继承自 eve::editing::IPropertyProvider
static CapabilityId	editingCapabilityId ()
	Stable capability identity for generic property editing.

详细描述

Reuses existing property/operation targets as scene component payloads.

This adapter keeps no duplicate component values. It translates stable scene component selections to the selection expected by the module-owned target.

在文件 SceneComponentPayload.h 第 60 行定义.

成员类型定义说明

◆ Validator

using eve::scene_editing::SceneComponentPropertyBindings::Validator = std::function<std::vector<EditorDiagnostic>()>

在文件 SceneComponentPayload.h 第 62 行定义.

构造及析构函数说明

◆ SceneComponentPropertyBindings()

eve::scene_editing::SceneComponentPropertyBindings::SceneComponentPropertyBindings ( std::string componentType )

explicit

Create bindings for one stable component type.

在文件 SceneComponentPayload.cpp 第 10 行定义.

成员函数说明

◆ bind()

Result< void > eve::scene_editing::SceneComponentPropertyBindings::bind	(	SceneComponentPayloadRef	component,
		SelectionItem	moduleSelection,
		IPropertyProvider *	properties,
		IDomainOperationTarget *	operations,
		Validator	validator = `{}`
	)

Bind one stable scene component to an existing module editor target.

在文件 SceneComponentPayload.cpp 第 13 行定义.

引用了 eve::scene_editing::SceneComponentPayloadRef::component, eve::scene_editing::SceneComponentPayloadRef::object, properties, eve::editing::IEditableTarget::revision(), eve::scene_editing::SceneComponentPayloadRef::revision, eve::editing::SelectionItem::target, eve::scene_editing::SceneComponentPayloadRef::target, eve::editing::IEditableTarget::targetId() , 以及 eve::scene_editing::SceneComponentPayloadRef::type.

◆ components()

std::vector< SceneComponentPayloadRef > eve::scene_editing::SceneComponentPropertyBindings::components	(	const TargetId &	scene,
		const ObjectId &	object
	)		const

overridevirtual

Components.

实现了 eve::scene_editing::ISceneComponentPayloadProvider.

在文件 SceneComponentPayload.cpp 第 47 行定义.

引用了 binding, eve::scene_editing::SceneComponentPayloadRef::revision , 以及 scene.

◆ componentType()

const std::string & eve::scene_editing::SceneComponentPropertyBindings::componentType ( ) const

inlineoverridevirtual

Component type.

实现了 eve::scene_editing::ISceneComponentPayloadProvider.

在文件 SceneComponentPayload.h 第 67 行定义.

◆ currentRevision()

eve::Result< eve::Revision > eve::scene_editing::SceneComponentPropertyBindings::currentRevision ( const SelectionSnapshot & selection ) const

overridevirtual

Current revision.

重载 eve::editing::IPropertyProvider .

在文件 SceneComponentPayload.cpp 第 104 行定义.

引用了 eve::Diagnostic::error(), eve::Result< T >::failure() , 以及 eve::InvalidArgument.

◆ makeReset()

Result< DomainOperation > eve::scene_editing::SceneComponentPropertyBindings::makeReset	(	const SelectionSnapshot &	selection,
		const PropertyPath &	path
	)		const

overridevirtual

Make reset.

实现了 eve::editing::IPropertyProvider.

在文件 SceneComponentPayload.cpp 第 135 行定义.

引用了 eve::Result< T >::failure() , 以及 path.

◆ makeSet()

Result< DomainOperation > eve::scene_editing::SceneComponentPropertyBindings::makeSet	(	const SelectionSnapshot &	selection,
		const PropertyPath &	path,
		const EditorValue &	value,
		PropertySetMode	mode
	)		const

override

Make set.

在文件 SceneComponentPayload.cpp 第 127 行定义.

引用了 eve::Result< T >::failure(), path , 以及 value.

◆ payloadOperationTarget()

Result< IDomainOperationTarget * > eve::scene_editing::SceneComponentPropertyBindings::payloadOperationTarget ( const SelectionSnapshot & selection ) const

overridevirtual

Payload operation target.

实现了 eve::scene_editing::ISceneComponentPayloadProvider.

在文件 SceneComponentPayload.cpp 第 87 行定义.

引用了 eve::Result< T >::failure().

◆ read()

PropertyReadResult eve::scene_editing::SceneComponentPropertyBindings::read	(	const SelectionSnapshot &	selection,
		const PropertyPath &	path
	)		const

overridevirtual

Reads .

实现了 eve::editing::IPropertyProvider.

在文件 SceneComponentPayload.cpp 第 120 行定义.

引用了 path.

◆ schema()

PropertySchema eve::scene_editing::SceneComponentPropertyBindings::schema ( const SelectionSnapshot & selection ) const

overridevirtual

Schema.

实现了 eve::editing::IPropertyProvider.

在文件 SceneComponentPayload.cpp 第 114 行定义.

◆ unbind()

SceneComponentChange eve::scene_editing::SceneComponentPropertyBindings::unbind	(	const TargetId &	scene,
		const StableId &	component
	)

Remove one exact scene component binding.

在文件 SceneComponentPayload.cpp 第 30 行定义.

引用了 binding, eve::scene_editing::Changed, found , 以及 eve::scene_editing::Unchanged.

◆ validateComponent()

std::vector< EditorDiagnostic > eve::scene_editing::SceneComponentPropertyBindings::validateComponent ( const SceneComponentPayloadRef & component ) const

overridevirtual

Validate component.

实现了 eve::scene_editing::ISceneComponentPayloadProvider.

在文件 SceneComponentPayload.cpp 第 94 行定义.

引用了 binding, eve::scene_editing::SceneComponentPayloadRef::component, eve::NotFound, eve::editing::ruleDiagnostic() , 以及 eve::scene_editing::SceneComponentPayloadRef::target.

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

src/modules/scene/editing/SceneComponentPayload.h
src/modules/scene/editing/SceneComponentPayload.cpp

Public 类型

Public 成员函数

额外继承的成员函数

详细描述

成员类型定义说明

◆ Validator

构造及析构函数说明

◆ SceneComponentPropertyBindings()

成员函数说明

◆ bind()

◆ components()

◆ componentType()

◆ currentRevision()

◆ makeReset()

◆ makeSet()

◆ payloadOperationTarget()

◆ read()

◆ schema()

◆ unbind()

◆ validateComponent()