hotBox

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

Synopsis

hotBox([PaneOnlyMenus=boolean], [PaneToggleMenus=boolean], [animationOnlyMenus=boolean], [animationToggleMenus=boolean], [clothOnlyMenus=boolean], [clothToggleMenus=boolean], [commonOnlyMenus=boolean], [commonToggleMenus=boolean], [customMenuSetsToggleMenus=boolean], [displayCenterOnly=boolean], [displayHotbox=boolean], [displayStyle=boolean], [displayZonesOnly=boolean], [dynamicsOnlyMenus=boolean], [dynamicsToggleMenus=boolean], [liveOnlyMenus=boolean], [liveToggleMenus=boolean], [menuSetOnly=string], [menuSetToggle=[string, boolean]], [modelingOnlyMenus=boolean], [modelingToggleMenus=boolean], [noClickCommand=script], [noClickDelay=float], [noClickPosition=boolean], [noKeyPress=boolean], [polygonsOnlyMenus=boolean], [polygonsToggleMenus=boolean], [position=[uint, uint]], [release=boolean], [renderingOnlyMenus=boolean], [renderingToggleMenus=boolean], [riggingOnlyMenus=boolean], [riggingToggleMenus=boolean], [rmbPopups=boolean], [showAllToggleMenus=boolean], [surfacesOnlyMenus=boolean], [surfacesToggleMenus=boolean], [transparenyLevel=int], [updateMenus=boolean])

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

hotBox is undoable, queryable, and NOT editable.

Return value

None

In query mode, return type is based on queried flag.

Flags

Long name (short name)	Argument types	Properties
PaneOnlyMenus(po)	boolean
Sets a row of menus to be the only visible row.
PaneToggleMenus(pt)	boolean
Sets the visibilty of a row of menus to on or off.
animationOnlyMenus(ao)	boolean
animationToggleMenus(at)	boolean
clothOnlyMenus(clo)	boolean
clothToggleMenus(clt)	boolean
commonOnlyMenus(co)	boolean
commonToggleMenus(ct)	boolean
customMenuSetsToggleMenus(cst)	boolean
displayCenterOnly(dco)	boolean
Three different display styles are defined for the hotBox. It can be fully displayed (dh), display only the marking menu zones (dzo) or no display (dco) which means that the entire screen can be used to access the marking menus defined in the center zone.
displayHotbox(dh)	boolean
displayStyle(ds)	boolean
Returns a string that identifies the flag used to set the current display style. The results can be dh, dzo, or dco, depending on which style the hotBox is using at the moment.
displayZonesOnly(dzo)	boolean
dynamicsOnlyMenus(do)	boolean
dynamicsToggleMenus(dt)	boolean
liveOnlyMenus(lo)	boolean
liveToggleMenus(lt)	boolean
menuSetOnly(mso)	string
Show only the named menu set
menuSetToggle(mst)	[string, boolean]
Update the given menu sets with the paired toggle value
modelingOnlyMenus(mdo)	boolean
modelingToggleMenus(mdt)	boolean
noClickCommand(ncc)	script
The command to be executed if the hotBox is engaged and then disengaged within noClickDelay time units.
noClickDelay(ncd)	float
If the hotBox is engaged and then disengaged within this time interval, then the noClickCommand is executed. The time interval is in seconds. The default value is 0.1.
noClickPosition(ncp)	boolean
If a -noClickCommand has been specified then this flag will cause the X and Y screen coordinates of the mouse pointer to be appended as arguments to that command. The coordinates used are those of the pointer at the time when the hotbox command was initiated.
noKeyPress(nkp)	boolean
Normally the hotbox is popped by a pressing a keyboard key. Use the nkp flag to pop the hotbox from a device other than the keyboard (still use the rl flag to unpop the hotbox).
polygonsOnlyMenus(plo)	boolean
polygonsToggleMenus(plt)	boolean
position(pos)	[uint, uint]
Specify the screen position the hotbox should be centered at next time it is displayed. The default is the cursor position.
release(rl)	boolean
Action to be called on the release of the key which invoked the hotbox
renderingOnlyMenus(ro)	boolean
renderingToggleMenus(rt)	boolean
riggingOnlyMenus(rgo)	boolean
riggingToggleMenus(rgt)	boolean
rmbPopups(rmb)	boolean
Enables/Disables a popup menu of the current function set. This popup menu appear when the right mouse button is pressed in the center zone of the hotbox.
showAllToggleMenus(a)	boolean
Sets the visibility of all menus to on or off. When queried, will only return true if all menu rows are visible.
surfacesOnlyMenus(so)	boolean
surfacesToggleMenus(st)	boolean
transparenyLevel(tr)	int
The percentage of transparency, from 0 to 100. Currently, only the values 0, 25, 50, 75 and 100 are supported. Any other values will be rounded off to the nearest supported value.
updateMenus(um)	boolean
Reloads the hotBox menus from the main menubar. This flag is used when the menus in the main menubar are modified, and the hotBox menus need to be refreshed.

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

# Bind the hotBox to the spacebar.
#
cmds.nameCommand( 'NameComPop_hotBox', annotation='Pop Hotbox', command='hotBox' )
cmds.hotkey( k=' ', name='NameComPop_hotBox' )

# Give the hotBox a 'noClickCommand' which displays the screen position at
# which the hotBox was requested. Note that 'showPos' function is passed
# to the 'noClickCommand' flag as a function, not as a string. This is necessary
# to allow Maya to pass the coordinates to it properly.
#
def showPos(x, y):
    print("hotBox requested at (%d, %d)" % (x, y))

cmds.hotBox(noClickCommand=showPos, noClickPosition=True)