Shared property-document implementation for light and environment targets. 更多...

#include <LightingTarget.h>

类 eve::lighting_editing::LightingPropertyTargetBase 继承关系图:

Public 成员函数
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.

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
	Capture deterministic values for document persistence.

Result< void >	loadSnapshot (const EditorValue &snapshot)
	Atomically load a schema-version-one property snapshot.

const EditorValue *	value (const std::string &path) const
	Read a typed runtime-neutral property value by path.

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.

Protected 成员函数
	LightingPropertyTargetBase (std::string id, std::string targetType, PropertySchema schema)
	Construct a concrete property target from its schema and defaults.

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.

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

详细描述

Shared property-document implementation for light and environment targets.

在文件 LightingTarget.h 第 53 行定义.

构造及析构函数说明

◆ LightingPropertyTargetBase()

eve::lighting_editing::LightingPropertyTargetBase::LightingPropertyTargetBase	(	std::string	id,
		std::string	targetType,
		PropertySchema	schema
	)

protected

Construct a concrete property target from its schema and defaults.

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

引用了 descriptor , 以及 eve::editing::PropertySchema::properties.

成员函数说明

◆ applyDomainOperation()

Result< void > eve::lighting_editing::LightingPropertyTargetBase::applyDomainOperation ( const DomainOperation & operation )

overridevirtual

Applies domain operation.

实现了 eve::editing::IDomainOperationTarget.

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

引用了 eve::editing::EditableTargetState::bumpRevision(), descriptor, eve::editing::PropertySchema::find(), eve::editing::Value::getIf(), operation, path, valid , 以及 eve::editing::EditableTargetState::widenDirty().

◆ currentRevision()

eve::Result< eve::Revision > eve::lighting_editing::LightingPropertyTargetBase::currentRevision ( const SelectionSnapshot & selection ) const

overridevirtual

Current revision.

重载 eve::editing::IPropertyProvider .

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

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

◆ describe()

TargetDescriptor eve::lighting_editing::LightingPropertyTargetBase::describe ( ) const

overridevirtual

Describe.

重载 eve::editing::IEditableTarget .

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

引用了 eve::editing::TargetDescriptor::capabilities, eve::editing::TargetDescriptor::id, eve::editing::TargetDescriptor::revision, eve::editing::EditableTargetState::revisionValue() , 以及 eve::editing::TargetDescriptor::type.

◆ loadSnapshot()

Result< void > eve::lighting_editing::LightingPropertyTargetBase::loadSnapshot ( const EditorValue & snapshot )

Atomically load a schema-version-one property snapshot.

在文件 LightingTarget.cpp 第 215 行定义.

引用了 eve::editing::EditableTargetState::bumpRevision(), eve::editing::IEditableTarget::clearDirtyRegion(), descriptor, eve::editing::PropertySchema::find(), eve::editing::Value::getIf(), path, eve::editing::PropertySchema::properties, properties , 以及 valid.

◆ makeReset()

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

overridevirtual

Make reset.

实现了 eve::editing::IPropertyProvider.

在文件 LightingTarget.cpp 第 199 行定义.

引用了 descriptor, eve::editing::PropertySchema::find(), makeSet(), path , 以及 eve::UuidIdAdapter< Tag >::value().

被这些函数引用 makeSet().

◆ makeSet()

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

overridevirtual

Make set.

实现了 eve::editing::IPropertyProvider.

在文件 LightingTarget.cpp 第 168 行定义.

引用了 descriptor, eve::Result< T >::failure(), eve::editing::PropertySchema::find(), makeReset(), operation, path, payload, previous, eve::editing::DomainOperation::type, valid , 以及 eve::UuidIdAdapter< Tag >::value().

被这些函数引用 makeReset().

◆ queryCapability()

void * eve::lighting_editing::LightingPropertyTargetBase::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 .

在文件 LightingTarget.cpp 第 123 行定义.

引用了 eve::editing::IEditableTarget::capability().

◆ read()

PropertyReadResult eve::lighting_editing::LightingPropertyTargetBase::read	(	const SelectionSnapshot &	selection,
		const PropertyPath &	path
	)		const

overridevirtual

Reads .

实现了 eve::editing::IPropertyProvider.

在文件 LightingTarget.cpp 第 160 行定义.

引用了 found , 以及 path.

◆ schema()

PropertySchema eve::lighting_editing::LightingPropertyTargetBase::schema ( const SelectionSnapshot & selection ) const

overridevirtual

Schema.

实现了 eve::editing::IPropertyProvider.

在文件 LightingTarget.cpp 第 158 行定义.

◆ snapshotValue()

EditorValue eve::lighting_editing::LightingPropertyTargetBase::snapshotValue ( ) const

Capture deterministic values for document persistence.

在文件 LightingTarget.cpp 第 209 行定义.

引用了 path , 以及 properties.

◆ targetId()

TargetId eve::lighting_editing::LightingPropertyTargetBase::targetId ( ) const

inlineoverridevirtual

Target id.

实现了 eve::editing::IEditableTarget.

在文件 LightingTarget.h 第 59 行定义.

◆ value()

const EditorValue * eve::lighting_editing::LightingPropertyTargetBase::value ( const std::string & path ) const

Read a typed runtime-neutral property value by path.

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

在文件 LightingTarget.cpp 第 241 行定义.

引用了 found , 以及 path.

被这些函数引用 eve::lighting_editing::Light3DRuntimeApplier::apply(), eve::lighting_editing::EnvironmentRuntimeApplier::applyDayNight() , 以及 eve::lighting_editing::EnvironmentRuntimeApplier::applyWeather().

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

src/modules/graphics/lighting/editing/LightingTarget.h
src/modules/graphics/lighting/editing/LightingTarget.cpp

Public 成员函数

Protected 成员函数

额外继承的成员函数

详细描述

构造及析构函数说明

◆ LightingPropertyTargetBase()

成员函数说明

◆ applyDomainOperation()

◆ currentRevision()

◆ describe()

◆ loadSnapshot()

◆ makeReset()

◆ makeSet()

◆ queryCapability()

◆ read()

◆ schema()

◆ snapshotValue()

◆ targetId()

◆ value()