Hotkeys#

Overview#

Work faster and more effectively by using hotkeys in Omniverse USD Composer. The Hotkey tool allows for customization of key bindings throughout Composer. This gives the ability to work faster and more effectively by giving the ability to assign actions to key or a combination of keys.

Interface#

The Hotkey interface can be broken into a few sections.

../_images/ext_hotkey-editor_ui_overview.png
  1. Search

  2. Menu

  3. Table

Hamburger Menu#

../_images/ext_hotkey-editor_menu.png

The hamburger menu in the top right corner of the dialogue gives the ability to Import/Export Presets Presets are stored in a .json file format for easy editing and sharing. Restore Defaults will remove all of the modifications that have been made and restore all hotkeys back to the application defaults.

Hotkey Table#

../_images/ext_hotkey-editor_hotkey-table.png

Most of the editing work happens here in the table. It contains three columns.

Window#

This column shows all of the windows that currently have actions assigned to them. Expanding a window will display a list all of the actions the window holds.

Note

Global hotkeys will operate anywhere in the application unless overridden by a hotkey in a window.

Action#

The action column displays a list of all actions that can be assigned to a hotkey,

Hotkey#

This column displays all of the hotkeys that are currently being used.

Basic Operation#

Using and setting hotkeys have been made as easy and intuitive as possible. Please review below for step by step instructions on the basic procedures for setting, editing, and managing hotkeys.

Adding A New Hotkey#

../_images/ext_hotkey-editor_adding_new_hotkey.gif

Here are the steps for adding a new action and binding a hotkey to it.

../_images/ext_hotkey-editor_add-hotkey_1.png
  1. First expand the window where the new hotkey will be added.

  2. Click on the “Add New Window Hotkey” button to display a list of actions to choose from.

  3. Select the desired action from the list.

../_images/ext_hotkey-editor_add-hotkey_4.png
  1. After the selection has been made begin typing a key or combination of keys.

../_images/ext_hotkey-editor_add-hotkey_2.png
  1. “On Press” is the default but can be changed to “On Release” with the drop-down menu.

../_images/ext_hotkey-editor_add-hotkey_3.png
  1. Once the key has been set click the “save” icon to complete the process.

  2. Your new hotkey has been added to the window.

Note

The entire operation of Adding/Editing/Modifying a hotkey can be stopped by clicking on the “X” cancel button.

Modifying A Hotkey#

../_images/ext_hotkey-editor_modifying_and_restoring.gif

Sometimes a hotkey might need to be modified. Here are the steps to accomplish this.

  1. Start by finding the hotkey that needs modification.

  2. Click the “Edit” pencil icon to the right of the interface in the hotkey column.

  3. Begin typing a key or combination of keys.

  4. “On Press” is the default but can be changed to “On Release” with the drop-down menu.

  5. Once the key has been set click the “save” icon to complete the process.

  6. Your new hotkey has been added to the window.

Note

Restoring an individually modified hotkey can be done by clicking on the “blue” box

../_images/ext_hotkey-editor_modify-key.png

Unbinding A Hotkey#

../_images/ext_hotkey-editor_unbind_hotkey.gif

Default hotkeys can be unbound from the actions that they are assigned to. Because some actions are default to a particular window they will remain after the binding has been broken. Newly added actions can be completely removed from the list. Here is how to Unbind a hotkey:

  1. Start by finding the hotkey that needs to be unbound.

  2. Click the “Edit” pencil icon to the right of the interface in the hotkey column.

  3. Then click the “x” that appears in the hotkey entry field.

  4. Once the key has been unbound click the “save” icon to complete the process.

Conflicting Hotkeys#

../_images/ext_hotkey-editor_conflict.png

Hotkeys within a give window context must be used only once, if a key is used twice in a specific window context, a warning will appear allowing another selection for hotkey to be made.

Adding a New Window#

../_images/ext_hotkey-editor_adding_new_window.gif
  1. Click the “Add Window” button, this will produce a list of window contexts available in your app.

  2. Once a window is selected from the list, hotkeys can be added by the method mentioned above.

Note

Clicking on a window in the list that already exist will simply start the process of adding a new hotkey to the existing window.