PhosphorTiles::ScriptedHelpers::CustomParamDef Struct Reference

Definition of a custom algorithm parameter, declared by a script's metadata.customParams list. More...

#include <phosphor-tiles/include/PhosphorTiles/TileScriptMetadata.h>

Public Member Functions
QVariantMap	toVariantMap () const
	Convert to QVariantMap for QML consumption.

Public Attributes
QString	name
	Parameter name (camelCase, used as key in ctx.custom)
QString	type
	"number", "bool", or "enum"
QVariant	defaultValue
	Default value.
QString	description
	Human-readable description for settings UI.
qreal	minValue = 0.0
	Minimum for number type.
qreal	maxValue = 1.0
	Maximum for number type.
QStringList	enumOptions
	Valid options for enum type.

Detailed Description

Definition of a custom algorithm parameter, declared by a script's metadata.customParams list.

Member Function Documentation

toVariantMap()

QVariantMap PhosphorTiles::ScriptedHelpers::CustomParamDef::toVariantMap ( ) const

inline

Convert to QVariantMap for QML consumption.

Member Data Documentation

defaultValue

QVariant PhosphorTiles::ScriptedHelpers::CustomParamDef::defaultValue

Default value.

description

QString PhosphorTiles::ScriptedHelpers::CustomParamDef::description

Human-readable description for settings UI.

enumOptions

QStringList PhosphorTiles::ScriptedHelpers::CustomParamDef::enumOptions

Valid options for enum type.

maxValue

qreal PhosphorTiles::ScriptedHelpers::CustomParamDef::maxValue = 1.0

Maximum for number type.

minValue

qreal PhosphorTiles::ScriptedHelpers::CustomParamDef::minValue = 0.0

Minimum for number type.

name

QString PhosphorTiles::ScriptedHelpers::CustomParamDef::name

Parameter name (camelCase, used as key in ctx.custom)

type

QString PhosphorTiles::ScriptedHelpers::CustomParamDef::type

"number", "bool", or "enum"

---

The documentation for this struct was generated from the following file:

• phosphor-tiles/include/PhosphorTiles/TileScriptMetadata.h