Reversible property document for fluid simulation authoring. 更多...

#include <FluidTarget.h>

类 eve::fluids_editing::FluidSimulationTarget 继承关系图:

Public 成员函数
	FluidSimulationTarget (std::string id)
	Fluid simulation 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.

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.

FluidSimulationSettings	settings () const
	Return an immutable settings copy.

std::vector< EditorDiagnostic >	validate () const
	Validate solver ranges and cross-property kernel constraints.

FluidSimulationPreview	previewBudget (std::uint64_t byteBudget=256ULL 1024ULL 1024ULL, std::uint64_t neighborBudget=100000000ULL) const
	Estimate bounded memory and neighbor work for preview confirmation.

EditorValue	snapshotValue () const
	Capture deterministic settings.

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

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 property document for fluid simulation authoring.

在文件 FluidTarget.h 第 74 行定义.

构造及析构函数说明

◆ FluidSimulationTarget()

eve::fluids_editing::FluidSimulationTarget::FluidSimulationTarget ( std::string id )

explicit

Fluid simulation target.

在文件 FluidTarget.cpp 第 112 行定义.

成员函数说明

◆ applyDomainOperation()

Result< void > eve::fluids_editing::FluidSimulationTarget::applyDomainOperation ( const DomainOperation & operation )

overridevirtual

Applies domain operation.

实现了 eve::editing::IDomainOperationTarget.

在文件 FluidTarget.cpp 第 125 行定义.

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

◆ currentRevision()

eve::Result< eve::Revision > eve::fluids_editing::FluidSimulationTarget::currentRevision ( const SelectionSnapshot & selection ) const

overridevirtual

Current revision.

重载 eve::editing::IPropertyProvider .

在文件 FluidTarget.cpp 第 140 行定义.

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

◆ describe()

TargetDescriptor eve::fluids_editing::FluidSimulationTarget::describe ( ) const

overridevirtual

Describe.

重载 eve::editing::IEditableTarget .

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

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

◆ loadSnapshot()

Result< void > eve::fluids_editing::FluidSimulationTarget::loadSnapshot ( const EditorValue & snapshot )

Atomically load schema-version-one settings.

在文件 FluidTarget.cpp 第 248 行定义.

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

◆ makeReset()

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

overridevirtual

Make reset.

实现了 eve::editing::IPropertyProvider.

在文件 FluidTarget.cpp 第 203 行定义.

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

被这些函数引用 makeSet().

◆ makeSet()

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

overridevirtual

Make set.

实现了 eve::editing::IPropertyProvider.

在文件 FluidTarget.cpp 第 175 行定义.

引用了 eve::Result< T >::failure(), eve::editing::PropertySchema::find(), eve::editing::Value::getIf(), makeReset(), operation, path, schema(), eve::editing::DomainOperation::type, valid , 以及 value.

被这些函数引用 makeReset().

◆ previewBudget()

FluidSimulationPreview eve::fluids_editing::FluidSimulationTarget::previewBudget	(	std::uint64_t	byteBudget = `256ULL * 1024ULL * 1024ULL`,
		std::uint64_t	neighborBudget = `100000000ULL`
	)		const

Estimate bounded memory and neighbor work for preview confirmation.

在文件 FluidTarget.cpp 第 223 行定义.

◆ queryCapability()

void * eve::fluids_editing::FluidSimulationTarget::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 .

在文件 FluidTarget.cpp 第 120 行定义.

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

◆ read()

PropertyReadResult eve::fluids_editing::FluidSimulationTarget::read	(	const SelectionSnapshot &	selection,
		const PropertyPath &	path
	)		const

overridevirtual

Reads .

实现了 eve::editing::IPropertyProvider.

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

引用了 path , 以及 schema().

◆ schema()

PropertySchema eve::fluids_editing::FluidSimulationTarget::schema ( const SelectionSnapshot & selection ) const

overridevirtual

Schema.

实现了 eve::editing::IPropertyProvider.

在文件 FluidTarget.cpp 第 148 行定义.

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

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

◆ settings()

FluidSimulationSettings eve::fluids_editing::FluidSimulationTarget::settings ( ) const

inline

Return an immutable settings copy.

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

被这些函数引用 loadSnapshot().

◆ snapshotValue()

EditorValue eve::fluids_editing::FluidSimulationTarget::snapshotValue ( ) const

Capture deterministic settings.

在文件 FluidTarget.cpp 第 245 行定义.

◆ targetId()

TargetId eve::fluids_editing::FluidSimulationTarget::targetId ( ) const

inlineoverridevirtual

Target id.

实现了 eve::editing::IEditableTarget.

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

◆ validate()

std::vector< EditorDiagnostic > eve::fluids_editing::FluidSimulationTarget::validate ( ) const

Validate solver ranges and cross-property kernel constraints.

在文件 FluidTarget.cpp 第 212 行定义.

引用了 eve::fluids_editing::FluidSimulationSettings::particleRadius , 以及 eve::fluids_editing::FluidSimulationSettings::supportRadius.

被这些函数引用 previewBudget().

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

src/modules/fluids/editing/FluidTarget.h
src/modules/fluids/editing/FluidTarget.cpp

Public 成员函数

额外继承的成员函数

详细描述

构造及析构函数说明

◆ FluidSimulationTarget()

成员函数说明

◆ applyDomainOperation()

◆ currentRevision()

◆ describe()

◆ loadSnapshot()

◆ makeReset()

◆ makeSet()

◆ previewBudget()

◆ queryCapability()

◆ read()

◆ schema()

◆ settings()

◆ snapshotValue()

◆ targetId()

◆ validate()