editorTemplate

Go to: Synopsis. Return value. Flags. Python examples.

Synopsis

editorTemplate([addComponents=boolean], [addControl=boolean], [addDynamicControl=boolean], [addExtraControls=boolean], [addSeparator=boolean], [annotation=string], [beginLayout=string], [beginNoOptimize=boolean], [beginScrollLayout=boolean], [callCustom=boolean], [collapse=boolean], [dimControl=[string, string, boolean]], [endLayout=boolean], [endNoOptimize=boolean], [endScrollLayout=boolean], [extraControlsLabel=string], [interruptOptimize=boolean], [label=string], [listExtraAttributes=string], [preventOverride=boolean], [queryControl=[string, string]], [queryLabel=[string, string]], [suppress=string])

Note: Strings representing object names and arguments must be separated by commas. This is not depicted in the synopsis.

editorTemplate is undoable, NOT queryable, and NOT editable.

Return value

Flags

Long name (short name)	Argument types	Properties
addControl(ac)	boolean
The first argument is the name of the attribute for which you wish to add a control. You can assume that when the editor is created from the template, an appropriate type of control will be used. The second string argument is optional, and can be used to specify a command (or script) to be executed when the attribute is changed.
addDynamicControl(adc)	boolean
As -addControl with the exception that the attribute for which the control is to be created/attached is dynamic. [Note: -addControl will also work for dynamic attributes, but will not preserve their order in the attribute editor].
label(l)	string
This flag can only be used with the -addControl or the -addDynamicControl flags. And it must be specified FIRST. The string will override the name of the attribute that will be displayed in the attribute editor.
annotation(ann)	string
This flag can only be used with the -addControl or the -addDynamicControl flags. The string will be used as an annotation on the controls created in the attribute editor.
addComponents(acp)	boolean
This flag will add a frameLayout with a channel box which will display any selected components for the object.
suppress(s)	string
Prevent a control for the attribute specified by the string argument from appearing in the editor created from the template.
dimControl(dc)	[string, string, boolean]
This flag is only useful AFTER a control has already been created (using the -addControl flag). The first argument is the node name and the second is the attribute whose control you wish to affect. The third argument is a boolean which specifies whether to dim (true) or undim (false) the associated control.
queryControl(qc)	[string, string]
This flag is only useful AFTER a control has already been created (using the -addControl flag). The first argument is the node name and the second is the attribute whose control you wish to query. Note that in most cases, using this flag is identical to issuing a getAttr command, however, in the case of textFields (e.g. for message attributes), the text value currently being displayed will be returned, NOT the actual attribute value.
listExtraAttributes(lea)	string
List extra attributes.This flag is only useful AFTER a control has already been created (using the -addControl flag). The first argument is the node name.
queryLabel(ql)	[string, string]
This flag is only useful AFTER a control has already been created (using the -addControl flag). The first argument is the node name and the second is the attribute whose control label you wish to query. In most cases this flag returns the same value as the attribute's nice name, but when a -label flag was present on the -addControl command that created the control, -queryLabel will return that value instead
addExtraControls(aec)	boolean
By default, if there are attributes of a node which you do not -addControl or -suppress, then controls will be created automatically and appended to the end of editor created from the template. This flag allows you to specify a particular place in the template for such controls to be automatically inserted. If dynamic attributes have not already been addressed with -addControl, they will also be placed here. A frameLayout will automatically be generated for you when you use this flag.
extraControlsLabel(ecl)	string
By default the label is "Extra Attributes". Specify an alternate label or an empty string to hide the label. This flag must be used in conjuction with the -aec/addExtraControls flag.
addSeparator(addSeparator)	boolean
Adds a separator to the template.
beginLayout(bl)	string
Begins a layout in the template with the title specified by the string argument. Items between this flag and its corresponding -endLayout flag will be contained within the layout. You can assume that when the editor is created from the template, an appropriate type of layout will be used. (frameLayout).
collapse(cl)	boolean
This flag is only valid when used in conjunction with a -bl/beginLayout flag. It is used to specify the initial expand/collapse state of the layout. A true value will cause the layout to be collapsed upon creation, while a false value will expand the layout. The default is true (ie. collapsed).
endLayout(el)	boolean
Ends a layout in the template started by -beginLayout.
beginScrollLayout(bsl)	boolean
Begins a scrollLayout. Items between this flag and its corresponding -endScrollLayout flag will be contained within the layout.
endScrollLayout(esl)	boolean
Ends a scrollLayout.
callCustom(ccu)	boolean
Specifies that at this point in the template when building the dialog, the procedure specified by the first argument is to be called to create some UI objects when a new node type is edited. The procedure specified by the second argument is to be called if an attribute editor already exists and another node of the same type is now to be edited. The replacing procedure should connect any controls created by the creating procedure to the equivalent attributes in the new node. A list of zero or more attributes specifies the attributes which the two procedures will involve. The procedures should have the signature: proc AEcustomNew(string attributeName1, string attributeName2) The number of attributes specified in the call should correspond to the number of attributes in the procedure signature.
beginNoOptimize(bn)	boolean
Specifies that the layout of items between this flag and its corresponding -endNoOptimize flag is not to be optimized to minimize space.
endNoOptimize(en)	boolean
Ends a set of non-optimized items.
interruptOptimize(io)	boolean
Enforces a division between two sets of items whose layouts may be optimized.
preventOverride(po)	boolean
If true, this flag disallows overriding the control's attribute via the control's right mouse button menu.

Flag can appear in Create mode of command	Flag can appear in Edit mode of command
Flag can appear in Query mode of command	Flag can have multiple arguments, passed either as a tuple or a list.

Python examples

import maya.cmds as cmds

# You will most likely want to use this command when defining the controls
# that appear in the Attribute Editor for a custom node created in a plugin.

# To see how this is done compile and load the transCircleNode plugin. Then
# create a node of type "transCircle" and show the Attribute Editor.

# Now look at the AEtransCircleTemplate.mel script to see how the
# editorTemplate command is used to define the controls that appear in
# the Attribute Editor.

# As you may have noticed the name of the template script must match the
# node type you create, ie. AEnodeTypeTemplate.mel.