Workspace controller for one authored biome rules document. 更多...

#include <BiomeRulesEditor.h>

Public 成员函数
	BiomeRulesEditor (std::string targetId)
	Construct a seeded forest layer with one weighted asset.

	BiomeRulesEditor (const BiomeRulesEditor &)=delete

BiomeRulesEditor &	operator= (const BiomeRulesEditor &)=delete

const biome_editing::BiomeDocumentTarget &	target () const noexcept
	Borrow the authoritative biome document.

biome_editing::Result< void >	configureWorkspace (editor::EditorWorkspace &workspace) const
	Install Layers / Preview / Inspector / Assets panels.

biome_editing::Result< void >	selectLayer (std::string id)

biome_editing::Result< void >	selectAsset (std::string id)

biome_editing::Result< void >	setLayerDensity (double density)

biome_editing::Result< void >	setLayerPriority (int priority)

biome_editing::Result< void >	setAssetWeight (double weight)

biome_editing::Result< void >	createLayer (std::string id, std::string name)

biome_editing::Result< void >	deleteSelectedLayer ()

biome_editing::Result< void >	createAsset (std::string id, std::string asset)

biome_editing::Result< void >	deleteSelectedAsset ()

biome_editing::Result< void >	addExclusion (std::string spatialAsset)

biome_editing::Result< void >	removeExclusion (std::string spatialAsset)

biome_editing::Result< void >	setSeed (std::uint32_t seed)

biome_editing::Result< void >	setSpacing (float spacing)

biome_editing::Result< editor::TransactionReceipt >	undo ()

biome_editing::Result< editor::TransactionReceipt >	redo ()

bool	canUndo () const noexcept

bool	canRedo () const noexcept
	Can redo.

std::uint64_t	revision () const noexcept
	Revision.

std::uint64_t	previewRevision () const noexcept
	Preview revision.

std::uint32_t	seed () const noexcept
	Seed.

float	spacing () const noexcept
	Spacing.

std::string	selectedId () const
	Selected id.

std::string	selectedType () const
	Selected type.

int	layerCount () const
	Layer count.

std::string	layerId (int index) const
	Layer id.

std::string	layerName (int index) const
	Layer name.

float	layerDensity (int index) const
	Layer density.

int	layerPriority (int index) const
	Layer priority.

bool	isLayerSelected (int index) const
	True when layer selected.

int	assetCount () const
	Asset count.

std::string	assetId (int index) const
	Asset id.

std::string	assetRef (int index) const
	Asset ref.

float	assetWeight (int index) const
	Asset weight.

bool	isAssetSelected (int index) const
	True when asset selected.

int	exclusionCount () const
	Exclusion count.

std::string	exclusionAsset (int index) const
	Exclusion asset.

int	pointCount () const
	Point count.

float	pointX (int index) const
	Point x.

float	pointZ (int index) const
	Point z.

std::string	pointAsset (int index) const
	Point asset.

详细描述

Workspace controller for one authored biome rules document.

Owns the document, local undo, borrowed spatial domains and a copied PointSet preview. Preview requests always carry the published revision; a stale or failed generation keeps the last successful points on screen.

@ownership Editor owns the document and spatial copies. Preview getters copy values. @threadaffinity Owner thread only. @reentrancy No unknown callbacks.

在文件 BiomeRulesEditor.h 第 32 行定义.

构造及析构函数说明

◆ BiomeRulesEditor() [1/2]

eve::biome_editor::BiomeRulesEditor::BiomeRulesEditor ( std::string targetId )

explicit

Construct a seeded forest layer with one weighted asset.

在文件 BiomeRulesEditor.cpp 第 34 行定义.

◆ BiomeRulesEditor() [2/2]

eve::biome_editor::BiomeRulesEditor::BiomeRulesEditor ( const BiomeRulesEditor & )

delete

成员函数说明

◆ addExclusion()

biome_editing::Result< void > eve::biome_editor::BiomeRulesEditor::addExclusion ( std::string spatialAsset )

在文件 BiomeRulesEditor.cpp 第 263 行定义.

引用了 eve::biome_editing::BiomeDocumentTarget::exclusions(), eve::biome_editing::BiomeDocumentTarget::makeSetExclusions(), previous , 以及 revision().

◆ assetCount()

int eve::biome_editor::BiomeRulesEditor::assetCount ( ) const

Asset count.

在文件 BiomeRulesEditor.cpp 第 353 行定义.

引用了 layer.

◆ assetId()

std::string eve::biome_editor::BiomeRulesEditor::assetId ( int index ) const

Asset id.

在文件 BiomeRulesEditor.cpp 第 357 行定义.

引用了 index.

◆ assetRef()

std::string eve::biome_editor::BiomeRulesEditor::assetRef ( int index ) const

Asset ref.

在文件 BiomeRulesEditor.cpp 第 361 行定义.

引用了 index.

◆ assetWeight()

float eve::biome_editor::BiomeRulesEditor::assetWeight ( int index ) const

Asset weight.

在文件 BiomeRulesEditor.cpp 第 365 行定义.

引用了 index.

◆ canRedo()

bool eve::biome_editor::BiomeRulesEditor::canRedo ( ) const

inlinenoexcept

Can redo.

在文件 BiomeRulesEditor.h 第 68 行定义.

◆ canUndo()

bool eve::biome_editor::BiomeRulesEditor::canUndo ( ) const

inlinenoexcept

在文件 BiomeRulesEditor.h 第 66 行定义.

◆ configureWorkspace()

biome_editing::Result< void > eve::biome_editor::BiomeRulesEditor::configureWorkspace ( editor::EditorWorkspace & workspace ) const

Install Layers / Preview / Inspector / Assets panels.

注解: Does not retain workspace.

在文件 BiomeRulesEditor.cpp 第 72 行定义.

引用了 eve::editor::EditorWorkspace::activatePanel(), context, id, order, eve::editor::EditorWorkspace::registerPanel(), eve::editor::EditorWorkspace::setPanelCapability(), eve::editor::EditorWorkspace::setPanelContext() , 以及 title.

◆ createAsset()

biome_editing::Result< void > eve::biome_editor::BiomeRulesEditor::createAsset	(	std::string	id,
		std::string	asset
	)

在文件 BiomeRulesEditor.cpp 第 243 行定义.

引用了 created, eve::biome_editing::BiomeAssetValue::id, layer, eve::biome_editing::BiomeDocumentTarget::makeCreateAsset(), selectAsset() , 以及 value.

◆ createLayer()

biome_editing::Result< void > eve::biome_editor::BiomeRulesEditor::createLayer	(	std::string	id,
		std::string	name
	)

在文件 BiomeRulesEditor.cpp 第 221 行定义.

引用了 created, eve::biome_editing::BiomeLayerValue::id, layer, eve::biome_editing::BiomeDocumentTarget::makeCreateLayer(), name , 以及 selectLayer().

◆ deleteSelectedAsset()

biome_editing::Result< void > eve::biome_editor::BiomeRulesEditor::deleteSelectedAsset ( )

在文件 BiomeRulesEditor.cpp 第 256 行定义.

引用了 eve::biome_editing::BiomeDocumentTarget::makeDeleteAsset().

◆ deleteSelectedLayer()

biome_editing::Result< void > eve::biome_editor::BiomeRulesEditor::deleteSelectedLayer ( )

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

引用了 eve::biome_editing::BiomeDocumentTarget::layers(), eve::biome_editing::BiomeDocumentTarget::makeDeleteLayer() , 以及 selectLayer().

◆ exclusionAsset()

std::string eve::biome_editor::BiomeRulesEditor::exclusionAsset ( int index ) const

Exclusion asset.

在文件 BiomeRulesEditor.cpp 第 374 行定义.

引用了 eve::biome_editing::BiomeDocumentTarget::exclusions() , 以及 index.

◆ exclusionCount()

int eve::biome_editor::BiomeRulesEditor::exclusionCount ( ) const

inline

Exclusion count.

在文件 BiomeRulesEditor.h 第 107 行定义.

◆ isAssetSelected()

bool eve::biome_editor::BiomeRulesEditor::isAssetSelected ( int index ) const

True when asset selected.

在文件 BiomeRulesEditor.cpp 第 369 行定义.

引用了 index.

◆ isLayerSelected()

bool eve::biome_editor::BiomeRulesEditor::isLayerSelected ( int index ) const

True when layer selected.

在文件 BiomeRulesEditor.cpp 第 349 行定义.

引用了 index , 以及 layerId().

◆ layerCount()

int eve::biome_editor::BiomeRulesEditor::layerCount ( ) const

inline

Layer count.

在文件 BiomeRulesEditor.h 第 83 行定义.

◆ layerDensity()

float eve::biome_editor::BiomeRulesEditor::layerDensity ( int index ) const

Layer density.

在文件 BiomeRulesEditor.cpp 第 341 行定义.

引用了 index , 以及 eve::biome_editing::BiomeDocumentTarget::layers().

◆ layerId()

std::string eve::biome_editor::BiomeRulesEditor::layerId ( int index ) const

Layer id.

在文件 BiomeRulesEditor.cpp 第 333 行定义.

引用了 index, eve::biome_editing::BiomeDocumentTarget::layers() , 以及 value.

被这些函数引用 isLayerSelected().

◆ layerName()

std::string eve::biome_editor::BiomeRulesEditor::layerName ( int index ) const

Layer name.

在文件 BiomeRulesEditor.cpp 第 337 行定义.

引用了 index, eve::biome_editing::BiomeDocumentTarget::layers() , 以及 name.

◆ layerPriority()

int eve::biome_editor::BiomeRulesEditor::layerPriority ( int index ) const

Layer priority.

在文件 BiomeRulesEditor.cpp 第 345 行定义.

引用了 index, eve::biome_editing::BiomeDocumentTarget::layers() , 以及 priority.

◆ operator=()

BiomeRulesEditor & eve::biome_editor::BiomeRulesEditor::operator= ( const BiomeRulesEditor & )

delete

◆ pointAsset()

std::string eve::biome_editor::BiomeRulesEditor::pointAsset ( int index ) const

Point asset.

在文件 BiomeRulesEditor.cpp 第 387 行定义.

引用了 index.

◆ pointCount()

int eve::biome_editor::BiomeRulesEditor::pointCount ( ) const

inline

Point count.

在文件 BiomeRulesEditor.h 第 112 行定义.

◆ pointX()

float eve::biome_editor::BiomeRulesEditor::pointX ( int index ) const

Point x.

在文件 BiomeRulesEditor.cpp 第 379 行定义.

引用了 index , 以及 x.

◆ pointZ()

float eve::biome_editor::BiomeRulesEditor::pointZ ( int index ) const

Point z.

在文件 BiomeRulesEditor.cpp 第 383 行定义.

引用了 index , 以及 z.

◆ previewRevision()

std::uint64_t eve::biome_editor::BiomeRulesEditor::previewRevision ( ) const

inlinenoexcept

Preview revision.

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

◆ redo()

biome_editing::Result< editor::TransactionReceipt > eve::biome_editor::BiomeRulesEditor::redo ( )

在文件 BiomeRulesEditor.cpp 第 304 行定义.

引用了 eve::Result< T >::failure() , 以及 eve::editor::LocalTransactionBackend::redo().

◆ removeExclusion()

biome_editing::Result< void > eve::biome_editor::BiomeRulesEditor::removeExclusion ( std::string spatialAsset )

在文件 BiomeRulesEditor.cpp 第 276 行定义.

引用了 eve::biome_editing::BiomeDocumentTarget::exclusions() , 以及 eve::biome_editing::BiomeDocumentTarget::makeSetExclusions().

◆ revision()

std::uint64_t eve::biome_editor::BiomeRulesEditor::revision ( ) const

inlinenoexcept

Revision.

在文件 BiomeRulesEditor.h 第 70 行定义.

被这些函数引用 addExclusion() , 以及 setLayerDensity().

◆ seed()

std::uint32_t eve::biome_editor::BiomeRulesEditor::seed ( ) const

inlinenoexcept

Seed.

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

被这些函数引用 setSeed().

◆ selectAsset()

biome_editing::Result< void > eve::biome_editor::BiomeRulesEditor::selectAsset ( std::string id )

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

引用了 found, id, layer , 以及 eve::biome_editing::BiomeDocumentTarget::layers().

被这些函数引用 createAsset().

◆ selectedId()

std::string eve::biome_editor::BiomeRulesEditor::selectedId ( ) const

inline

Selected id.

在文件 BiomeRulesEditor.h 第 78 行定义.

◆ selectedType()

std::string eve::biome_editor::BiomeRulesEditor::selectedType ( ) const

inline

Selected type.

在文件 BiomeRulesEditor.h 第 80 行定义.

◆ selectLayer()

biome_editing::Result< void > eve::biome_editor::BiomeRulesEditor::selectLayer ( std::string id )

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

引用了 found, id, layer , 以及 eve::biome_editing::BiomeDocumentTarget::layers().

被这些函数引用 createLayer() , 以及 deleteSelectedLayer().

◆ setAssetWeight()

biome_editing::Result< void > eve::biome_editor::BiomeRulesEditor::setAssetWeight ( double weight )

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

引用了 eve::biome_editing::BiomeDocumentTarget::makeSet() , 以及 weight.

◆ setLayerDensity()

biome_editing::Result< void > eve::biome_editor::BiomeRulesEditor::setLayerDensity ( double density )

在文件 BiomeRulesEditor.cpp 第 185 行定义.

引用了 eve::biome_editing::BiomeDocumentTarget::makeSet(), previous , 以及 revision().

◆ setLayerPriority()

biome_editing::Result< void > eve::biome_editor::BiomeRulesEditor::setLayerPriority ( int priority )

在文件 BiomeRulesEditor.cpp 第 202 行定义.

引用了 eve::biome_editing::BiomeDocumentTarget::makeSet() , 以及 priority.

◆ setSeed()

biome_editing::Result< void > eve::biome_editor::BiomeRulesEditor::setSeed ( std::uint32_t seed )

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

引用了 seed().

◆ setSpacing()

biome_editing::Result< void > eve::biome_editor::BiomeRulesEditor::setSpacing ( float spacing )

在文件 BiomeRulesEditor.cpp 第 287 行定义.

引用了 spacing().

◆ spacing()

float eve::biome_editor::BiomeRulesEditor::spacing ( ) const

inlinenoexcept

Spacing.

在文件 BiomeRulesEditor.h 第 76 行定义.

被这些函数引用 setSpacing().

◆ target()

const biome_editing::BiomeDocumentTarget & eve::biome_editor::BiomeRulesEditor::target ( ) const

inlinenoexcept

Borrow the authoritative biome document.

在文件 BiomeRulesEditor.h 第 41 行定义.

◆ undo()

biome_editing::Result< editor::TransactionReceipt > eve::biome_editor::BiomeRulesEditor::undo ( )

在文件 BiomeRulesEditor.cpp 第 295 行定义.

引用了 eve::Result< T >::failure() , 以及 eve::editor::LocalTransactionBackend::undo().

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

src/modules/procgen/biome/editor/BiomeRulesEditor.h
src/modules/procgen/biome/editor/BiomeRulesEditor.cpp

Public 成员函数

详细描述

构造及析构函数说明

◆ BiomeRulesEditor() [1/2]

◆ BiomeRulesEditor() [2/2]

成员函数说明

◆ addExclusion()

◆ assetCount()

◆ assetId()

◆ assetRef()

◆ assetWeight()

◆ canRedo()

◆ canUndo()

◆ configureWorkspace()

◆ createAsset()

◆ createLayer()

◆ deleteSelectedAsset()

◆ deleteSelectedLayer()

◆ exclusionAsset()

◆ exclusionCount()

◆ isAssetSelected()

◆ isLayerSelected()

◆ layerCount()

◆ layerDensity()

◆ layerId()

◆ layerName()

◆ layerPriority()

◆ operator=()

◆ pointAsset()

◆ pointCount()

◆ pointX()

◆ pointZ()

◆ previewRevision()

◆ redo()

◆ removeExclusion()

◆ revision()

◆ seed()

◆ selectAsset()

◆ selectedId()

◆ selectedType()

◆ selectLayer()

◆ setAssetWeight()

◆ setLayerDensity()

◆ setLayerPriority()

◆ setSeed()

◆ setSpacing()

◆ spacing()

◆ target()

◆ undo()