Share

Docking Modules

Modules are the windows that appear when you select one of the options, such as Graph (the Scenegraph) or VSets, in the Quick Access Bar. Modules can float outside of the VRED application window (the area that surrounds the Viewport), be docked within the it, or grouped and either floating or docked.

Use the tools found in the upper right corner of modules to do the following:

Module with docking icons

  • chevron to select which module to display
  • arrow to undock a group or module (if no docked group was created)
  • X to close a group or module (if no docked group was created)

Docking

Docking is the act of connecting a module to either the application window or another module, resulting in a tabbed group. This is in contrast to a floating window. See how to dock and undock a module, and prevent a module from docking when you move it, and close one when done with it.

When docking a floating window, icons appear as you near the UI, which are used to indicate where the window will be docked. The window automatically resizes to the length of the docked side. Modules can be docked as a stacked or tabbed group.

Docking

How to Dock to the UI

  1. Do either of the following:

    • Press the MMB and drag a module toward any edge of the UI.
    • Press and hold the Shift key as you LMB-drag a module toward any edge of the UI.

    Blue icons appear, one for each side of the app and another in the middle (Dock Grouped Modules) for grouping modules together.

    Blue icons will appear

  2. Hover over an icon until highlighted, then release your mouse button to dock the module to that side of the UI.

    Highlight for Docking

Docking Modules Together

Modules can be docked together in two ways: stacked or tabbed.

  • To dock modules as a stacked group, press and hold the Shift key, as you LMB-drag the module over the side icon where the other module is docked, then release your mouse.

    To dock modules as a stacked group

  • To dock modules into a tabbed group, press and hold the Shift key, as you LMB-drag the module over Dock Grouped Modules, then release your mouse. A tab is created and added to the end of the group.

    Window with module tabs along the top

    Tip:

    To change the displayed module, either tap another tab or if working with many modules, chevron to find and a specific module.

  • To select which module to display, either click a tab or click chevron and select a module from the list.

  • To remove a module from a group, right-click its title and select Detach.

  • To hide the current module's tab, right-click its title and select Close Tab and to hide all tabs, except the current one, select Close All Tabs. Use these to unclutter your view.

    How to group modules

Undocking Modules

When a module is undocked, it returns to its original size and shape. When VRED is minimized, undocked context menus are also minimized.

Tip:

To return any window to its default size, press the D key.

Here are a few ways to undock a module:

  • To detach a module from a tabbed group, right-click a module's tab and select Detach.

    Detach

  • To detach a tabbed group of modules, Undock arrow icon.

    Before After
    Before group Detached group
  • To detach a module from a stacked group, Undock arrow icon.

    Undocking a module from the group

How to Close a Module

To close a module, at the top right of a module, click Close.

Python For Docking

Use this function, setAllowedAreas, to the QVRDockWidgetWrapper to disable docking globally, if Disable Docking is set in the MainWindow preference.

Was this information helpful?