Using marking menus

Marking menus are tool sets that pop up as you work. They provide easy access to Shogun Post commands or scripts, regardless of where your mouse is pointing or what you are doing. Custom marking menus are a great way to create groups of commands for common tasks.

The scripts used in marking menus must exist within the directories specified in the Preferences dialog box (General > Preferences), on the Scripts tab within the Directories tab (explained in Set script folder locations).

Shogun Post has three default marking menus: each contains five zones. Each zone has three mouse buttons. Each zone/mouse button combination has positions for eight menu items containing scripts or commands.

You can customize the marking menus by assigning scripts and commands to suit your preferences. You can save marking menu settings to the Shogun Post marking menu file (MarkingMenus.hsl) or create marking menu files of your own. You can use marking menus whenever you want to quickly access assigned scripts or commands.

You may also find it useful to create your own folder for storing any marking menus you create or customize.

To specify the location of the Marking Menu folder:

1. Open thethe Preferences dialog box (see above).
2. On the Directories tab, click the Scripts tab and enter or browse to the location in the Marking Menu File field.

Default marking menus

The following tables describe the high-level contents of the default marking menus supplied with Shogun Post. For details of the individual commands in each of these zones, see the Marking Menus tab in the Preferences dialog box as described in Customize marking menus.

Default (Space) marking menu contents

Ctrl (Ctrl+Space) marking menu contents

Shift (Shift+Space) marking menu contents

Customize marking menus

You can customize marking menus by assigning new commands to zones and mouse buttons.

To customize marking menus:

1. Open the Preferences dialog box (General > Preferences).
2. Click the Marking Menus tab, which contains drop-down lists and location controls.
3. From the Select a Marking Menu to edit drop-down list, click one of the default marking menus:
   
   • Default Menu (Space)
   • Ctrl Menu (Ctrl-Space)
   • Shift Menu (Shift-Space)
4. From the Select a zone to edit list, click one of the available zones:
   
   • Center
   • Top
   • Left
   • Bottom
   • Right
5. From the Select a mouse button list, click the desired button:
   
   • Left Button
   • Middle Button
   • Right Button
6. In Entry label, type the name you want to use for this marking menu.
7. Click the Commands button to display the Script Viewer.
8. Click the Style list and select an option for the way you want to view the available menu commands and scripts that can be assigned to marking menus (those that can execute without arguments):
   
   • List: All items listed in alphabetical order.
   • Hierarchy: Items grouped into categories of commands: Native Commands, Menu Commands, Plugin Commands, C:/Users/Public/Documents/Vicon/Shogun Post#.#/Scripts, C:/Users/Public/Documents/Vicon/Shogun Post#.#/Layouts, C:/Program Files/Vicon/Shogun Post#.#/Scripts, C:/Program Files/Vicon/Shogun Post#.#/Layouts.
   • Category: Items grouped into script categories.
9. From the list, click the command or script you want to assign to a marking menu and click OK to close the Script Viewer.
   The selected command or script is displayed in the Command string and Entry label fields in the Marking Menu Preferences dialog box.
10. Click the button that represents the mouse direction to which you want to assign the command:
    
    • North
    • Northeast
    • East
    • Southeast
    • South
    • Southwest
    • West
    • Northwest
    The button is highlighted, and the name of the selected command is displayed in it.

    Tip: You can replace the default command name displayed in the selected mouse direction field with a custom name by entering a new value in the Entry label field. You can add additional scripts to a single mouse direction by entering a semicolon and a space, and then manually typing in the name of an additional command. Separate each additional script with a semicolon and a space, for example: rewind; play;

    To assign commands to any of the other mouse directions for the currently selected zone and mouse button, repeat steps 6–10 .
    To assign commands to a different mouse button in the currently selected zone, Repeat the procedure from step 5.
    To assign commands to a different zone and mouse buttons, repeat the procedure from step 4.
11. When you are finished customizing marking menus, click Close to save the changes and close the Preferences dialog box.

Use marking menus

You can access marking menus from anywhere and at any time while you are working with data in Shogun Post. The menu that pops up depends on your current zone and the mouse button that you are using.

To use a marking menu:

Note that the following instructions assume that default menu has been assigned the Space hotkey, the Ctrl menu has been assigned the Ctrl+Space hotkeys and the Shift menu has been assigned the Shift+Space hotkey. You can find information on how to do this in Set hot keys.

1. In a view pane, display the desired marking menu as shown in the following table. See Marking menu table.
2. Hover the mouse over the right, left, top, bottom, or center zone and then left-click, middle-click, or right-click to view the sets of commands defined for that zone/mouse button.
3. Left-, middle-, or right-click the desired mouse direction to run the associated script or command.

Set hot keys

If you want to change what happens when you press a particular key or combination of keys, you can assign or un-assign commands to hot keys. The following instructions describe how to set or clear hot key for displaying the marking menu, but can be applied to any other command for which you want to set a hot key.

To assign or clear hot keys:

1. Open the Preferences dialog box (General > Preferences).
2. Click the Hot Keys tab.

   Tip: If you are clearing a hot key, you can save time by showing only the commands or scripts that have hot keys assigned to them. To do this, at the top, select Show hot keyed only.

3. Click the required command, for example showMarkingMenu to select it and then double-click to display the Set hot key dialog box, where you can set or clear the hot key for it.
4. Close the Preferences dialog box.

Marking menu table