Revisioned SpriteStack bake preset with reusable Inspector metadata. 更多...

#include <SpriteStackTarget.h>

类 eve::spritestack_editing::SpriteStackDocumentTarget 继承关系图:

Public 成员函数
	SpriteStackDocumentTarget (std::string id)
	Sprite stack document target.

TargetId	targetId () const override
	Target id.

TargetDescriptor	describe () const override
	Describe.

void *	queryCapability (const CapabilityId &capability) override
	Query an optional target capability.

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

std::unique_ptr< IDomainOperationTarget >	cloneDomainState () const override
	Clones domain state.

Result< void >	commitDomainState (std::unique_ptr< IDomainOperationTarget > candidate) override
	Commits domain state.

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 read.

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.

const SpriteStackAssetValue &	value () const
	Value.

std::vector< EditorDiagnostic >	validate () const
	Validate source, sampling limits, output memory and presentation values.

EditorValue	snapshotValue () const
	Snapshot value.

Result< void >	loadSnapshot (const EditorValue &snapshot)
	Loads 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.

virtual void *	queryCapability (const CapabilityId &capability)
	Query an optional stable capability.

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::IDomainOperationTargetStaging
virtual	~IDomainOperationTargetStaging ()=default
	Releases IDomainOperationTargetStaging 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.

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.

详细描述

Revisioned SpriteStack bake preset with reusable Inspector metadata.

在文件 SpriteStackTarget.h 第 68 行定义.

构造及析构函数说明

◆ SpriteStackDocumentTarget()

eve::spritestack_editing::SpriteStackDocumentTarget::SpriteStackDocumentTarget ( std::string id )

explicit

Sprite stack document target.

在文件 SpriteStackTarget.cpp 第 34 行定义.

成员函数说明

◆ applyDomainOperation()

Result< void > eve::spritestack_editing::SpriteStackDocumentTarget::applyDomainOperation ( const DomainOperation & operation )

overridevirtual

Applies domain operation.

实现了 eve::editing::IDomainOperationTarget.

在文件 SpriteStackTarget.cpp 第 242 行定义.

引用了 eve::editing::EditableTargetState::bumpRevision(), h, eve::editing::Value::isWithinLimits(), n, eve::editing::DomainOperation::payload, size, source, eve::editing::DomainOperation::target, tint, eve::editing::DomainOperation::type, v, validate(), w, eve::editing::EditableTargetState::widenDirty() , 以及 x.

被这些函数引用 loadSnapshot().

◆ cloneDomainState()

std::unique_ptr< IDomainOperationTarget > eve::spritestack_editing::SpriteStackDocumentTarget::cloneDomainState ( ) const

overridevirtual

Clones domain state.

实现了 eve::editing::IDomainOperationTargetStaging.

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

◆ commitDomainState()

Result< void > eve::spritestack_editing::SpriteStackDocumentTarget::commitDomainState ( std::unique_ptr< IDomainOperationTarget > candidate )

overridevirtual

Commits domain state.

实现了 eve::editing::IDomainOperationTargetStaging.

在文件 SpriteStackTarget.cpp 第 317 行定义.

◆ currentRevision()

eve::Result< eve::Revision > eve::spritestack_editing::SpriteStackDocumentTarget::currentRevision ( const SelectionSnapshot & selection ) const

overridevirtual

Current revision.

重载 eve::editing::IPropertyProvider .

在文件 SpriteStackTarget.cpp 第 49 行定义.

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

◆ describe()

TargetDescriptor eve::spritestack_editing::SpriteStackDocumentTarget::describe ( ) const

overridevirtual

Describe.

重载 eve::editing::IEditableTarget .

在文件 SpriteStackTarget.cpp 第 35 行定义.

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

◆ loadSnapshot()

Result< void > eve::spritestack_editing::SpriteStackDocumentTarget::loadSnapshot ( const EditorValue & snapshot )

Loads snapshot.

在文件 SpriteStackTarget.cpp 第 329 行定义.

引用了 applyDomainOperation(), eve::editing::IEditableTarget::clearDirtyRegion(), eve::editing::DomainOperation::payload, eve::editing::DomainOperation::target, eve::editing::DomainOperation::type , 以及 v.

◆ makeReset()

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

overridevirtual

Make reset.

实现了 eve::editing::IPropertyProvider.

在文件 SpriteStackTarget.cpp 第 194 行定义.

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

被这些函数引用 makeSet().

◆ makeSet()

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

override

Make set.

在文件 SpriteStackTarget.cpp 第 145 行定义.

引用了 a, eve::spritestack_editing::SpriteStackAssetValue::bake, d, eve::spritestack_editing::SpriteStackAssetValue::displayWidth, eve::editing::PropertySchema::find(), eve::spritestack::SliceOptions::layerCount, makeReset(), ok, p, s, schema(), eve::spritestack_editing::SpriteStackAssetValue::shadowOpacity, eve::spritestack_editing::SpriteStackAssetValue::source, eve::spritestack::SliceOptions::thickness, eve::spritestack::SliceOptions::tintR, v , 以及 value().

被这些函数引用 makeReset().

◆ queryCapability()

void * eve::spritestack_editing::SpriteStackDocumentTarget::queryCapability ( const CapabilityId & capability )

override

Query an optional target capability.

返回: Borrowed pointer owned by this target, or null. @lifetime Valid until this target is destroyed or mutated.

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

引用了 c.

◆ read()

PropertyReadResult eve::spritestack_editing::SpriteStackDocumentTarget::read	(	const SelectionSnapshot &	selection,
		const PropertyPath &	path
	)		const

overridevirtual

Reads read.

实现了 eve::editing::IPropertyProvider.

在文件 SpriteStackTarget.cpp 第 96 行定义.

◆ schema()

PropertySchema eve::spritestack_editing::SpriteStackDocumentTarget::schema ( const SelectionSnapshot & selection ) const

overridevirtual

Schema.

实现了 eve::editing::IPropertyProvider.

在文件 SpriteStackTarget.cpp 第 55 行定义.

引用了 s , 以及 eve::editing::PropertySchema::typeId.

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

◆ snapshotValue()

EditorValue eve::spritestack_editing::SpriteStackDocumentTarget::snapshotValue ( ) const

Snapshot value.

在文件 SpriteStackTarget.cpp 第 326 行定义.

◆ targetId()

TargetId eve::spritestack_editing::SpriteStackDocumentTarget::targetId ( ) const

inlineoverridevirtual

Target id.

实现了 eve::editing::IEditableTarget.

在文件 SpriteStackTarget.h 第 77 行定义.

◆ validate()

std::vector< EditorDiagnostic > eve::spritestack_editing::SpriteStackDocumentTarget::validate ( ) const

Validate source, sampling limits, output memory and presentation values.

在文件 SpriteStackTarget.cpp 第 202 行定义.

引用了 eve::spritestack::SliceOptions::axis, eve::spritestack_editing::SpriteStackAssetValue::bake, bytes, d, eve::InvalidArgument, eve::PreconditionViolation, eve::editing::ruleDiagnostic() , 以及 v.

被这些函数引用 applyDomainOperation() , 以及 eve::spritestack_editing::SpriteStackBakeRuntime::bake().

◆ value()

const SpriteStackAssetValue & eve::spritestack_editing::SpriteStackDocumentTarget::value ( ) const

inline

Value.

在文件 SpriteStackTarget.h 第 102 行定义.

被这些函数引用 eve::spritestack_editing::SpriteStackBakeRuntime::bake(), makeSet() , 以及 read().

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

src/modules/spritestack/editing/SpriteStackTarget.h
src/modules/spritestack/editing/SpriteStackTarget.cpp

Public 成员函数

额外继承的成员函数

详细描述

构造及析构函数说明

◆ SpriteStackDocumentTarget()

成员函数说明

◆ applyDomainOperation()

◆ cloneDomainState()

◆ commitDomainState()

◆ currentRevision()

◆ describe()

◆ loadSnapshot()

◆ makeReset()

◆ makeSet()

◆ queryCapability()

◆ read()

◆ schema()

◆ snapshotValue()

◆ targetId()

◆ validate()

◆ value()