Reversible document for GPU Agents effect authoring. 更多...

#include <GpuAgentsDocument.h>

类 eve::gpuagents_editing::GpuAgentsDocumentTarget 继承关系图:

Public 成员函数
	GpuAgentsDocumentTarget (std::string id)
	Gpu agents document target.

TargetId	targetId () const override
	Target id.

TargetDescriptor	describe () const override
	Describe.

void *	queryCapability (const CapabilityId &capability) override
	Query an optional target capability. @ownership Borrowed; owned by this target. @lifetime Valid until this target is destroyed or mutated. @nullable Yes when the capability is unsupported.

Result< void >	applyDomainOperation (const DomainOperation &operation) override
	Applies domain operation.

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.

GpuAgentsSettings	settings () const
	Immutable authored settings.

std::vector< EditorDiagnostic >	validate () const
	Structured validation diagnostics.

EditorValue	snapshotValue () const
	Capture schema-version-one settings.

Result< void >	loadSnapshot (const EditorValue &snapshot)
	Atomically load and validate a persisted snapshot.

Public 成员函数继承自 eve::editing::EditableTargetState
	EditableTargetState (Revision initial=1)
	Constructs the shared state with an explicit initial revision.

EditRegion	dirtyRegion () const override
	Return the accumulated dirty region.

void	clearDirtyRegion () override
	Discard the dirty region; the revision does not change.

std::uint64_t	revision () const override
	Return the current revision.

Revision	revisionValue () const noexcept
	Return the revision as the shared protocol revision type.

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

template<class C >
eve::OptionalRef< C >	capability ()
	Query a capability through its interface-owned stable identity.

template<class C >
eve::OptionalRef< const C >	capability () const
	Capability.

template<class C >
C *	query ()
	Queries query.

template<class C >
const C *	query () const
	Queries query.

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

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

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

Protected 成员函数继承自 eve::editing::EditableTargetState
void	widenDirty (int x, int y)
	Widen the dirty region without advancing the revision.

void	widenDirty (const EditRegion &region)
	Widen the dirty region without advancing the revision.

void	widenDirty ()
	Mark an unknown area dirty without advancing the revision.

void	bumpRevision ()
	Advance the revision without touching the dirty region.

void	setRevision (Revision revision)
	Adopt a revision observed elsewhere, without advancing it.

void	setDirtyRegion (const EditRegion &region)
	Replace the dirty region wholesale, without advancing the revision.

void	markDirty (int x, int y)
	Include one cell in the dirty region and advance the revision.

void	markDirty (const EditRegion &region)
	Include a whole region and advance the revision.

void	markDirty ()
	Mark an unknown area dirty and advance the revision.

详细描述

Reversible document for GPU Agents effect authoring.

在文件 GpuAgentsDocument.h 第 83 行定义.

构造及析构函数说明

◆ GpuAgentsDocumentTarget()

eve::gpuagents_editing::GpuAgentsDocumentTarget::GpuAgentsDocumentTarget ( std::string id )

explicit

Gpu agents document target.

在文件 GpuAgentsDocument.cpp 第 255 行定义.

成员函数说明

◆ applyDomainOperation()

Result< void > eve::gpuagents_editing::GpuAgentsDocumentTarget::applyDomainOperation ( const DomainOperation & operation )

overridevirtual

Applies domain operation.

实现了 eve::editing::IDomainOperationTarget.

在文件 GpuAgentsDocument.cpp 第 324 行定义.

引用了 eve::editing::applied(), eve::editing::EditableTargetState::bumpRevision(), eve::Result< T >::failure() , 以及 operation.

◆ currentRevision()

eve::Result< eve::Revision > eve::gpuagents_editing::GpuAgentsDocumentTarget::currentRevision ( const SelectionSnapshot & selection ) const

overridevirtual

Current revision.

重载 eve::editing::IPropertyProvider .

在文件 GpuAgentsDocument.cpp 第 274 行定义.

引用了 eve::Diagnostic::error(), eve::Result< T >::failure(), eve::InvalidArgument, eve::editing::EditableTargetState::revisionValue(), s , 以及 eve::Result< T >::success().

◆ describe()

TargetDescriptor eve::gpuagents_editing::GpuAgentsDocumentTarget::describe ( ) const

overridevirtual

Describe.

重载 eve::editing::IEditableTarget .

在文件 GpuAgentsDocument.cpp 第 257 行定义.

引用了 eve::editing::EditableTargetState::revisionValue().

◆ loadSnapshot()

Result< void > eve::gpuagents_editing::GpuAgentsDocumentTarget::loadSnapshot ( const EditorValue & snapshot )

Atomically load and validate a persisted snapshot.

在文件 GpuAgentsDocument.cpp 第 340 行定义.

引用了 eve::editing::applied(), eve::editing::EditableTargetState::bumpRevision() , 以及 eve::Result< T >::failure().

◆ makeReset()

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

overridevirtual

Make reset.

实现了 eve::editing::IPropertyProvider.

在文件 GpuAgentsDocument.cpp 第 314 行定义.

引用了 d, eve::editing::PropertySchema::find(), makeSet(), p, s , 以及 schema().

被这些函数引用 makeSet().

◆ makeSet()

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

overridevirtual

Make set.

实现了 eve::editing::IPropertyProvider.

在文件 GpuAgentsDocument.cpp 第 290 行定义.

引用了 d, eve::Result< T >::failure(), eve::editing::PropertySchema::find(), eve::editing::Value::getIf(), eve::editing::DomainOperation::hasInverse, eve::editing::DomainOperation::inverse, eve::editing::DomainOperation::inverseType, m, makeReset(), p, eve::editing::DomainOperation::payload, s, schema(), eve::editing::DomainOperation::target, eve::editing::DomainOperation::type , 以及 v.

被这些函数引用 makeReset().

◆ queryCapability()

void * eve::gpuagents_editing::GpuAgentsDocumentTarget::queryCapability ( const CapabilityId & capability )

overridevirtual

Query an optional target capability. @ownership Borrowed; owned by this target. @lifetime Valid until this target is destroyed or mutated. @nullable Yes when the capability is unsupported.

重载 eve::editing::IEditableTarget .

在文件 GpuAgentsDocument.cpp 第 265 行定义.

引用了 c.

◆ read()

PropertyReadResult eve::gpuagents_editing::GpuAgentsDocumentTarget::read	(	const SelectionSnapshot &	selection,
		const PropertyPath &	path
	)		const

overridevirtual

Reads .

实现了 eve::editing::IPropertyProvider.

在文件 GpuAgentsDocument.cpp 第 284 行定义.

引用了 p, s, schema(), v , 以及 eve::editing::Value.

◆ schema()

PropertySchema eve::gpuagents_editing::GpuAgentsDocumentTarget::schema ( const SelectionSnapshot & selection ) const

overridevirtual

Schema.

实现了 eve::editing::IPropertyProvider.

在文件 GpuAgentsDocument.cpp 第 282 行定义.

引用了 eve::gpuagents_editing::gpuAgentsEffectSchema().

被这些函数引用 makeReset(), makeSet() , 以及 read().

◆ settings()

GpuAgentsSettings eve::gpuagents_editing::GpuAgentsDocumentTarget::settings ( ) const

inline

Immutable authored settings.

在文件 GpuAgentsDocument.h 第 117 行定义.

◆ snapshotValue()

EditorValue eve::gpuagents_editing::GpuAgentsDocumentTarget::snapshotValue ( ) const

Capture schema-version-one settings.

在文件 GpuAgentsDocument.cpp 第 338 行定义.

◆ targetId()

TargetId eve::gpuagents_editing::GpuAgentsDocumentTarget::targetId ( ) const

inlineoverridevirtual

Target id.

实现了 eve::editing::IEditableTarget.

在文件 GpuAgentsDocument.h 第 91 行定义.

◆ validate()

std::vector< EditorDiagnostic > eve::gpuagents_editing::GpuAgentsDocumentTarget::validate ( ) const

Structured validation diagnostics.

在文件 GpuAgentsDocument.cpp 第 336 行定义.

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

src/modules/gpuagents/editing/GpuAgentsDocument.h
src/modules/gpuagents/editing/GpuAgentsDocument.cpp

Public 成员函数

额外继承的成员函数

详细描述

构造及析构函数说明

◆ GpuAgentsDocumentTarget()

成员函数说明

◆ applyDomainOperation()

◆ currentRevision()

◆ describe()

◆ loadSnapshot()

◆ makeReset()

◆ makeSet()

◆ queryCapability()

◆ read()

◆ schema()

◆ settings()

◆ snapshotValue()

◆ targetId()

◆ validate()