Interface: MouseConfigManager

Interfaces > Core Interfaces > MouseConfigManager

This Core Interface exposes the Mouse Configuration Manager to MAXScript.

It allows the behavior of the mouse within the viewports to be customized and adapted to various user workflows, including the emulation of Autodesk Maya mouse controls.

Available in 3ds Max 2013 and higher.

See also the related Interface IInteractionMode which exposes the Interaction Mode tab of the Preference Settings dialog.

Properties:

MouseConfigManager.AutoFocusViewportOnKeyPress : bool : Read|Write

Get/set the auto-focus viewport on key press behavior.

When set to false (3ds Max default), pressing a key while the mouse is over a non-active viewport will not change focus to that viewport.

When set to true (Maya default), pressing a keyboard shortcut will automatically switch focus to the viewport the mouse is over.

MouseConfigManager.MayaSelectionMode : bool : Read|Write

Get/set the state of the Maya Selection Mode option.

When set to False (default), selection will be performed using the 3ds Max default behavior.

When set to True, the Maya selection behavior will be used.

MouseConfigManager.ArcRotateLocked : bool : Read|Write

Get/set the locking of the Orbit (formerly known as Arc Rotate) feature in Orthographic viewports (e.g. Top, Bottom, Front, Back, Left, Right).

When set to False (3ds Max default), performing Orbit in an Orthographic viewport will turn it into an Orthographic (a.k.a. User) view.

When set to True (Maya default), Orbit cannot be performed in Orthographic viewports, only in viewport already set to Perspective or Orthographic.

MouseConfigManager.ZoomAboutMousePointOrthographic : bool : Read|Write

Get/set whether to zoom about the mouse point in Orthographic viewports.

MouseConfigManager.ZoomAboutMousePointPerspective : bool : Read|Write

Get/set whether to zoom about the mouse point in Perspective viewports.

MouseConfigManager.RightClickMenuOverSelectedOnly : bool : Read|Write

Get/set whether to allow the opening of QuadMenus when right-clicking anywhere in the viewport (false, default 3ds Max behavior),

or only over selected objects (true, default Maya behavior)

MouseConfigManager.MiddleMouseStrokeMode : bool : Read|Write

Get/set whether to use the mouse wheel for Strokes or Viewport Pan.

MouseConfigManager.ZoomWheelIncrement : float : Read|Write

Get/set the zoom increment when using the mouse wheel.

MouseConfigManager.ZoomInDirection : enum : Read|Write

ZoomInDirection enums: {#North|#NorthEast|#East|#SouthEast|#South|#SouthWest|#West|#NorthWest

Get/set the Zoom In mouse direction.

The 3ds Max default is #North .

The Maya default is #SouthEast

MouseConfigManager.UserMode : enum : Read|Write 

UserMode enums: {#Max|#Maya|#Customized}

Get/set the current Use Mode.

Possible mode values are:

#Max - all mouse settings match the standard 3ds Max behavior

#Maya - all mouse settings match the standard Maya behavior

#Customized - the mouse settings have been customized and are a mixture of 3ds Max and Maya behaviors

Methods:

<void>MouseConfigManager.GetZoomShortcut <&enum>key <&enum>button

key enums: {#Null|#Shift|#Ctrl|#Alt|#ShiftCtrl|#CtrlAlt|#AltShift|#ShiftCtrlAlt}
key is Out parameter
button enums: {#NullButton|#LeftButton|#MiddleButton|#RightButton}
button is Out parameter

Returns the current Viewport Zoom shortcut into the two by-reference arguments.

The first argument provides the keyboard key, the second provides the mouse button.

3ds Max defaults are #CtrlAlt and #MiddleButton .

Maya defaults are #Alt and #RightButton .

EXAMPLE

MouseConfigManager.GetZoomShortcut &theKey &theButton
--> OK
theKey
--> #CtrlAlt
theButton
--> #MiddleButton

<void>MouseConfigManager.SetZoomShortcut <enum>key <enum>button

key enums: {#Null|#Shift|#Ctrl|#Alt|#ShiftCtrl|#CtrlAlt|#AltShift|#ShiftCtrlAlt}
button enums: {#NullButton|#LeftButton|#MiddleButton|#RightButton}

Sets the current Viewport Zoom Shortcut to the keyboard key and mouse button specified by the two arguments.

<void>MouseConfigManager.GetPanShortcut <&enum>key <&enum>button

key enums: {#Null|#Shift|#Ctrl|#Alt|#ShiftCtrl|#CtrlAlt|#AltShift|#ShiftCtrlAlt}
key is Out parameter
button enums: {#NullButton|#LeftButton|#MiddleButton|#RightButton}
button is Out parameter

Returns the Viewport Pan shortcut into the two by-reference arguments.

The first argument provides the keyboard key, the second provides the mouse button.

3ds Max defaults are #Null and #MiddleButton .

Maya defaults are #Alt and #MiddleButton .

<void>MouseConfigManager.SetPanShortcut <enum>key <enum>button

key enums: {#Null|#Shift|#Ctrl|#Alt|#ShiftCtrl|#CtrlAlt|#AltShift|#ShiftCtrlAlt}
button enums: {#NullButton|#LeftButton|#MiddleButton|#RightButton}

Sets the current Viewport Pan shortcut to the keyboard key and mouse button specified by the two arguments.

<void>MouseConfigManager.GetRotateShortcut <&enum>key <&enum>button

key enums: {#Null|#Shift|#Ctrl|#Alt|#ShiftCtrl|#CtrlAlt|#AltShift|#ShiftCtrlAlt}
key is Out parameter
button enums: {#NullButton|#LeftButton|#MiddleButton|#RightButton}
button is Out parameter

Returns the Viewport Rotate shortcut into the two by-reference arguments.

The first argument provides the keyboard key, the second provides the mouse button.

3ds Max defaults are #Alt and #MiddleButton .

Maya defaults are #Alt and #LeftButton .

<void>MouseConfigManager.SetRotateShortcut <enum>key <enum>button

key enums: {#Null|#Shift|#Ctrl|#Alt|#ShiftCtrl|#CtrlAlt|#AltShift|#ShiftCtrlAlt}
button enums: {#NullButton|#LeftButton|#MiddleButton|#RightButton}

Sets the current Viewport Rotate shortcut to the keyboard key and mouse button specified by the two arguments.

Interface: MouseConfigManager

See Also