Element Class Reference

Common Elements base class. More...

Inheritance diagram for Element:

Public Member Functions
void	setParameter (string parameter, Value value)
	Sets an Element parameter.
Value	getParameter (string parameter)
	Gets an Element parameter.
bool	hasParameter (string parameter)
table	getParameterConnections (string parameter)
	Get all SignalConnection for this parameter.

Public Attributes
string	name
	internal element name
string	displayName
	name to display on the User Interface, name is used if displayName is not specified.
string	type
	internal element type
Element &	parent
	element parent
table	children
	element children using the element name as key
string	output
	output routing for the element
int	numParams
	number of parameters
table	parameterDefinitions
	table of parameter definitions.

Detailed Description

Common Elements base class.

See also

Elements & parameters

Member Function Documentation

getParameter()

Value Element::getParameter

(

string

parameter

)

Gets an Element parameter.

Parameters

parameter

parameterName or parameterId

Returns

parameterValue (number|bool|string) according to definition

See also

Elements & parameters

getParameterConnections()

table Element::getParameterConnections

(

string

parameter

)

Get all SignalConnection for this parameter.

Parameters

parameter

parameterName or parameterId

Returns

table of parameter connections

See also

Elements & parameters

hasParameter()

bool Element::hasParameter

(

string

parameter

)

Parameters

parameter

parameterName or parameterId

Returns

true or false

See also

Elements & parameters

setParameter()

void Element::setParameter	(	string	parameter,
		Value	value )

Sets an Element parameter.

Parameters

parameter	parameterName or parameterId
value	parameterValue (number|bool|string) according to definition

See also

Elements & parameters

Member Data Documentation

parameterDefinitions

table Element::parameterDefinitions

table of parameter definitions.

returns the following table:

property	type	optional
id	number	no
type	"int","float","bool","string"	no
default	type	no
displayName	string	no
description	string	no
readOnly	number	no
serialize	boolean	no
min	type	yes
max	type	yes