Namespaces
	ADDMINMAX

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

	MAXON_ATTRIBUTE (Id, DEFAULTCLASSIFICATION, "net.maxon.description.ui.base.defaultclassification", RESOURCE_DEFINE(ENUM_OUTPUT, Id("output")))

	MAXON_ATTRIBUTE (Id, GUITYPEID, "net.maxon.description.ui.base.guitypeid")

	MAXON_ATTRIBUTE (Array< Id >, BASELINK_ACCEPT, "net.maxon.description.ui.base.baselink.accept")

	MAXON_ATTRIBUTE (InternedId, GROUPID, "net.maxon.description.ui.base.groupid")

	MAXON_ATTRIBUTE (Bool, SHOWGROUPINPORTLIST, "net.maxon.description.ui.base.showgroupinportlist")

	MAXON_ATTRIBUTE (CString, SHOW, "net.maxon.description.ui.base.show")

	MAXON_ATTRIBUTE (CString, ENABLE, "net.maxon.description.ui.base.enable")

	MAXON_ATTRIBUTE (InternedId, PARENTFOLDERID, "net.maxon.description.ui.base.parentfolderid")

	MAXON_ATTRIBUTE (Bool, PARENTFOLDERIDDEFAULTOPEN, "net.maxon.description.ui.base.parentfolderiddefaultopen")

	MAXON_ATTRIBUTE (Id, PRESETDATABASEID, "net.maxon.description.ui.base.presetdatabaseid")

	MAXON_ATTRIBUTE (MAXON_MACROARG_TYPE(Array< Tuple< InternedId, InternedId >>), PRESETMEMBERS, "net.maxon.description.ui.base.presetmembers")

	MAXON_ATTRIBUTE (Id, PRESETDATABASEDYNAMICID, "net.maxon.description.ui.base.presetdatabasedynamicid")

	MAXON_ATTRIBUTE (Array< Id >, ENUM, "net.maxon.description.ui.base.enum")

	MAXON_ATTRIBUTE (Bool, ENUMSORTMODE, "net.maxon.description.ui.base.enumsortmode")

	MAXON_ATTRIBUTE (Int, PORTSTATE, "net.maxon.description.ui.base.portstate", RESOURCE_DEFINE(ENUM_HASWARNING, 16))

	MAXON_ATTRIBUTE (Bool, OPTIONALCHILDRENSTRINGS, "net.maxon.description.ui.base.optionalchildrenstrings")

	MAXON_ATTRIBUTE (Id, COMMANDTYPE, "net.maxon.description.ui.base.commandtype", RESOURCE_DEFINE(ENUM_MENU, Id("menu")))

	MAXON_ATTRIBUTE (Id, COMMANDCONTEXT, "net.maxon.description.ui.base.commandcontext", RESOURCE_DEFINE(ENUM_APPWIDGET, Id("appwidget")))

	MAXON_ATTRIBUTE (Id, COMMANDICONID, "net.maxon.description.ui.base.commandiconid")

	MAXON_ATTRIBUTE (Id, COMMANDSHORTCUTID, "net.maxon.description.ui.base.commandshortcutid")

	MAXON_ATTRIBUTE (Bool, GROUPDEFAULTOPEN, "net.maxon.description.ui.base.groupdefaultopen")

	MAXON_ATTRIBUTE (Bool, UIDEFAULTOPEN, "net.maxon.description.ui.base.uidefaultopen")

	MAXON_ATTRIBUTE (Bool, GROUPTITLEBAR, "net.maxon.description.ui.base.grouptitlebar")

	MAXON_ATTRIBUTE (Int, GROUPCOLUMNS, "net.maxon.description.ui.base.groupcolumns")

	MAXON_ATTRIBUTE (Bool, SCALEV, "net.maxon.description.ui.base.scalev")

	MAXON_ATTRIBUTE (Bool, SCALEH, "net.maxon.description.ui.base.scaleh")

	MAXON_ATTRIBUTE (Bool, ANIMATABLE, "net.maxon.description.ui.base.animatable")

	MAXON_ATTRIBUTE (Bool, HIDEWHENINLINE, "net.maxon.description.ui.base.hidewheninline")

	MAXON_ATTRIBUTE (Bool, MULTILINETITLE, "net.maxon.description.ui.base.multilinetitle")

Function Documentation

◆ MAXON_RESOURCE_DATABASE_SCOPE()

maxon::DESCRIPTION::UI::BASE::MAXON_RESOURCE_DATABASE_SCOPE ( "net.maxon.description.ui.base" )

◆ MAXON_ATTRIBUTE() [1/29]

maxon::DESCRIPTION::UI::BASE::MAXON_ATTRIBUTE	(	Id	,
		DEFAULTCLASSIFICATION	,
		"net.maxon.description.ui.base.defaultclassification"	,
		RESOURCE_DEFINE(ENUM_OUTPUT, Id("output"))
	)

Default Classification of the attributes inserted under this group. If set to something else than "none" objects inserted under this group will be changed to this classification.

◆ MAXON_ATTRIBUTE() [2/29]

maxon::DESCRIPTION::UI::BASE::MAXON_ATTRIBUTE	(	Id	,
		GUITYPEID	,
		"net.maxon.description.ui.base.guitypeid"
	)

ID of the ui to use to display this attribute.

◆ MAXON_ATTRIBUTE() [3/29]

maxon::DESCRIPTION::UI::BASE::MAXON_ATTRIBUTE	(	Array< Id >	,
		BASELINK_ACCEPT	,
		"net.maxon.description.ui.base.baselink.accept"
	)

Accept list for link fields. It's possible to use symbolic names like Obase, Ocamera.

◆ MAXON_ATTRIBUTE() [4/29]

maxon::DESCRIPTION::UI::BASE::MAXON_ATTRIBUTE	(	InternedId	,
		GROUPID	,
		"net.maxon.description.ui.base.groupid"
	)

ID of the group into which the attribute should be assigned.

◆ MAXON_ATTRIBUTE() [5/29]

maxon::DESCRIPTION::UI::BASE::MAXON_ATTRIBUTE	(	Bool	,
		SHOWGROUPINPORTLIST	,
		"net.maxon.description.ui.base.showgroupinportlist"
	)

◆ MAXON_ATTRIBUTE() [6/29]

maxon::DESCRIPTION::UI::BASE::MAXON_ATTRIBUTE	(	CString	,
		SHOW	,
		"net.maxon.description.ui.base.show"
	)

Condition which will be evaluated before displaying the value. If the term returns false the attribute will be hidden.

◆ MAXON_ATTRIBUTE() [7/29]

maxon::DESCRIPTION::UI::BASE::MAXON_ATTRIBUTE	(	CString	,
		ENABLE	,
		"net.maxon.description.ui.base.enable"
	)

Condition which controls the enabling of the ui element. True to enable it.

◆ MAXON_ATTRIBUTE() [8/29]

maxon::DESCRIPTION::UI::BASE::MAXON_ATTRIBUTE	(	InternedId	,
		PARENTFOLDERID	,
		"net.maxon.description.ui.base.parentfolderid"
	)

Optional ID of the parent attribute. If given the ui will ident the attribute. If the parent contains it's own id the parent is foldable.

◆ MAXON_ATTRIBUTE() [9/29]

maxon::DESCRIPTION::UI::BASE::MAXON_ATTRIBUTE	(	Bool	,
		PARENTFOLDERIDDEFAULTOPEN	,
		"net.maxon.description.ui.base.parentfolderiddefaultopen"
	)

True to open the parent group by default.

◆ MAXON_ATTRIBUTE() [10/29]

maxon::DESCRIPTION::UI::BASE::MAXON_ATTRIBUTE	(	Id	,
		PRESETDATABASEID	,
		"net.maxon.description.ui.base.presetdatabaseid"
	)

Command "preset": Preset ID to define the key under which the presetmembers will be stored. E.g. "net.maxon.presets.colors".

◆ MAXON_ATTRIBUTE() [11/29]

maxon::DESCRIPTION::UI::BASE::MAXON_ATTRIBUTE	(	MAXON_MACROARG_TYPE(Array< Tuple< InternedId, InternedId >>)	,
		PRESETMEMBERS	,
		"net.maxon.description.ui.base.presetmembers"
	)

Command "preset": A list of preset members to store under the preset id.

◆ MAXON_ATTRIBUTE() [12/29]

maxon::DESCRIPTION::UI::BASE::MAXON_ATTRIBUTE	(	Id	,
		PRESETDATABASEDYNAMICID	,
		"net.maxon.description.ui.base.presetdatabasedynamicid"
	)

Database ID string used at runtime to determine the precise database to use for an attribute. For instance "preset_net.maxon.preset.neutron.distribution.parametric.spiral.{net.maxon.description.data.base.datatype}".

◆ MAXON_ATTRIBUTE() [13/29]

maxon::DESCRIPTION::UI::BASE::MAXON_ATTRIBUTE	(	Array< Id >	,
		ENUM	,
		"net.maxon.description.ui.base.enum"
	)

Allows to reorder the enum fields of the DATADESCRIPTIONPROPS. The following options are available: "---" - add a separator <<any id>> - add a specific id registry#<<name>> - fill in all members of an extension point enum#<<name>> - insert the members of the suggested enum resource at this point node#<<name>> - insert the nodes that implement the specified base

- fill in all other member not listed explicitly

◆ MAXON_ATTRIBUTE() [14/29]

maxon::DESCRIPTION::UI::BASE::MAXON_ATTRIBUTE	(	Bool	,
		ENUMSORTMODE	,
		"net.maxon.description.ui.base.enumsortmode"
	)

Enables alphabetical sorting of the "net.maxon.description.data.base.enum" entries and also preset entries. Ordering will be specified by "net.maxon.description.ui.base.enum" if sorting is disabled. In such a case, values added by special entries (registry#, enum#,...) will be inserted in the same order they are given by ProcessEnumListDelegate.

◆ MAXON_ATTRIBUTE() [15/29]

maxon::DESCRIPTION::UI::BASE::MAXON_ATTRIBUTE	(	Int	,
		PORTSTATE	,
		"net.maxon.description.ui.base.portstate"	,
		RESOURCE_DEFINE(ENUM_HASWARNING, 16)
	)

Gives the portstate.

◆ MAXON_ATTRIBUTE() [16/29]

maxon::DESCRIPTION::UI::BASE::MAXON_ATTRIBUTE	(	Bool	,
		OPTIONALCHILDRENSTRINGS	,
		"net.maxon.description.ui.base.optionalchildrenstrings"
	)

True if strings of children of this attribute are optional and not requiried to translate.

◆ MAXON_ATTRIBUTE() [17/29]

maxon::DESCRIPTION::UI::BASE::MAXON_ATTRIBUTE	(	Id	,
		COMMANDTYPE	,
		"net.maxon.description.ui.base.commandtype"	,
		RESOURCE_DEFINE(ENUM_MENU, Id("menu"))
	)

If the attribute is a "command" it's possible to specify the appearance of the command as a button or menu

◆ MAXON_ATTRIBUTE() [18/29]

maxon::DESCRIPTION::UI::BASE::MAXON_ATTRIBUTE	(	Id	,
		COMMANDCONTEXT	,
		"net.maxon.description.ui.base.commandcontext"	,
		RESOURCE_DEFINE(ENUM_APPWIDGET, Id("appwidget"))
	)

Context for the command. nodecore - command belongs to the NodesGraphInterface nimbuscore - command belongs to the NimbusInterface (includes nodecore) nodepresenter - command belongs to the NodePresenterInterface nodegraphwidget - command belongs to the NodeGraphWidgetInterface

◆ MAXON_ATTRIBUTE() [19/29]

maxon::DESCRIPTION::UI::BASE::MAXON_ATTRIBUTE	(	Id	,
		COMMANDICONID	,
		"net.maxon.description.ui.base.commandiconid"
	)

Icon ID of the icon that should be used the id can be a qualified name of a registered icon or a c4d icon id as number.

◆ MAXON_ATTRIBUTE() [20/29]

maxon::DESCRIPTION::UI::BASE::MAXON_ATTRIBUTE	(	Id	,
		COMMANDSHORTCUTID	,
		"net.maxon.description.ui.base.commandshortcutid"
	)

Shortcut ID of the command that should be used the id can be a qualified name of a registered shortcut or a c4d command id as number.

◆ MAXON_ATTRIBUTE() [21/29]

maxon::DESCRIPTION::UI::BASE::MAXON_ATTRIBUTE	(	Bool	,
		GROUPDEFAULTOPEN	,
		"net.maxon.description.ui.base.groupdefaultopen"
	)

True if the group should be open by default.

◆ MAXON_ATTRIBUTE() [22/29]

maxon::DESCRIPTION::UI::BASE::MAXON_ATTRIBUTE	(	Bool	,
		UIDEFAULTOPEN	,
		"net.maxon.description.ui.base.uidefaultopen"
	)

True if the ui (e.g. color/colora) should be open by default.

◆ MAXON_ATTRIBUTE() [23/29]

maxon::DESCRIPTION::UI::BASE::MAXON_ATTRIBUTE	(	Bool	,
		GROUPTITLEBAR	,
		"net.maxon.description.ui.base.grouptitlebar"
	)

True if the group should display the title bar.

◆ MAXON_ATTRIBUTE() [24/29]

maxon::DESCRIPTION::UI::BASE::MAXON_ATTRIBUTE	(	Int	,
		GROUPCOLUMNS	,
		"net.maxon.description.ui.base.groupcolumns"
	)

Number of columns the group should support.

◆ MAXON_ATTRIBUTE() [25/29]

maxon::DESCRIPTION::UI::BASE::MAXON_ATTRIBUTE	(	Bool	,
		SCALEV	,
		"net.maxon.description.ui.base.scalev"
	)

Allow scaling up vertically to fill available space.

◆ MAXON_ATTRIBUTE() [26/29]

maxon::DESCRIPTION::UI::BASE::MAXON_ATTRIBUTE	(	Bool	,
		SCALEH	,
		"net.maxon.description.ui.base.scaleh"
	)

Allow scaling up horizontally to fill available space.

◆ MAXON_ATTRIBUTE() [27/29]

maxon::DESCRIPTION::UI::BASE::MAXON_ATTRIBUTE	(	Bool	,
		ANIMATABLE	,
		"net.maxon.description.ui.base.animatable"
	)

New ID for legacy DESC_ANIMATE (and values DESC_ANIMATE_ON, DESC_ANIMATE_OFF)

◆ MAXON_ATTRIBUTE() [28/29]

maxon::DESCRIPTION::UI::BASE::MAXON_ATTRIBUTE	(	Bool	,
		HIDEWHENINLINE	,
		"net.maxon.description.ui.base.hidewheninline"
	)

True if the attribute should be hidden when the object is displayed as inline object.

◆ MAXON_ATTRIBUTE() [29/29]

maxon::DESCRIPTION::UI::BASE::MAXON_ATTRIBUTE	(	Bool	,
		MULTILINETITLE	,
		"net.maxon.description.ui.base.multilinetitle"
	)

True if the string should be a multiline text.

Namespaces

Functions