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

Synopsis

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

hotBox is undoable, queryable, and NOT editable.

This command controls parameters related to the hotBox menubar palette. When the command is invoked with no flags, the hotBox is popped up.

Return value

None

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

Flags

PaneOnlyMenus, PaneToggleMenus, animationOnlyMenus, animationToggleMenus, clothOnlyMenus, clothToggleMenus, commonOnlyMenus, commonToggleMenus, customMenuSetsToggleMenus, displayCenterOnly, displayHotbox, displayStyle, displayZonesOnly, dynamicsOnlyMenus, dynamicsToggleMenus, liveOnlyMenus, liveToggleMenus, modelingOnlyMenus, modelingToggleMenus, noClickCommand, noClickDelay, noClickPosition, noKeyPress, polygonsOnlyMenus, polygonsToggleMenus, position, release, renderingOnlyMenus, renderingToggleMenus, riggingOnlyMenus, riggingToggleMenus, rmbPopups, showAllToggleMenus, surfacesOnlyMenus, surfacesToggleMenus, transparenyLevel, updateMenus
Long name (short name) Argument types Properties
-PaneOnlyMenus(-po) create
Sets a row of menus to be the only visible row.
-PaneToggleMenus(-pt) boolean createquery
Sets the visibilty of a row of menus to on or off.
-animationOnlyMenus(-ao) createquery
-animationToggleMenus(-at) boolean createquery
-clothOnlyMenus(-clo) createquery
-clothToggleMenus(-clt) boolean createquery
-commonOnlyMenus(-co) createquery
-commonToggleMenus(-ct) boolean createquery
-customMenuSetsToggleMenus(-cst) boolean createquery
-displayCenterOnly(-dco) create
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) createquery
-displayStyle(-ds) query
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) createquery
-dynamicsOnlyMenus(-do) createquery
-dynamicsToggleMenus(-dt) boolean createquery
-liveOnlyMenus(-lo) createquery
-liveToggleMenus(-lt) boolean createquery
-modelingOnlyMenus(-mdo) createquery
-modelingToggleMenus(-mdt) boolean createquery
-noClickCommand(-ncc) script create
The command to be executed if the hotBox is engaged and then disengaged within noClickDelay time units.
-noClickDelay(-ncd) float create
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) create
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) createquery
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) createquery
-polygonsToggleMenus(-plt) boolean createquery
-position(-pos) uint uint create
Specify the screen position the hotbox should be centered at next time it is displayed. The default is the cursor position.
-release(-rl) createquery
Action to be called on the release of the key which invoked the hotbox
-renderingOnlyMenus(-ro) createquery
-renderingToggleMenus(-rt) boolean createquery
-riggingOnlyMenus(-rgo) createquery
-riggingToggleMenus(-rgt) boolean createquery
-rmbPopups(-rmb) boolean createquery
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 createquery
Sets the visibility of all menus to on or off. When queried, will only return true if all menu rows are visible.
-surfacesOnlyMenus(-so) createquery
-surfacesToggleMenus(-st) boolean createquery
-transparenyLevel(-tr) int createquery
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) create
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 be used more than once in a command.

MEL examples

// Bind the hotBox to the spacebar.
//
nameCommand -annotation "Pop Hotbox" -command "hotBox" "NameComPop_hotBox";
hotkey -k " " -name "NameComPop_hotBox";

// Give the hotBox a 'noClickCommand' which displays the screen position at
// which the hotBox was requested.
//
global proc showPos(int $x, int $y)
{
    print("hotBox requested at (" + $x + ", " + $y + ")\n");
}

hotBox -noClickCommand "showPos" -noClickPosition;