Interface: menuMan

<boolean>loadMenuFile <string>file

This method allows you to load a menu file from disk and automatically update the UI accordingly. Returns true if the menu file was loaded, otherwise false.

<string>file: The path and filename of the menu file to load.

<boolean>saveMenuFile <string>file

This method allows you to save a menu file to disk. Returns true if the menu file was saved, otherwise false.

<string>file: The path and filename of the menu file to save.

<string>getMenuFile()

This method returns the file name of the currently loaded and active menu file.

<void>updateMenuBar()

This method can be called to update 3ds max' main menu bar after adding sub-menu's or menu items.

<boolean>registerMenuContext <integer>contextId

To add items to 3ds max's main menu, the plug-in should check the return value of RegisterMenuContext(), and if it is true, that means that this is the first time it has been registered, and the plug-in can then create new menus, add items to 3ds max's main menu and Quad menus.

<Interface>findMenu <string>menuName

This method will return a pointer to a menu based on its name. Returns a pointer to the menu or null if the menu wasn't found.

<string>menuName: The name of the menu to return.

<Interface>findQuadMenu <string>menuName

This method will return a pointer to a quad menu based on its name. Returns a pointer to the quad menu or null if the menu wasn't found.

<string>menuName: The name of the menu to return.

<boolean>unRegisterMenu <Interface>menu

This method allows you to remove a menu form the mananger. Returns false if the menu was not registered, true if successfully unregistered.

<Interface>menu: Points to the menu to unregister.

<boolean>unRegisterQuadMenu <Interface>quadMenu

This is like "unregisterMenu" but for quad menus.

<Interface>createMenu <string>name

This creates a new, empty menu with the given name.

<Interface>createQuadMenu <string>name <string>quad1Name <string>quad2Name <string>quad3Name <string>quad4Name

This creates a new, empty quad menu. It contains, 4 empty menus, one for each quad.

<Interface>createSubMenuItem <string>name <Interface>subMenu

This creates a new sub-menu item that can be added to a menu. It uses the given "name" and it displays the given sub-menu.

<Interface>createSeparatorItem()

This creates a new menu separator that can be added to a menu.

<Interface>createActionItem <string>macroScriptName <string>macroScriptCategory

This creates a new menu item that can be added to a menu. The item is an action that executes the macro script with the given name and category. This returns "undefined" if there is no macroScript with the given name and category.

<boolean>setViewportRightClickMenu <enum>which <Interface>menu

which enums: {#nonePressed|#shiftPressed|#altPressed|#controlPressed|#shiftAndAltPressed|#shiftAndControlPressed|#controlAndAltPressed|#shiftAndAltAndControlPressed}

This method allows you to set the viewport right-click menu to the specified quad menu. Returns true if it was set successfully.

<enum>which : See the List of Right-Click Contexts above.

<Interface>menu: A pointer to the quad menu you wish to set.

<Interface>getViewportRightClickMenu <enum>which

which enums: {#nonePressed|#shiftPressed|#altPressed|#controlPressed|#shiftAndAltPressed|#shiftAndControlPressed|#controlAndAltPressed|#shiftAndAltAndControlPressed}

This method returns a pointer to the current viewport right-click quad menu.

<enum>which: See the List of Right-Click Contexts..

<Interface>getMainMenuBar()

This method returns a pointer to the main menu bar.

<boolean>setMainMenuBar <Interface>menu

This method allows you to set the main menu bar. Returns true if it was set successfully.

<Interface>menu: A pointer to the menu you wish to set as the main menu bar.

<bool>getShowAllQuads <Interface>quadMenu

This method checks if the "Show All Quads" flag is set for a specific QuadMenu. This method will return true if the flag is set or false if the flag is not set.

<Interface>quadMenu: A pointer to the QuadMenu you wish to check the flag for.

<void>setShowAllQuads <Interface>quadMenu <bool>value

This method sets the "Show All Quads" flag for a specific QuadMenu.

<Interface>quadMenu : A pointer to the QuadMenu you wish to set the flag for.

<bool>value: True to set the flag to on, false to set the flag off.

<string>getQuadMenuName <Interface>quadMenu

This method returns the name given to a specific QuadMenu as a string.

<Interface>quadMenu: A pointer to the QuadMenu for which you wish to retrieve the name.

<void>setQuadMenuName <Interface>quadMenu <string>name

This method allows you to set the name of a specific QuadMenu.

<Interface>quadMenu : A pointer to the QuadMenu for which you wish to set the name.

<string>name: The string containing the name for the QuadMenu.

<integer>numMenus()

Returns the total number of menus in registered with the menu manager.

<Interface>getMenu <index>index

Retrieves the "index"th menu in the menu manager. This is a 1-based index.

<integer>numQuadMenus()

Returns the total number of quad menus registered with the menu manager.

<Interface>getQuadMenu <index>index

Retrieves the "index"th quad menu in the menu manager. This is a 1-based index.