Reversible schema-driven document for native volume-fluid solver settings. @ownership Owns only authoring values; it never owns or retains a runtime solver. @thread Editor-thread affine. @reentrancy Does not invoke callbacks. 更多...

#include <VolumeFluidTarget.h>

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

Public 成员函数
	VolumeFluidTarget (std::string id)
	Volume fluid target.

TargetId	targetId () const override
	Target id.

TargetDescriptor	describe () const override
	Describe.

void *	queryCapability (const CapabilityId &capability) override
	Query the property 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.

VolumeFluidAuthoringSettings	settings () const
	Return an immutable copy of current authoring settings.

std::vector< EditorDiagnostic >	validate () const
	Validate numeric ranges and container clearance.

VolumeFluidAuthoringPreview	previewBudget (std::uint64_t byteBudget=256ULL 1024ULL 1024ULL, std::uint64_t visitBudget=100000000ULL) const
	Estimate preview memory and constraint visits without allocation.

EditorValue	snapshotValue () const
	Capture schema eve.volume-fluid-authoring version one.

Result< void >	loadSnapshot (const EditorValue &snapshot)
	Atomically load a strict version-one authoring document.

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 schema-driven document for native volume-fluid solver settings. @ownership Owns only authoring values; it never owns or retains a runtime solver. @thread Editor-thread affine. @reentrancy Does not invoke callbacks.

在文件 VolumeFluidTarget.h 第 43 行定义.

构造及析构函数说明

◆ VolumeFluidTarget()

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

explicit

Volume fluid target.

在文件 VolumeFluidTarget.cpp 第 135 行定义.

成员函数说明

◆ applyDomainOperation()

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

overridevirtual

Applies domain operation.

实现了 eve::editing::IDomainOperationTarget.

在文件 VolumeFluidTarget.cpp 第 218 行定义.

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

◆ currentRevision()

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

overridevirtual

Current revision.

重载 eve::editing::IPropertyProvider .

在文件 VolumeFluidTarget.cpp 第 151 行定义.

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

◆ describe()

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

overridevirtual

Describe.

重载 eve::editing::IEditableTarget .

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

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

◆ loadSnapshot()

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

Atomically load a strict version-one authoring document.

在文件 VolumeFluidTarget.cpp 第 258 行定义.

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

◆ makeReset()

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

overridevirtual

Make reset.

实现了 eve::editing::IPropertyProvider.

在文件 VolumeFluidTarget.cpp 第 210 行定义.

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

被这些函数引用 makeSet().

◆ makeSet()

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

overridevirtual

Make set.

实现了 eve::editing::IPropertyProvider.

在文件 VolumeFluidTarget.cpp 第 179 行定义.

引用了 eve::editing::DomainOperation::affectedProperties, eve::Result< T >::failure(), eve::editing::PropertySchema::find(), eve::editing::Value::getIf(), eve::editing::DomainOperation::hasInverse, eve::editing::DomainOperation::inverse, eve::editing::DomainOperation::inverseType, makeReset(), eve::editing::DomainOperation::mergeKey, p, eve::editing::DomainOperation::payload, s, schema(), eve::editing::DomainOperation::target, eve::editing::DomainOperation::type, valid , 以及 value.

被这些函数引用 makeReset().

◆ previewBudget()

VolumeFluidAuthoringPreview eve::fluids_editing::VolumeFluidTarget::previewBudget	(	std::uint64_t	byteBudget = `256ULL * 1024ULL * 1024ULL`,
		std::uint64_t	visitBudget = `100000000ULL`
	)		const

Estimate preview memory and constraint visits without allocation.

在文件 VolumeFluidTarget.cpp 第 233 行定义.

引用了 d, eve::fluids_editing::VolumeFluidAuthoringPreview::diagnostics, eve::fluids_editing::VolumeFluidAuthoringPreview::documentRevision, error, eve::fluids_editing::VolumeFluidAuthoringPreview::estimatedBytes, eve::fluids_editing::VolumeFluidAuthoringPreview::estimatedConstraintVisits, eve::fluids_editing::VolumeFluidAuthoringSettings::iterations, eve::fluids_editing::VolumeFluidAuthoringSettings::previewParticles, eve::editing::EditableTargetState::revisionValue(), eve::fluids_editing::VolumeFluidAuthoringPreview::status , 以及 validate().

◆ queryCapability()

void * eve::fluids_editing::VolumeFluidTarget::queryCapability ( const CapabilityId & capability )

overridevirtual

Query the property capability.

返回: Borrowed pointer owned by this target. @lifetime Valid until target destruction.

重载 eve::editing::IEditableTarget .

在文件 VolumeFluidTarget.cpp 第 143 行定义.

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

◆ read()

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

overridevirtual

Reads .

实现了 eve::editing::IPropertyProvider.

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

引用了 p, s , 以及 schema().

◆ schema()

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

overridevirtual

Schema.

实现了 eve::editing::IPropertyProvider.

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

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

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

◆ settings()

VolumeFluidAuthoringSettings eve::fluids_editing::VolumeFluidTarget::settings ( ) const

inline

Return an immutable copy of current authoring settings.

在文件 VolumeFluidTarget.h 第 72 行定义.

被这些函数引用 loadSnapshot().

◆ snapshotValue()

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

Capture schema eve.volume-fluid-authoring version one.

在文件 VolumeFluidTarget.cpp 第 254 行定义.

◆ targetId()

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

inlineoverridevirtual

Target id.

实现了 eve::editing::IEditableTarget.

在文件 VolumeFluidTarget.h 第 51 行定义.

◆ validate()

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

Validate numeric ranges and container clearance.

在文件 VolumeFluidTarget.cpp 第 232 行定义.

被这些函数引用 previewBudget().

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

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

Public 成员函数

额外继承的成员函数

详细描述

构造及析构函数说明

◆ VolumeFluidTarget()

成员函数说明

◆ applyDomainOperation()

◆ currentRevision()

◆ describe()

◆ loadSnapshot()

◆ makeReset()

◆ makeSet()

◆ previewBudget()

◆ queryCapability()

◆ read()

◆ schema()

◆ settings()

◆ snapshotValue()

◆ targetId()

◆ validate()