listerEditor is undoable, queryable, and editable.
This command creates a lister Editor, placeable in
any layout. It's solely a UI command, intended to be used to
create, edit and query listers. All configuration of an
individual lister is done through this command, as well as all actions
(filtering, content, highlighting, expand/compress, un/displaying, etc)
In query mode, return type is based on queried flag.
| Long name (short name) |
Argument types |
Properties |
exists(ex)
|
boolean
|
|
|
Returns true|false depending upon whether the
specified object exists. Other flags are ignored.
|
|
defineTemplate(dt)
|
string
|
|
|
Puts a command in a mode where any other flags and args are
parsed and added to the command template specified in the argument.
They will be used as default arguments in any subsequent
invocations of the command when templateName is set as the
current template.
|
|
useTemplate(ut)
|
string
|
|
|
Force the command to use a command template other than
the current one.
|
|
panel(pnl)
|
string
|
|
|
Specifies the panel that the editor belongs to. By default if
an editor is created in the create callback of a scripted panel it
will belong to that panel. If an editor doesn't belong to a panel
it will be deleted when the window that it is in is deleted.
|
|
parent(p)
|
string
|
|
|
Specifies the parent layout for this editor. This flag will only
have an effect if the editor is currently un-parented.
|
|
unParent(up)
|
boolean
|
|
|
Specifies that the editor should be removed from its layout.
This cannot be used with query.
|
|
control(ctl)
|
boolean
|
|
|
Query only. Returns the top level control for this editor.
Usually used for getting a parent to attach popup menus.
Caution: It is possible, at times, for an editor to exist without a
control. This flag returns "NONE" if no control is present.
|
|
mainListConnection(mlc)
|
string
|
|
|
Specifies the name of a selectionConnection object which the
editor will use as its source of content. The editor will
only display items contained in the selectionConnection object.
|
|
forceMainConnection(fmc)
|
string
|
|
|
Specifies the name of a selectionConnection object which the
editor will use as its source of content. The editor will only
display items contained in the selectionConnection object. This is
a variant of the -mainListConnection flag in that it will force a
change even when the connection is locked. This flag is used to
reduce the overhead when using the -unlockMainConnection
, -mainListConnection, -lockMainConnection flags in immediate
succession.
|
|
selectionConnection(slc)
|
string
|
|
|
Specifies the name of a selectionConnection object which the
editor will synchronize with its own selection list. As the user
selects things in this editor, they will be selected in the
selectionConnection object. If the object undergoes changes, the
editor updates to show the change.
|
|
highlightConnection(hlc)
|
string
|
|
|
Specifies the name of a selectionConnection object which
the editor will synchronize with its highlight list. Not all
editors have a highlight list. For those that do, it is a secondary
selection list.
|
|
filter(f)
|
string
|
|
|
Specifies the name of an itemFilter object to be placed on this editor.
This filters the information coming onto the main list
of the editor.
|
|
lockMainConnection(lck)
|
boolean
|
|
|
Locks the current list of objects within the mainConnection,
so that only those objects are displayed within the editor.
Further changes to the original mainConnection are ignored.
|
|
stateString(sts)
|
boolean
|
|
|
Query only flag. Returns the MEL command that will edit an
editor to match the current editor state. The returned command string
uses the string variable $editorName in place of a specific name.
|
|
unlockMainConnection(ulk)
|
boolean
|
|
|
Unlocks the mainConnection, effectively restoring the original
mainConnection (if it is still available), and dynamic updates.
|
|
updateMainConnection(upd)
|
boolean
|
|
|
Causes a locked mainConnection to be updated from the orginal
mainConnection, but preserves the lock state.
|
|
docTag(dtg)
|
string
|
|
|
Attaches a tag to the Maya editor.
|
|
addObject(a)
|
string
|
|
|
Add the named object to the lister as a root cell
|
|
displayList(dl)
|
boolean
|
|
|
List by name all root cells in the multilister
|
|
primitive(pri)
|
[string, string]
|
|
|
Change the primitive on the specified lister items to
one of the following: 'sphere', 'cone', 'cube', 'cylinder'.
The first argument if the objcet name, the secong one is the new
primitive type.
|
|
findFirst(ff)
|
string
|
|
|
Set the top row of the lister to the first occurrance
of the given object
|
|
findNext(fn)
|
string
|
|
|
Set the top row of the lister to the next occurrance of
the given object - if the object doesn't occur before the
end of the table, start from the top
|
|
copyFrom(cf)
|
string
|
|
|
Copy the state and contents of a named lister into the current object
|
|
column(c)
|
boolean
|
|
|
set the lister to be columnar; cells will be organized
in columns instead of rows.
|
|
filterConstant(fc)
|
boolean
|
|
|
Set whether or not the lister checks every new object
created against the filter.
|
|
reFilter(rf)
|
boolean
|
|
|
if the filter isn't constantly applied, refilter the lister
|
|
newCellPlacement(ncp)
|
string
|
|
|
Dictate where newly displayed cells are found: either the
"head" or "tail" of the list, or automatically sorted
("autosort") or "replace" what is currently shown with
what is given in each new action.
|
|
ascendingSort(ascendingSort)
|
boolean
|
|
|
set the direction of the sort; true is smallest to largest,
false is largest to smallest.
|
|
sortType(st)
|
string
|
|
|
input the type of sort: "alphabetical", "nodeType" or any
custom sorting MEL function. The format for the MEL function:
proc int funcName ($objName1 $objName2)
where $objName is
any Maya object. The func must returns true if $obj1 goes before
the second or false if the second is equal to or comes before the first.
|
|
recallCompressed(rc)
|
boolean
|
|
|
compressed cells remember which of their descendants are expanded
|
|
recallHidden(rh)
|
boolean
|
|
|
hidden cells remember which of their descendants are expanded
|
|
remove(rm)
|
string
|
|
|
Remove the named object from the lister if it is present as a root cell
(flag can be used multiple times with the same command)
|
|
reload(rl)
|
boolean
|
|
|
Flush the currently held contents of the lister and reload from the
model using the current configuration (filter, sorting, etc.)
|
|
reSort(rs)
|
boolean
|
|
|
if the lister is not auto sorting, reorder the root cells.
|
|
placeText(pt)
|
string
|
|
|
determines placement of text in all cells.
Choices: "below", "right", and "none"
|
|
thumbnailSize(ts)
|
string
|
|
|
specify the size of the thumbnail. Valid values are "small" "medium"
and "large".
|
|
thumbnailType(tt)
|
[string, string]
|
|
|
specify the object name first, and then the thumbnail rendering type.
Valid rendering type are "surface", "displacement", "image", "volume", "light"
|
|
inSelectMode(ism)
|
boolean
|
|
|
set the lister to select (true) or highlight (false)
|
|
clearHighlight(chl)
|
boolean
|
|
|
Unhighlight everything; empty the highlight list.
|
|
highlight(hl)
|
string
|
|
|
Highlight all occurrances of the given cell. The instance that is the
root of a network showing in the lister will highlight differently than
instances which are part of a network.
|
|
unHighlight(uhl)
|
string
|
|
|
Unhighlight all occurrances of the given cell
|
|
replaceHighlight(rhl)
|
string
|
|
|
Replace the multiLister highlight list with the given items
|
|
toggleHighlight(thl)
|
string
|
|
|
Toggle the multilister highlight with the given items
|
|
expand(exp)
|
string
|
|
|
expand the given node name
|
|
expandAll(ea)
|
boolean
|
|
|
expand all showing nodes (if possible)
|
|
compress(cm)
|
string
|
|
|
Compress the given node name
|
|
compressAll(ca)
|
boolean
|
|
|
Compress all visiblie nodes (if possible)
|
|
releaseCommand(rcd)
|
string
|
|
|
Attach a command to happen after each mouse release in a lister
|
|
showShaderChildren(ssc)
|
boolean
|
|
|
Configure the lister to either show (1) or hide (0) shader
shader children of shader groups. This will only have an effect
if the shaders group has exactly one shader connected to one of its
shading ports : surface, volume, image, displacement. If there
are multiple shaders, they will all be shown regardless of this flag.
|
|
showSetMembers(ssm)
|
boolean
|
|
|
Configure the lister to either show (1) or hide (0) shader
group's geometry when expanded.
|
|