Functions
	MAXON_RESOURCE_DATABASE_SCOPE ("net.maxon.description.data.base")

	MAXON_ATTRIBUTE (Id, DATATYPE, "net.maxon.description.data.base.datatype")

	MAXON_ATTRIBUTE (Id, TYPECONSTRAINT, "net.maxon.description.data.base.typeconstraint")

	MAXON_ATTRIBUTE (Id, CLASSIFICATION, "net.maxon.description.data.base.classification", RESOURCE_DEFINE(ENUM_DATA, Id("data")))

	MAXON_ATTRIBUTE (void, GUIANDLIMITPRESET, "net.maxon.description.data.base.guiandlimitpreset")

	MAXON_ATTRIBUTE (Id, UNIT, "net.maxon.description.data.base.unit", RESOURCE_DEFINE(ENUM_TIME, Id("time")))

	MAXON_ATTRIBUTE (Data, DEFAULTVALUE, "net.maxon.description.data.base.defaultvalue")

	MAXON_ATTRIBUTE (Id, LIMITVALUE, "net.maxon.description.data.base.limitvalue", RESOURCE_DEFINE(ENUM_BOTH, Id("both")))

	MAXON_ATTRIBUTE (Data, MINVALUE, "net.maxon.description.data.base.minvalue")

	MAXON_ATTRIBUTE (Data, MAXVALUE, "net.maxon.description.data.base.maxvalue")

	MAXON_ATTRIBUTE (Id, INCLUDE, "net.maxon.description.data.base.include")

	MAXON_ATTRIBUTE (Array< Id >, INCLUDERENAME, "net.maxon.description.data.base.includerename")

	MAXON_ATTRIBUTE (Array< Id >, INCLUDEFILTER, "net.maxon.description.data.base.includefilter")

	MAXON_ATTRIBUTE (MAXON_MACROARG_TYPE(Array< Tuple< Id, Data >>), ENUM, "net.maxon.description.data.base.enum")

	MAXON_ATTRIBUTE (Id, DATABASEID, "net.maxon.description.data.base.databaseid")

	MAXON_ATTRIBUTE (Bool, OVERWRITABLE, "net.maxon.description.data.base.overwritable")

	MAXON_ATTRIBUTE (Bool, ISVARIADIC, "net.maxon.description.data.base.isvariadic")

	MAXON_ATTRIBUTE (Int, VARIADICCOUNT, "net.maxon.description.data.base.variadiccount")

	MAXON_ATTRIBUTE (Array< Id >, COMMANDS, "net.maxon.description.data.base.commands")

	MAXON_ATTRIBUTE (VariadicIdsType, VARIADICIDS, "net.maxon.description.data.base.variadicids")

	MAXON_ATTRIBUTE (String, WARNINGS, "net.maxon.description.data.base.warnings")

	MAXON_ATTRIBUTE (CString, COMMENT, "net.maxon.description.data.base.comment")

	MAXON_ATTRIBUTE (Bool, GENERATEIGNOREHEADER, "net.maxon.description.data.base.generateignoreheader")

	MAXON_ATTRIBUTE (Bool, INHERITSTRING, "net.maxon.description.data.base.inheritstring")

	MAXON_ATTRIBUTE (Bool, OPTIONALSTRING, "net.maxon.description.data.base.optionalstring")

	MAXON_ATTRIBUTE (Bool, EXCLUDEFROMPRESETS, "net.maxon.description.data.base.excludefrompresets")

	MAXON_ATTRIBUTE (CString, NAMESPACE, "net.maxon.description.data.base.namespace")

	MAXON_ATTRIBUTE (MAXON_MACROARG_TYPE(Tuple< Id, InternedId >), INCLUDEDFROM, "net.maxon.description.data.base.includedfrom")

	MAXON_ATTRIBUTE (Id, ORIGIN, "net.maxon.description.data.base.origin")

	MAXON_ATTRIBUTE (Group, GROUPINFO, "net.maxon.description.data.base.groupinfo")

Function Documentation

◆ MAXON_RESOURCE_DATABASE_SCOPE()

maxon::DESCRIPTION::DATA::BASE::MAXON_RESOURCE_DATABASE_SCOPE ( "net.maxon.description.data.base" )

◆ MAXON_ATTRIBUTE() [1/29]

maxon::DESCRIPTION::DATA::BASE::MAXON_ATTRIBUTE	(	Id	,
		DATATYPE	,
		"net.maxon.description.data.base.datatype"
	)

Use DataTypeLib::GetRuntimeDataType to query the correct const DataType*. Some datatypes need to be converted into runtime types. E.g. "int" and "float" will be adjusted to the 32 or 64 types which the compiler defined for the current platform. But also types based on Int or Float (such as Vector) have to be converted.

◆ MAXON_ATTRIBUTE() [2/29]

maxon::DESCRIPTION::DATA::BASE::MAXON_ATTRIBUTE	(	Id	,
		TYPECONSTRAINT	,
		"net.maxon.description.data.base.typeconstraint"
	)

This is for ports where you don't want to prescribe an exact datatype, but just a constraint for the allowed types of the port.

◆ MAXON_ATTRIBUTE() [3/29]

maxon::DESCRIPTION::DATA::BASE::MAXON_ATTRIBUTE	(	Id	,
		CLASSIFICATION	,
		"net.maxon.description.data.base.classification"	,
		RESOURCE_DEFINE(ENUM_DATA, Id("data"))
	)

Classification of the attribute. This can be any of the given enum types.

◆ MAXON_ATTRIBUTE() [4/29]

maxon::DESCRIPTION::DATA::BASE::MAXON_ATTRIBUTE	(	void	,
		GUIANDLIMITPRESET	,
		"net.maxon.description.data.base.guiandlimitpreset"
	)

◆ MAXON_ATTRIBUTE() [5/29]

maxon::DESCRIPTION::DATA::BASE::MAXON_ATTRIBUTE	(	Id	,
		UNIT	,
		"net.maxon.description.data.base.unit"	,
		RESOURCE_DEFINE(ENUM_TIME, Id("time"))
	)

◆ MAXON_ATTRIBUTE() [6/29]

maxon::DESCRIPTION::DATA::BASE::MAXON_ATTRIBUTE	(	Data	,
		DEFAULTVALUE	,
		"net.maxon.description.data.base.defaultvalue"
	)

◆ MAXON_ATTRIBUTE() [7/29]

maxon::DESCRIPTION::DATA::BASE::MAXON_ATTRIBUTE	(	Id	,
		LIMITVALUE	,
		"net.maxon.description.data.base.limitvalue"	,
		RESOURCE_DEFINE(ENUM_BOTH, Id("both"))
	)

◆ MAXON_ATTRIBUTE() [8/29]

maxon::DESCRIPTION::DATA::BASE::MAXON_ATTRIBUTE	(	Data	,
		MINVALUE	,
		"net.maxon.description.data.base.minvalue"
	)

◆ MAXON_ATTRIBUTE() [9/29]

maxon::DESCRIPTION::DATA::BASE::MAXON_ATTRIBUTE	(	Data	,
		MAXVALUE	,
		"net.maxon.description.data.base.maxvalue"
	)

◆ MAXON_ATTRIBUTE() [10/29]

maxon::DESCRIPTION::DATA::BASE::MAXON_ATTRIBUTE	(	Id	,
		INCLUDE	,
		"net.maxon.description.data.base.include"
	)

◆ MAXON_ATTRIBUTE() [11/29]

maxon::DESCRIPTION::DATA::BASE::MAXON_ATTRIBUTE	(	Array< Id >	,
		INCLUDERENAME	,
		"net.maxon.description.data.base.includerename"
	)

Fill with a list of identifier pairs such as "attribute_identifier->renamed_identifier" (one per line) to remap some of the included attributes. Attributes which are not remapped will be included using their original identifier.

◆ MAXON_ATTRIBUTE() [12/29]

maxon::DESCRIPTION::DATA::BASE::MAXON_ATTRIBUTE	(	Array< Id >	,
		INCLUDEFILTER	,
		"net.maxon.description.data.base.includefilter"
	)

Fill with list of attribute identifiers (one per line) to whitelist them. All other included attributes will be skipped.

◆ MAXON_ATTRIBUTE() [13/29]

maxon::DESCRIPTION::DATA::BASE::MAXON_ATTRIBUTE	(	MAXON_MACROARG_TYPE(Array< Tuple< Id, Data >>)	,
		ENUM	,
		"net.maxon.description.data.base.enum"
	)

◆ MAXON_ATTRIBUTE() [14/29]

maxon::DESCRIPTION::DATA::BASE::MAXON_ATTRIBUTE	(	Id	,
		DATABASEID	,
		"net.maxon.description.data.base.databaseid"
	)

Command info: database ID which loaded this description.

◆ MAXON_ATTRIBUTE() [15/29]

maxon::DESCRIPTION::DATA::BASE::MAXON_ATTRIBUTE	(	Bool	,
		OVERWRITABLE	,
		"net.maxon.description.data.base.overwritable"
	)

True if the attribute should be overwritable for takes in the take system.

◆ MAXON_ATTRIBUTE() [16/29]

maxon::DESCRIPTION::DATA::BASE::MAXON_ATTRIBUTE	(	Bool	,
		ISVARIADIC	,
		"net.maxon.description.data.base.isvariadic"
	)

This attribute is set for a variadic port. A variadic port can be expanded a number of times.

◆ MAXON_ATTRIBUTE() [17/29]

maxon::DESCRIPTION::DATA::BASE::MAXON_ATTRIBUTE	(	Int	,
		VARIADICCOUNT	,
		"net.maxon.description.data.base.variadiccount"
	)

This attribute sets the default number of ports of a variadic port.

◆ MAXON_ATTRIBUTE() [18/29]

maxon::DESCRIPTION::DATA::BASE::MAXON_ATTRIBUTE	(	Array< Id >	,
		COMMANDS	,
		"net.maxon.description.data.base.commands"
	)

Fill this Id list to have command buttons associated with this attribute. Those commands will propagate with the port.

◆ MAXON_ATTRIBUTE() [19/29]

maxon::DESCRIPTION::DATA::BASE::MAXON_ATTRIBUTE	(	VariadicIdsType	,
		VARIADICIDS	,
		"net.maxon.description.data.base.variadicids"
	)

contains an array of IDs in case isvariadic is true. This value will be filled in programmatically.

◆ MAXON_ATTRIBUTE() [20/29]

maxon::DESCRIPTION::DATA::BASE::MAXON_ATTRIBUTE	(	String	,
		WARNINGS	,
		"net.maxon.description.data.base.warnings"
	)

Show why the element has warnings.

◆ MAXON_ATTRIBUTE() [21/29]

maxon::DESCRIPTION::DATA::BASE::MAXON_ATTRIBUTE	(	CString	,
		COMMENT	,
		"net.maxon.description.data.base.comment"
	)

Include export: comment to be added to the include export.

◆ MAXON_ATTRIBUTE() [22/29]

maxon::DESCRIPTION::DATA::BASE::MAXON_ATTRIBUTE	(	Bool	,
		GENERATEIGNOREHEADER	,
		"net.maxon.description.data.base.generateignoreheader"
	)

Command info: True to prevent this attribute from exporting to the header file.

◆ MAXON_ATTRIBUTE() [23/29]

maxon::DESCRIPTION::DATA::BASE::MAXON_ATTRIBUTE	(	Bool	,
		INHERITSTRING	,
		"net.maxon.description.data.base.inheritstring"
	)

True if the attribute should be inherited in child descriptions (descriptions that include the current one).. If true, the entry will show under root or a group in the layout tree so that parameters can be tweaked for the needs of the description making the include. In other words, this parameter allows to expose an attribute to non developer mode. Can be used on any attribute type (Attribute, Command, Group, ...).

◆ MAXON_ATTRIBUTE() [24/29]

maxon::DESCRIPTION::DATA::BASE::MAXON_ATTRIBUTE	(	Bool	,
		OPTIONALSTRING	,
		"net.maxon.description.data.base.optionalstring"
	)

True if the string is optional and should receive a translation only if reference language provides a string. Use this to avoid some translation warnings. Can be used on any attribute type which contains string data (Attribute, Command, Group, ...).

◆ MAXON_ATTRIBUTE() [25/29]

maxon::DESCRIPTION::DATA::BASE::MAXON_ATTRIBUTE	(	Bool	,
		EXCLUDEFROMPRESETS	,
		"net.maxon.description.data.base.excludefrompresets"
	)

True if the attribute's default value is to be excluded from defaults presets. Set it for node ports which don't make sense for presets or for tool attributes which change a lot in usual workflows.

◆ MAXON_ATTRIBUTE() [26/29]

maxon::DESCRIPTION::DATA::BASE::MAXON_ATTRIBUTE	(	CString	,
		NAMESPACE	,
		"net.maxon.description.data.base.namespace"
	)

Command info: namespace that generated that symbol.

◆ MAXON_ATTRIBUTE() [27/29]

maxon::DESCRIPTION::DATA::BASE::MAXON_ATTRIBUTE	(	MAXON_MACROARG_TYPE(Tuple< Id, InternedId >)	,
		INCLUDEDFROM	,
		"net.maxon.description.data.base.includedfrom"
	)

Is only set if the attribute was included by another attribute. Id - database ID of the included object Data - identifier of the include attribute

◆ MAXON_ATTRIBUTE() [28/29]

maxon::DESCRIPTION::DATA::BASE::MAXON_ATTRIBUTE	(	Id	,
		ORIGIN	,
		"net.maxon.description.data.base.origin"
	)

This value returns the original data type ID which defined the attribute.

◆ MAXON_ATTRIBUTE() [29/29]

maxon::DESCRIPTION::DATA::BASE::MAXON_ATTRIBUTE	(	Group	,
		GROUPINFO	,
		"net.maxon.description.data.base.groupinfo"
	)

Functions