EVEngine: eve::procgen::ParamDescriptor结构体参考

载入中...

搜索中...

未找到

UI-independent metadata for one procedural recipe parameter. 更多...

#include <ParamSchema.h>

静态 Public 成员函数
static ParamDescriptor	integer (std::string key, std::string label, int defaultValue, int minimum, int maximum, int step=1)
	Construct a bounded integer descriptor.

static ParamDescriptor	floating (std::string key, std::string label, float defaultValue, float minimum, float maximum, float step)
	Construct a bounded floating-point descriptor.

static ParamDescriptor	boolean (std::string key, std::string label, bool defaultValue)
	Construct a Boolean descriptor stored as zero or one in Params.

static ParamDescriptor	text (std::string key, std::string label, std::string defaultValue)
	Construct a free-form string descriptor.

static ParamDescriptor	choice (std::string key, std::string label, std::string defaultValue, std::vector< std::string > choices)
	Construct a finite-choice string descriptor.

Public 属性
std::string	key

std::string	displayName

std::string	description

std::string	category = "General"

ParamKind	kind = ParamKind::String

std::string	defaultValue

bool	hasMinimum = false

bool	hasMaximum = false

double	minimum = 0.0

double	maximum = 0.0

double	step = 0.0

std::vector< std::string >	choices

bool	advanced = false

详细描述

UI-independent metadata for one procedural recipe parameter.

在文件 ParamSchema.h 第 14 行定义.

成员函数说明

◆ boolean()

ParamDescriptor eve::procgen::ParamDescriptor::boolean	(	std::string	key,
		std::string	label,
		bool	defaultValue
	)

static

Construct a Boolean descriptor stored as zero or one in Params.

参数

key	Stable parameter key.
label	Display label.
defaultValue	Default value.

返回: Parameter metadata.

在文件 ParamSchema.cpp 第 47 行定义.

引用了 eve::procgen::Boolean, defaultValue, displayName, key, kind , 以及 label.

被这些函数引用 eve::procgen::makeTextureRecipeDescriptor(), eve::procgen::TextureRecipeRegistry::registerBuiltins(), eve::procgen::registerMeshDeformationGeometryRecipes(), eve::procgen::road::registerRoadMeshRecipes(), eve::procgen::road::registerRoadTextureRecipes() , 以及 eve::procgen::registerTerrainHeightmapAlgorithm().

◆ choice()

ParamDescriptor eve::procgen::ParamDescriptor::choice	(	std::string	key,
		std::string	label,
		std::string	defaultValue,
		std::vector< std::string >	choices
	)

static

Construct a finite-choice string descriptor.

参数

key	Stable parameter key.
label	Display label.
defaultValue	Default value.
choices	Allowed values.

返回: Parameter metadata.

在文件 ParamSchema.cpp 第 65 行定义.

引用了 eve::procgen::Choice, choices, defaultValue, key, kind, label , 以及 text.

被这些函数引用 eve::procgen::registerCaveMeshRecipe(), eve::procgen::registerLSystemRecipes(), eve::procgen::road::registerRoadMeshRecipes() , 以及 eve::procgen::registerWfcSimple().

◆ floating()

ParamDescriptor eve::procgen::ParamDescriptor::floating	(	std::string	key,
		std::string	label,
		float	defaultValue,
		float	minimum,
		float	maximum,
		float	step
	)

static

Construct a bounded floating-point descriptor.

参数

key	Stable parameter key.
label	Display label.
defaultValue	Default value.
minimum	Inclusive minimum.
maximum	Inclusive maximum.
step	Suggested editor step.

返回: Parameter metadata.

在文件 ParamSchema.cpp 第 33 行定义.

引用了 defaultValue, displayName, eve::procgen::Float, hasMaximum, hasMinimum, key, kind, label, maximum, minimum , 以及 step.

被这些函数引用 eve::procgen::makeTextureRecipeDescriptor(), eve::procgen::GeneratorRegistry::registerBuiltins(), eve::procgen::TextureRecipeRegistry::registerBuiltins(), eve::procgen::registerCastleMeshRecipe(), eve::procgen::registerCaveMeshRecipe(), eve::procgen::registerHexTerrainAlgorithms(), eve::procgen::registerLinearStructureRecipes(), eve::procgen::registerLSystemRecipes(), eve::procgen::registerMeshDeformationGeometryRecipes(), eve::procgen::PbrRecipeRegistry::registerPbrBuiltins(), eve::procgen::road::registerRoadMeshRecipes(), eve::procgen::road::registerRoadTextureRecipes(), eve::procgen::registerTerrainHeightmapAlgorithm() , 以及 eve::procgen::urban::registerUrbanMeshRecipes().

◆ integer()

ParamDescriptor eve::procgen::ParamDescriptor::integer	(	std::string	key,
		std::string	label,
		int	defaultValue,
		int	minimum,
		int	maximum,
		int	step = `1`
	)

static

Construct a bounded integer descriptor.

参数

key	Stable parameter key.
label	Display label.
defaultValue	Default value.
minimum	Inclusive minimum.
maximum	Inclusive maximum.
step	Suggested editor step.

返回: Parameter metadata.

在文件 ParamSchema.cpp 第 19 行定义.

引用了 defaultValue, displayName, hasMaximum, hasMinimum, eve::procgen::Integer, key, kind, label, maximum, minimum , 以及 step.

被这些函数引用 eve::procgen::RecipeDescriptor::grid(), eve::procgen::makeTextureRecipeDescriptor(), eve::procgen::GeneratorRegistry::registerBuiltins(), eve::procgen::TextureRecipeRegistry::registerBuiltins(), eve::procgen::registerCastleMeshRecipe(), eve::procgen::registerCaveMeshRecipe(), eve::procgen::registerHexTerrainAlgorithms(), eve::procgen::registerLinearStructureRecipes(), eve::procgen::registerLSystemRecipes(), eve::procgen::registerMeshDeformationGeometryRecipes(), eve::procgen::road::registerRoadMeshRecipes(), eve::procgen::registerTerrainHeightmapAlgorithm() , 以及 eve::procgen::registerWfcSimple().

◆ text()

ParamDescriptor eve::procgen::ParamDescriptor::text	(	std::string	key,
		std::string	label,
		std::string	defaultValue
	)

static

Construct a free-form string descriptor.

参数

key	Stable parameter key.
label	Display label.
defaultValue	Default value.

返回: Parameter metadata.

在文件 ParamSchema.cpp 第 56 行定义.

引用了 defaultValue, displayName, key, kind, label , 以及 eve::procgen::String.

类成员变量说明

◆ advanced

bool eve::procgen::ParamDescriptor::advanced = false

在文件 ParamSchema.h 第 27 行定义.

被这些函数引用 eve::procgen::Procgen::isAlgorithmParamAdvanced(), eve::procgen::RecipeDescriptor::isParamAdvanced(), eve::procgen_editing::ProcgenScriptDocumentTarget::parseSpec() , 以及 eve::procgen_editing::ProcgenScriptDocumentTarget::schema().

◆ category

std::string eve::procgen::ParamDescriptor::category = "General"

在文件 ParamSchema.h 第 18 行定义.

被这些函数引用 eve::procgen::Procgen::getAlgorithmParamCategory(), eve::procgen::RecipeDescriptor::getParamCategory(), eve::procgen_editing::ProcgenScriptDocumentTarget::parseSpec() , 以及 eve::procgen_editing::ProcgenScriptDocumentTarget::schema().

◆ choices

std::vector<std::string> eve::procgen::ParamDescriptor::choices

在文件 ParamSchema.h 第 26 行定义.

被这些函数引用 choice(), eve::procgen::Procgen::getAlgorithmParamChoice(), eve::procgen::Procgen::getAlgorithmParamChoiceCount(), eve::procgen::RecipeDescriptor::getParamChoice(), eve::procgen::RecipeDescriptor::getParamChoiceCount(), eve::procgen_editing::ProcgenScriptDocumentTarget::parseSpec() , 以及 eve::procgen_editing::ProcgenScriptDocumentTarget::schema().

◆ defaultValue

std::string eve::procgen::ParamDescriptor::defaultValue

在文件 ParamSchema.h 第 20 行定义.

被这些函数引用 boolean(), choice(), floating(), eve::procgen::Procgen::getAlgorithmParamDefault(), eve::procgen::RecipeDescriptor::getParamDefault(), integer(), eve::procgen_editing::ProcgenScriptDocumentTarget::parseSpec() , 以及 text().

◆ description

std::string eve::procgen::ParamDescriptor::description

在文件 ParamSchema.h 第 17 行定义.

被这些函数引用 eve::procgen::Procgen::getAlgorithmParamDescription(), eve::procgen::RecipeDescriptor::getParamDescription(), eve::procgen_editing::ProcgenScriptDocumentTarget::parseSpec() , 以及 eve::procgen_editing::ProcgenScriptDocumentTarget::schema().

◆ displayName

std::string eve::procgen::ParamDescriptor::displayName

在文件 ParamSchema.h 第 16 行定义.

被这些函数引用 boolean(), floating(), eve::procgen::Procgen::getAlgorithmParamLabel(), eve::procgen::RecipeDescriptor::getParamLabel(), integer(), eve::procgen_editing::ProcgenScriptDocumentTarget::parseSpec(), eve::procgen_editing::ProcgenScriptDocumentTarget::schema() , 以及 text().

◆ hasMaximum

bool eve::procgen::ParamDescriptor::hasMaximum = false

在文件 ParamSchema.h 第 22 行定义.

被这些函数引用 eve::procgen::Procgen::algorithmParamHasMaximum(), floating(), integer(), eve::procgen::RecipeDescriptor::paramHasMaximum(), eve::procgen_editing::ProcgenScriptDocumentTarget::parseSpec() , 以及 eve::procgen_editing::ProcgenScriptDocumentTarget::schema().

◆ hasMinimum

bool eve::procgen::ParamDescriptor::hasMinimum = false

在文件 ParamSchema.h 第 21 行定义.

被这些函数引用 eve::procgen::Procgen::algorithmParamHasMinimum(), floating(), integer(), eve::procgen::RecipeDescriptor::paramHasMinimum(), eve::procgen_editing::ProcgenScriptDocumentTarget::parseSpec() , 以及 eve::procgen_editing::ProcgenScriptDocumentTarget::schema().

◆ key

std::string eve::procgen::ParamDescriptor::key

在文件 ParamSchema.h 第 15 行定义.

被这些函数引用 boolean(), choice(), eve::procgen_editing::ProcgenScriptDocumentTarget::findParam(), floating(), eve::procgen::Procgen::getAlgorithmParamKey(), eve::procgen::RecipeDescriptor::getParamKey(), integer(), eve::procgen_editing::ProcgenScriptDocumentTarget::parseSpec(), eve::procgen_editing::ProcgenScriptDocumentTarget::schema(), text() , 以及 eve::procgen_editing::ProcgenScriptDocumentTarget::validate().

◆ kind

ParamKind eve::procgen::ParamDescriptor::kind = ParamKind::String

在文件 ParamSchema.h 第 19 行定义.

被这些函数引用 boolean(), choice(), floating(), eve::procgen::Procgen::getAlgorithmParamKind(), eve::procgen::RecipeDescriptor::getParamKind(), integer(), eve::procgen_editing::ProcgenScriptDocumentTarget::parseSpec(), eve::procgen_editing::ProcgenScriptDocumentTarget::schema() , 以及 text().

◆ maximum

double eve::procgen::ParamDescriptor::maximum = 0.0

在文件 ParamSchema.h 第 24 行定义.

被这些函数引用 floating(), eve::procgen::Procgen::getAlgorithmParamMaximum(), eve::procgen::RecipeDescriptor::getParamMaximum(), integer(), eve::procgen_editing::ProcgenScriptDocumentTarget::parseSpec() , 以及 eve::procgen_editing::ProcgenScriptDocumentTarget::schema().

◆ minimum

double eve::procgen::ParamDescriptor::minimum = 0.0

在文件 ParamSchema.h 第 23 行定义.

被这些函数引用 floating(), eve::procgen::Procgen::getAlgorithmParamMinimum(), eve::procgen::RecipeDescriptor::getParamMinimum(), integer(), eve::procgen_editing::ProcgenScriptDocumentTarget::parseSpec() , 以及 eve::procgen_editing::ProcgenScriptDocumentTarget::schema().

◆ step

double eve::procgen::ParamDescriptor::step = 0.0

在文件 ParamSchema.h 第 25 行定义.

被这些函数引用 floating(), eve::procgen::Procgen::getAlgorithmParamStep(), eve::procgen::RecipeDescriptor::getParamStep(), integer(), eve::procgen_editing::ProcgenScriptDocumentTarget::parseSpec() , 以及 eve::procgen_editing::ProcgenScriptDocumentTarget::schema().

该结构体的文档由以下文件生成:

src/modules/procgen/ParamSchema.h
src/modules/procgen/ParamSchema.cpp