Go to: Synopsis. Return value. Flags. Python examples.
toolPropertyWindow([field=string], [helpButton=string], [icon=string], [inMainWindow=boolean], [location=string], [noviceMode=boolean], [resetButton=string], [selectCommand=string], [showCommand=string])
Note: Strings representing object names and arguments must be separated by commas. This is not depicted in the synopsis.
toolPropertyWindow is undoable, queryable, and editable.
End users should only call this command as 1. a query (in the
custom tool property sheet code) or 2. with no arguments
to create the default tool property sheet. The more complex
uses of it are internal.
None
In query mode, return type is based on queried flag.
field, helpButton, icon, inMainWindow, location, noviceMode, resetButton, selectCommand, showCommand
Long name (short name) |
Argument types |
Properties |
|
field(fld)
|
string
|
|
|
Sets/returns the name of the text field used to store the
tool name in the property sheet.
|
|
helpButton(hb)
|
string
|
|
|
Sets/returns the name of the button used to show help
on the tool in the property sheet.
|
|
icon(icn)
|
string
|
|
|
Sets/returns the name of the static picture object (used to display the
tool icon in the property sheet).
|
|
inMainWindow(imw)
|
boolean
|
|
|
Specify true if you want the tool settings to appear in the main
window rather than a separate window.
|
|
location(loc)
|
string
|
|
|
Sets/returns the location of the current tool property sheet, or an empty
string if there is none.
|
|
noviceMode(nm)
|
boolean
|
|
|
Sets/returns the 'novice mode' flag.(unused at the moment)
|
|
resetButton(rb)
|
string
|
|
|
Sets/returns the name of the button used to restore the
tool settings in the property sheet.
|
|
selectCommand(sel)
|
string
|
|
|
Sets/returns the property sheet's select command.
|
|
showCommand(shw)
|
string
|
|
|
Sets/returns the property sheet's display command.
|
|
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.
|
import maya.cmds as cmds
cmds.toolPropertyWindow()
pictureObject = cmds.toolPropertyWindow(q=True, icon=True)