eve::editor::ActionTimelineTarget类 参考

Authoritative editor target for one action timeline asset. 更多...

#include <ActionTimelineEditor.h>

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

Public 成员函数
	ActionTimelineTarget (std::string targetId)
	Construct an empty, valid seed timeline for automation and inspectors.
	ActionTimelineTarget (std::string targetId, action::ActionTimeline timeline)
	Construct an owning target from an already validated timeline.
TargetId	targetId () const override
	Stable editor target identity.
std::uint64_t	revision () const override
	Monotonic content revision.
EditRegion	dirtyRegion () const override
	Timeline edits invalidate the semantic surface, not a pixel region.
void	clearDirtyRegion () override
	No-op for a semantic document target.
TargetDescriptor	describe () const override
	Describe the timeline document for tools and automation.
void *	queryCapability (const CapabilityId &capability) override
	Query property or snapshot capabilities.
const action::ActionTimeline &	timeline () const noexcept
	Borrow the authoritative timeline until the next mutation.
Result< void >	applyDomainOperation (const DomainOperation &operation) override
	Apply a validated canonical replace operation.
std::unique_ptr< IDomainOperationTarget >	cloneDomainState () const override
	Clone complete target state for atomic compensation.
Result< void >	commitDomainState (std::unique_ptr< IDomainOperationTarget > candidate) override
	Atomically publish a validated candidate.
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.
EditorValue	snapshotValue () const override
	Capture the canonical timeline as an authoring value tree.
Result< void >	loadSnapshot (const EditorValue &snapshot)
	Replace content when opening a persisted or automation-supplied timeline.
Public 成员函数 继承自 eve::editing::IDomainOperationTarget
	~IDomainOperationTarget () override=default
	Releases IDomainOperationTarget resources.
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::IDomainOperationTargetStaging
virtual	~IDomainOperationTargetStaging ()=default
	Releases IDomainOperationTargetStaging resources.
Public 成员函数 继承自 eve::editing::IPropertyProvider
virtual	~IPropertyProvider ()=default
	Releases IPropertyProvider resources.
Public 成员函数 继承自 eve::editing::IEditingSnapshotProvider
virtual	~IEditingSnapshotProvider ()=default
	Releases IEditingSnapshotProvider resources.

静态 Public 成员函数
static CapabilityId	propertyCapabilityId ()
	Capability identity published by describe() for Inspector property editing.
静态 Public 成员函数 继承自 eve::editing::IPropertyProvider
static CapabilityId	editingCapabilityId ()
	Stable capability identity for generic property editing.
静态 Public 成员函数 继承自 eve::editing::IEditingSnapshotProvider
static CapabilityId	editingCapabilityId ()
	Stable capability identity shared by every editable domain target.

详细描述

Authoritative editor target for one action timeline asset.

The target owns exactly one canonical action::ActionTimeline. Mutations use a canonical replace operation containing the action module's JSON codec, so document persistence, undo and runtime loading cannot drift into separate field mappings.

在文件 ActionTimelineEditor.h 第 82 行定义.

构造及析构函数说明

ActionTimelineTarget() [1/2]

eve::editor::ActionTimelineTarget::ActionTimelineTarget ( std::string  targetId )

explicit

Construct an empty, valid seed timeline for automation and inspectors.

参数

targetId

Stable editor target identity; also seeds actionId when it is a LogicalId.

在文件 ActionTimelineEditor.cpp 第 108 行定义.

引用了 targetId().

ActionTimelineTarget() [2/2]

eve::editor::ActionTimelineTarget::ActionTimelineTarget	(	std::string	targetId,
		action::ActionTimeline	timeline
	)

Construct an owning target from an already validated timeline.

在文件 ActionTimelineEditor.cpp 第 113 行定义.

成员函数说明

applyDomainOperation()

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

overridevirtual

Apply a validated canonical replace operation.

实现了 eve::editing::IDomainOperationTarget.

在文件 ActionTimelineEditor.cpp 第 131 行定义.

引用了 eve::Value::fromJson(), eve::action::ActionTimeline::fromValue(), operation , 以及 value.

clearDirtyRegion()

void eve::editor::ActionTimelineTarget::clearDirtyRegion ( )

inlineoverridevirtual

No-op for a semantic document target.

实现了 eve::editing::IEditableTarget.

在文件 ActionTimelineEditor.h 第 105 行定义.

cloneDomainState()

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

overridevirtual

Clone complete target state for atomic compensation.

实现了 eve::editing::IDomainOperationTargetStaging.

在文件 ActionTimelineEditor.cpp 第 150 行定义.

commitDomainState()

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

overridevirtual

Atomically publish a validated candidate.

实现了 eve::editing::IDomainOperationTargetStaging.

在文件 ActionTimelineEditor.cpp 第 156 行定义.

引用了 valid.

currentRevision()

eve::Result< eve::Revision > eve::editor::ActionTimelineTarget::currentRevision ( const SelectionSnapshot &  selection ) const

overridevirtual

Current revision.

Failure.

重载 eve::editing::IPropertyProvider .

在文件 ActionTimelineEditor.cpp 第 207 行定义.

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

describe()

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

overridevirtual

Describe the timeline document for tools and automation.

重载 eve::editing::IEditableTarget .

在文件 ActionTimelineEditor.cpp 第 116 行定义.

引用了 eve::editing::IEditingSnapshotProvider::editingCapabilityId() , 以及 propertyCapabilityId().

dirtyRegion()

EditRegion eve::editor::ActionTimelineTarget::dirtyRegion ( ) const

inlineoverridevirtual

Timeline edits invalidate the semantic surface, not a pixel region.

实现了 eve::editing::IEditableTarget.

在文件 ActionTimelineEditor.h 第 103 行定义.

loadSnapshot()

Result< void > eve::editor::ActionTimelineTarget::loadSnapshot

(

const EditorValue &

snapshot

)

Replace content when opening a persisted or automation-supplied timeline.

在文件 ActionTimelineEditor.cpp 第 288 行定义.

引用了 eve::Value::fromJson(), eve::action::ActionTimeline::fromValue() , 以及 value.

被这些函数引用 eve::editor::ActionTimelineEditor::reloadDocument().

makeReset()

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

overridevirtual

Make reset.

实现了 eve::editing::IPropertyProvider.

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

引用了 descriptor, eve::editing::PropertySchema::find(), makeSet(), path , 以及 schema().

被这些函数引用 makeSet().

makeSet()

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

overridevirtual

Make set.

实现了 eve::editing::IPropertyProvider.

在文件 ActionTimelineEditor.cpp 第 238 行定义.

引用了 eve::action::ActionTimeline::actionId, eve::action::ActionTimeline::animationSections, eve::action::ActionTimeline::animationUri, descriptor, eve::action::ActionTimeline::duration, duration, eve::editing::PropertySchema::find(), eve::Duration::fromSeconds(), makeReset(), ok, eve::LogicalId::parse(), path, schema(), text, uri, valid, eve::action::ActionTimeline::validate() , 以及 value.

被这些函数引用 makeReset().

propertyCapabilityId()

static CapabilityId eve::editor::ActionTimelineTarget::propertyCapabilityId ( )

inlinestatic

Capability identity published by describe() for Inspector property editing.

在文件 ActionTimelineEditor.h 第 96 行定义.

被这些函数引用 describe(), queryCapability() , 以及 eve::action_editor::registerEditingCommands().

queryCapability()

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

overridevirtual

Query property or snapshot capabilities.

返回

Borrowed pointer owned by this target, or null. @lifetime Valid until this target is destroyed or replaced.

重载 eve::editing::IEditableTarget .

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

引用了 eve::editing::IEditableTarget::capability(), eve::editing::IEditingSnapshotProvider::editingCapabilityId() , 以及 propertyCapabilityId().

read()

PropertyReadResult eve::editor::ActionTimelineTarget::read ( const SelectionSnapshot &  selection, const PropertyPath &  path  ) const

overridevirtual

Reads .

实现了 eve::editing::IPropertyProvider.

在文件 ActionTimelineEditor.cpp 第 228 行定义.

引用了 eve::action::ActionTimeline::actionId, eve::action::ActionTimeline::animationSections, eve::action::ActionTimeline::animationUri, eve::action::ActionTimeline::duration, eve::LogicalId::format(), path, schema() , 以及 eve::Duration::seconds().

revision()

std::uint64_t eve::editor::ActionTimelineTarget::revision ( ) const

inlineoverridevirtual

Monotonic content revision.

实现了 eve::editing::IEditableTarget.

在文件 ActionTimelineEditor.h 第 101 行定义.

schema()

PropertySchema eve::editor::ActionTimelineTarget::schema ( const SelectionSnapshot &  selection ) const

overridevirtual

Schema.

实现了 eve::editing::IPropertyProvider.

在文件 ActionTimelineEditor.cpp 第 214 行定义.

引用了 eve::editing::PropertySchema::properties, schema(), eve::editing::PropertySchema::typeId , 以及 eve::editing::PropertySchema::version.

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

snapshotValue()

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

overridevirtual

Capture the canonical timeline as an authoring value tree.

实现了 eve::editing::IEditingSnapshotProvider.

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

引用了 eve::editor::toEditorValue() , 以及 eve::action::ActionTimeline::toValue().

targetId()

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

inlineoverridevirtual

Stable editor target identity.

实现了 eve::editing::IEditableTarget.

在文件 ActionTimelineEditor.h 第 99 行定义.

被这些函数引用 ActionTimelineTarget().

timeline()

const action::ActionTimeline & eve::editor::ActionTimelineTarget::timeline ( ) const

inlinenoexcept

Borrow the authoritative timeline until the next mutation.

在文件 ActionTimelineEditor.h 第 116 行定义.

被这些函数引用 eve::editor::ActionTimelineEditor::addAnimationSection(), eve::editor::ActionTimelineEditor::addNotify(), eve::editor::ActionTimelineEditor::addParameterKey(), eve::editor::ActionTimelineEditor::addSectionSplit(), eve::editor::ActionTimelineEditor::addState(), eve::editor::ActionTimelineEditor::addTrack(), eve::editor::ActionTimelineEditor::alignSelectionEnd(), eve::editor::ActionTimelineEditor::alignSelectionStart(), eve::editor::ActionTimelineEditor::boxSelect(), eve::editor::ActionTimelineEditor::copySelection(), eve::editor::ActionTimelineEditor::editAnimationSection(), eve::editor::ActionTimelineEditor::editAnimationSectionFull(), eve::editor::ActionTimelineEditor::editAnimationSectionSource(), eve::editor::ActionTimelineEditor::editItem(), eve::editor::ActionTimelineEditor::editParameterKey(), eve::editor::ActionTimelinePayloadEditor::fitBlockToClip(), eve::editor::ActionTimelinePayloadEditor::fitClipToBlock(), eve::editor::ActionTimelinePayloadEditor::fitClipToNaturalDuration(), eve::editor::ActionPreviewController::jumpToEnd(), eve::editor::ActionTimelineWidget::layout(), eve::editor::ActionTimelineEditor::moveAnimationSection(), eve::editor::ActionTimelineEditor::moveItem(), eve::editor::ActionTimelineEditor::moveSelection(), eve::editor::ActionTimelineWidget::pan(), eve::editor::ActionTimelinePayloadEditor::patch(), eve::editor::ActionTimelinePayloadEditor::payload(), eve::editor::ActionTimelineEditor::removeAnimationSection(), eve::editor::ActionTimelineEditor::removeItem(), eve::editor::ActionTimelineEditor::removeParameterKey(), eve::editor::ActionTimelineEditor::removeSectionSplit(), eve::editor::ActionTimelineEditor::removeTrack(), eve::editor::ActionTimelineEditor::renameTrack(), eve::editor::ActionTimelineEditor::resizeAnimationSection(), eve::editor::ActionTimelineEditor::resizeState(), eve::editor::ActionTimelineEditor::scaleSelection(), eve::editor::ActionPreviewController::seek(), eve::editor::ActionTimelineEditor::selectionRange(), eve::editor::ActionTimelineEditor::selectItem(), eve::editor::ActionTimelineEditor::setItemEnabled(), eve::editor::ActionTimelineEditor::setMontageSettings(), eve::editor::ActionTimelineEditor::setSectionSplit(), eve::editor::ActionTimelineEditor::setTrackLocked(), eve::editor::ActionTimelineEditor::setTrackMuted(), eve::editor::ActionTimelineWidget::setVisibleRange(), eve::editor::ActionTimelineEditor::updateItem() , 以及 eve::editor::ActionTimelineWidget::zoom().

---

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

• src/modules/action/editor/ActionTimelineEditor.h
• src/modules/action/editor/ActionTimelineEditor.cpp