Your Ad Here

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

Synopsis

toolPropertyWindow([edit=boolean], [field=string], [helpButton=string], [icon=string], [inMainWindow=boolean], [location=string], [noviceMode=boolean], [query=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.

Flags

edit, field, helpButton, icon, inMainWindow, location, noviceMode, query, resetButton, selectCommand, showCommand
Long name (short name) [argument types] Properties
edit(e) boolean
allows you to change the value of a flag.
query(q) boolean
allows you to query the value of a flag.
location(loc) string queryedit
Sets/returns the location of the current tool property sheet, or an empty string if there is none.

In query mode, this flag needs a value.
icon(icn) string queryedit
Sets/returns the name of the static picture object (used to display the tool icon in the property sheet).

In query mode, this flag needs a value.
field(fld) string queryedit
Sets/returns the name of the text field used to store the tool name in the property sheet.

In query mode, this flag needs a value.
resetButton(rb) string queryedit
Sets/returns the name of the button used to restore the tool settings in the property sheet.

In query mode, this flag needs a value.
helpButton(hb) string queryedit
Sets/returns the name of the button used to show help on the tool in the property sheet.

In query mode, this flag needs a value.
showCommand(shw) string queryedit
Sets/returns the property sheet's display command.

In query mode, this flag needs a value.
selectCommand(sel) string queryedit
Sets/returns the property sheet's select command.

In query mode, this flag needs a value.
noviceMode(nm) boolean queryedit
Sets/returns the 'novice mode' flag.(unused at the moment)

In query mode, this flag needs a value.
inMainWindow(imw) boolean create
Specify true if you want the tool settings to appear in the main window rather than a separate window.
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.

Return value


depends on query.

Python examples

import maya.cmds as cmds

cmds.toolPropertyWindow()
pictureObject = cmds.toolPropertyWindow(q=True, icon=True)

Return to Autodesk Index


Your Ad Here