MaxSDK::CUI Namespace Reference

Classes
class	IMouseConfigManager
	A core interface for accessing properties of the customized mode introduced in 3ds Max 2013. More...

Enumerations
enum	OperationMode {   EOperationMode_None = 0 , EOperationMode_Pan , EOperationMode_Zoom , EOperationMode_Rotate ,   EOperationMode_Count }
enum	KeyOption {   EKey_Null = 0 , EKey_Shift = (1<<0) , EKey_Ctrl = (1<<1) , EKey_Alt = (1<<2) ,   EKey_ShiftCtrl = EKey_Shift|EKey_Ctrl , EKey_CtrlAlt = EKey_Ctrl|EKey_Alt , EKey_AltShift = EKey_Alt|EKey_Shift , EKey_ShiftCtrlAlt = EKey_Shift|EKey_Ctrl|EKey_Alt }
enum	MouseButtonOption { EMouseButton_Null = 0 , EMouseButton_Left = (1<<3) , EMouseButton_Middle = (1<<4) , EMouseButton_Right = (1<<5) }
enum	OperationParameter { EOperationParameter_Null = 0 , EOperationParameter_ZoomInDirection , EOperationParameter_Count }
enum	ZoomInDirectionOption {   EZoomInDirection_North = 1 , EZoomInDirection_East = 2 , EZoomInDirection_South = 4 , EZoomInDirection_West = 8 ,   EZoomInDirection_NorthEast = EZoomInDirection_North|EZoomInDirection_East , EZoomInDirection_SouthEast = EZoomInDirection_South|EZoomInDirection_East , EZoomInDirection_SouthWest = EZoomInDirection_South|EZoomInDirection_West , EZoomInDirection_NorthWest = EZoomInDirection_North|EZoomInDirection_West }

Functions
IMouseConfigManager *	GetIMouseConfigManager ()
	Helper function to access the IMouseConfigManager core interface. More...
bool	GetOperationShortcut (OperationMode eOperation, KeyOption &eKey, MouseButtonOption &eButton)
	Helper function to get shortcuts of customized mode. More...
bool	GetValueOfOperationParameter (OperationParameter eParmeter, int &iValue)
	Helper function to get the value of an operation parameter such as zoom in direction of customized zoom mode. More...

Function Documentation

GetIMouseConfigManager()

IMouseConfigManager* MaxSDK::CUI::GetIMouseConfigManager ( )

inline

Helper function to access the IMouseConfigManager core interface.

Returns

A pointer to IMouseConfigManager

{
    return dynamic_cast<IMouseConfigManager*>(GetCOREInterface(IID_CUI_MOUSE_CONFIGURE_MANAGER));
};

GetOperationShortcut()

bool MaxSDK::CUI::GetOperationShortcut ( OperationMode  eOperation, KeyOption &  eKey, MouseButtonOption &  eButton  )

inline

Helper function to get shortcuts of customized mode.

The output parameters are the shortcuts. Returns true if the shortcuts can be obtained, otherwise false.

{
    IMouseConfigManager* pMouseConfigManager = GetIMouseConfigManager();
    if(pMouseConfigManager != NULL)
    {
        return pMouseConfigManager->GetOperationShortcut(eOperation,eKey,eButton);
    }
    return false;
};

GetValueOfOperationParameter()

bool MaxSDK::CUI::GetValueOfOperationParameter ( OperationParameter  eParmeter, int &  iValue  )

inline

Helper function to get the value of an operation parameter such as zoom in direction of customized zoom mode.

Returns

true if value can be obtained, otherwise false.

{
    IMouseConfigManager* pMouseConfigManager = GetIMouseConfigManager();
    if(pMouseConfigManager != NULL)
    {
        return pMouseConfigManager->GetValueOfOperationParameter(eParmeter, iValue);
    }
 
    return false;
};