UI-neutral reversible curve and gradient timeline document. 更多...

#include <EditorCurveDocument.h>

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

Public 成员函数
	EditorCurveDocument (std::string id)
	Editor curve document.

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.

Result< DomainOperation >	makeSetKey (const EditorCurveKey &key) const override
	Make set key.

Result< DomainOperation >	makeDeleteKey (const StableId &key) const override
	Make delete key.

Result< DomainOperation >	makeSetStop (const EditorGradientStop &stop) const override
	Make set stop.

Result< DomainOperation >	makeDeleteStop (const StableId &stop) const override
	Make delete stop.

std::vector< EditorCurveKey >	keys () const
	Return scalar keys in stable timeline order.

std::vector< EditorGradientStop >	stops () const
	Return gradient stops in stable timeline order.

double	sampleCurve (double time) const
	Sample scalar curve at normalized time.

std::array< double, 4 >	sampleGradient (double time) const
	Sample gradient at normalized time.

EditorCurvePreview	preview (int sampleCount, int maximumSamples=4096) const
	Build a bounded lookup preview for viewport/material upload.

EditorValue	snapshotValue () const
	Capture deterministic schema-version-one timeline data.

Result< void >	loadSnapshot (const EditorValue &snapshot)
	Atomically load a validated timeline 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::IDomainOperationTargetStaging
virtual	~IDomainOperationTargetStaging ()=default
	Releases IDomainOperationTargetStaging resources.

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

额外继承的成员函数
静态 Public 成员函数继承自 eve::editor::ICurveDocumentEditTarget
static CapabilityId	editorCapabilityId ()
	Editor capability id.

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.

详细描述

UI-neutral reversible curve and gradient timeline document.

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

构造及析构函数说明

◆ EditorCurveDocument()

eve::editor::EditorCurveDocument::EditorCurveDocument ( std::string id )

explicit

Editor curve document.

在文件 EditorCurveDocument.cpp 第 79 行定义.

成员函数说明

◆ applyDomainOperation()

Result< void > eve::editor::EditorCurveDocument::applyDomainOperation ( const DomainOperation & operation )

overridevirtual

Applies domain operation.

实现了 eve::editing::IDomainOperationTarget.

在文件 EditorCurveDocument.cpp 第 90 行定义.

引用了 eve::editing::EditableTargetState::bumpRevision(), eve::editing::DomainOperation::payload, eve::editing::DomainOperation::target, eve::editing::DomainOperation::type , 以及 eve::editing::EditableTargetState::widenDirty().

◆ cloneDomainState()

std::unique_ptr< IDomainOperationTarget > eve::editor::EditorCurveDocument::cloneDomainState ( ) const

overridevirtual

Clones domain state.

实现了 eve::editing::IDomainOperationTargetStaging.

在文件 EditorCurveDocument.cpp 第 124 行定义.

◆ commitDomainState()

Result< void > eve::editor::EditorCurveDocument::commitDomainState ( std::unique_ptr< IDomainOperationTarget > candidate )

overridevirtual

Commits domain state.

实现了 eve::editing::IDomainOperationTargetStaging.

在文件 EditorCurveDocument.cpp 第 128 行定义.

引用了 curve.

◆ describe()

TargetDescriptor eve::editor::EditorCurveDocument::describe ( ) const

overridevirtual

Describe.

重载 eve::editing::IEditableTarget .

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

引用了 eve::editor::ICurveDocumentEditTarget::editorCapabilityId() , 以及 eve::editing::EditableTargetState::revisionValue().

◆ keys()

std::vector< EditorCurveKey > eve::editor::EditorCurveDocument::keys ( ) const

Return scalar keys in stable timeline order.

在文件 EditorCurveDocument.cpp 第 170 行定义.

被这些函数引用 loadSnapshot(), sampleCurve() , 以及 snapshotValue().

◆ loadSnapshot()

Result< void > eve::editor::EditorCurveDocument::loadSnapshot ( const EditorValue & snapshot )

Atomically load a validated timeline snapshot.

在文件 EditorCurveDocument.cpp 第 219 行定义.

引用了 eve::editing::EditableTargetState::clearDirtyRegion(), keys(), eve::editing::EditableTargetState::revisionValue(), eve::editing::EditableTargetState::setRevision(), stops() , 以及 value.

◆ makeDeleteKey()

Result< DomainOperation > eve::editor::EditorCurveDocument::makeDeleteKey ( const StableId & key ) const

overridevirtual

Make delete key.

实现了 eve::editor::ICurveDocumentEditTarget.

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

引用了 found, key , 以及 operation.

◆ makeDeleteStop()

Result< DomainOperation > eve::editor::EditorCurveDocument::makeDeleteStop ( const StableId & stop ) const

overridevirtual

Make delete stop.

实现了 eve::editor::ICurveDocumentEditTarget.

在文件 EditorCurveDocument.cpp 第 162 行定义.

引用了 found , 以及 operation.

◆ makeSetKey()

Result< DomainOperation > eve::editor::EditorCurveDocument::makeSetKey ( const EditorCurveKey & key ) const

overridevirtual

Make set key.

实现了 eve::editor::ICurveDocumentEditTarget.

在文件 EditorCurveDocument.cpp 第 136 行定义.

引用了 exists, found, key , 以及 operation.

◆ makeSetStop()

Result< DomainOperation > eve::editor::EditorCurveDocument::makeSetStop ( const EditorGradientStop & stop ) const

overridevirtual

Make set stop.

实现了 eve::editor::ICurveDocumentEditTarget.

在文件 EditorCurveDocument.cpp 第 153 行定义.

引用了 exists, found, eve::editor::EditorGradientStop::id , 以及 operation.

◆ preview()

EditorCurvePreview eve::editor::EditorCurveDocument::preview	(	int	sampleCount,
		int	maximumSamples = `4096`
	)		const

Build a bounded lookup preview for viewport/material upload.

在文件 EditorCurveDocument.cpp 第 198 行定义.

引用了 eve::editor::EditorCurvePreview::curveSamples, eve::editor::EditorCurvePreview::diagnostics, eve::editor::EditorCurvePreview::documentRevision, eve::editor::EditorCurvePreview::gradientSamples, eve::PreconditionViolation, eve::editing::EditableTargetState::revisionValue(), eve::editing::ruleDiagnostic(), sampleCurve(), sampleGradient(), eve::editor::EditorCurvePreview::status , 以及 t.

◆ queryCapability()

void * eve::editor::EditorCurveDocument::queryCapability ( const CapabilityId & capability )

overridevirtual

Query an optional target capability.

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

重载 eve::editing::IEditableTarget .

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

引用了 eve::editing::IEditableTarget::capability() , 以及 eve::editor::ICurveDocumentEditTarget::editorCapabilityId().

◆ sampleCurve()

double eve::editor::EditorCurveDocument::sampleCurve ( double time ) const

Sample scalar curve at normalized time.

在文件 EditorCurveDocument.cpp 第 173 行定义.

引用了 a, b, key, keys(), t, time , 以及 values.

被这些函数引用 preview().

◆ sampleGradient()

std::array< double, 4 > eve::editor::EditorCurveDocument::sampleGradient ( double time ) const

Sample gradient at normalized time.

在文件 EditorCurveDocument.cpp 第 188 行定义.

引用了 a, b, stops(), t, time , 以及 values.

被这些函数引用 preview().

◆ snapshotValue()

EditorValue eve::editor::EditorCurveDocument::snapshotValue ( ) const

Capture deterministic schema-version-one timeline data.

在文件 EditorCurveDocument.cpp 第 213 行定义.

引用了 key, keys() , 以及 stops().

◆ stops()

std::vector< EditorGradientStop > eve::editor::EditorCurveDocument::stops ( ) const

Return gradient stops in stable timeline order.

在文件 EditorCurveDocument.cpp 第 171 行定义.

被这些函数引用 loadSnapshot(), sampleGradient() , 以及 snapshotValue().

◆ targetId()

TargetId eve::editor::EditorCurveDocument::targetId ( ) const

inlineoverridevirtual

Target id.

实现了 eve::editing::IEditableTarget.

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

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

src/modules/editor/EditorCurveDocument.h
src/modules/editor/EditorCurveDocument.cpp

Public 成员函数

额外继承的成员函数

详细描述

构造及析构函数说明

◆ EditorCurveDocument()

成员函数说明

◆ applyDomainOperation()

◆ cloneDomainState()

◆ commitDomainState()

◆ describe()

◆ keys()

◆ loadSnapshot()

◆ makeDeleteKey()

◆ makeDeleteStop()

◆ makeSetKey()

◆ makeSetStop()

◆ preview()

◆ queryCapability()

◆ sampleCurve()

◆ sampleGradient()

◆ snapshotValue()

◆ stops()

◆ targetId()