Documentation Wiki rss-feed

Workbench tools

Pointer

image:toolbar_pointer.jpg

Selects individual agents. Highlights wires. Scrolls the canvas. Clicking on the canvas deselects any selected items.

Move

image:toolbar_move.jpg

Used to move agents, trunks and hooks and groups of these items as created with the select tool. The move tool is also used to move the end points of unconnected wires. If these are dropped on an agent they will be reconnected. The move tool can also be used to scroll the canvas of the diagram.

Select

image:toolbar_select.jpg

The select tool allows you to select a group of agents, trunks and hooks by defining a rectangular area by dragging the mouse. The selected items can then be moved together by using the move tool. Selected items are highlighted in blue. The rest of the diagram, except for agents directly connected to selected agents are greyed out.

Zoom

image:toolbar_zoom.jpg

Zooms the workbench diagram. You can click the mouse to zoom in and shift-click to zoom out. You can also zoom by dragging the mouse. Left to right to zoom in, right to left to zoom out.

Pressing and holding down the space bar whilst the zoom tool is selected temporarily switches the tool to the move tool to enable rapid panning around the diagram and zooming in and out. The tool reverts back to the zoom tool when the space bar is released.

Edit

image:toolbar_edit.jpg

Displays dialogs enabling properties of agents, ports and connections to be edited.

Wiring

image:toolbar_wiring.jpg

Allows you to make connections between the inputs and outputs of agents and ports. Also used to disconnect agents and ports.

Hook

image:toolbar_hook.jpg

Used to create new hooks by clicking on the canvas. Can also be used to toggle a hook between "normal" and "sticky" behaviour. Wires running between two sticky hooks are pulled tight, otherwise wires hang down in a natural curve.

Trunk

image:toolbar_trunk.jpg

Using to create and re-size trunks.

Create

image:toolbar_create.jpg

Used to create new agents and certain type of new ports such as drummer voices and kgroup outputs.

Delete

image:toolbar_delete.jpg

For deleting agents, certain ports such as kgroup outputs and drummer voices, connections, hooks and trunks. It can also be used to remove the routing information from a wire (that is remove the wire from all the trunks and hooks that is is routed via) by clicking on the wire while holding down the cmd key on macOS or the ctrl key in windows. By default a confirmation dialog is displayed. These dialogs can be disabled for each of the above categories independently. For example you could choose to display the confirmation dialog for agents and connections, but not display it for hooks and trunks.

Help

When the help tool is selected a new help window is displayed next to the main Workbench window. As you move the mouse cursor over different agents detailed infomation about each agent (if available) is displayed in the help window. The tooltips also show details about an agent when this tool is selected.

Menus

File

Contains two items: About and Preferences. The About menu item simply displays a dialog showing the version of Workbench. Preferences allows configuration of some Workbench settings. (There is currently only one configurable setting which is whether or not to select agents automatically when they are expanded, but more settings are likely to be added soon.)

Edit

Contains the Find menu item. Clicking on the find menu displays a dialog box containing a drop down list of all the agents in the current setup. Select an agent from the list and click 'Find' and the agent will be selected on the workbench diagram. The diagram is scrolled as necessary. The zoom level is not altered.

View

The View menu contains two items: Metronome outputs and Controller outputs. Connections from Metronomes and from Controllers can be hidden as they tend to clutter the diagram to little useful purpose. By default metronome output connections are shown, while controller output connections are not. (If Metronome output connections are set to hidden (ie the menu item 'metronome outputs' is not ticked) and you make a connection from a metronome output, any other metronome outputs will be shown and the 'metronome output' menu will be ticked automatically.)

Back to Workbench