manual:user_interface_in_a_nutshell
no way to compare when less than two revisions
Differences
This shows you the differences between two versions of the page.
— | manual:user_interface_in_a_nutshell [2010/10/08 16:02] (current) – Page name changed from manual:main_user_interface to manual:user_interface_in_a_nutshell camille | ||
---|---|---|---|
Line 1: | Line 1: | ||
+ | ====== The user interface in a nutshell ====== | ||
+ | |||
+ | ===== Foreword ===== | ||
+ | |||
+ | Most of what happens in OSCulator is located in the Main Window. | ||
+ | |||
+ | This window displays the list of messages that OSCulator received so far. Events can be triggered in response to the messages' | ||
+ | |||
+ | In a new document, the list is empty. | ||
+ | |||
+ | |||
+ | |||
+ | ===== Description of the main window ===== | ||
+ | |||
+ | The main window is divided into 3 parts: | ||
+ | |||
+ | {{ : | ||
+ | |||
+ | ; 1. Toolbar : A toolbar with customizable items. | ||
+ | * a start/pause button, | ||
+ | * the OSC input port number, | ||
+ | * the Presets menu, | ||
+ | * the Quick Look viewer, useful to have a visual representation of the input, | ||
+ | * the Parameters Window button, gives access to advanced features, | ||
+ | * and the Wiimote Drawer button, shows the Wiimote configuration panel. | ||
+ | |||
+ | ; 2. Messages List : The table showing the list of registered messages. | ||
+ | ; 3. Status bar : A led indicates the readiness status, and a label displays messages of interest to the user. | ||
+ | |||
+ | |||
+ | ==== A more detailed look at the columns ==== | ||
+ | |||
+ | {{ : | ||
+ | |||
+ | ; 1. Enable : A checkbox to enable or disable the event. | ||
+ | ; 2. Activity : An activity sensor that blinks when a value is changing. | ||
+ | ; 3. Message : This is the name of the registered message. When the disclosure triangle is down, this columns displays the indices of the arguments, or their user-friendly memo if they are available. | ||
+ | ; 4. Event Type : A drop-down menu that shows the list of all Event Types (see [[: | ||
+ | ; 5. Value : A drop-down menu that shows the list of all possible values for the chosen Event Type. | ||
+ | ; 6. Channel : MIDI related Event Types use a channel (such as '' | ||
+ | |||
+ | |||
+ | |||
+ | ==== New document ==== | ||
+ | |||
+ | A new OSCulator document named ' | ||
+ | |||
+ | In order to populate this table, you will need to send OSC messages to OSCulator, or connect a Wiimote or a SpaceNavigator. | ||
+ | |||
+ | |||
+ | |||
+ | ==== Multiple documents ==== | ||
+ | |||
+ | It is possible to work on multiple documents, that is, multiple windows at once. | ||
+ | This is useful when you want to separate functionality accross several files. | ||
+ | For example, if you need to work with two different TouchOSC devices, you must separate their configuration using two different files. | ||
+ | |||
+ | < | ||
+ | |||
+ | |||
+ | ===== Operation on messages ===== | ||
+ | |||
+ | ==== Edit Menu ==== | ||
+ | |||
+ | === Copy (⌘C) / Paste (⌘V) / Cut (⌘X) === | ||
+ | |||
+ | Use the Copy and Paste functions to copy and paste messages and events between different presets or windows. | ||
+ | |||
+ | === Delete (Backspace key) === | ||
+ | |||
+ | You can delete one or more events by selecting them in the list and pressing the Backspace key. | ||
+ | |||
+ | If you delete a message, you will not prevent OSCulator from receiving it again. | ||
+ | |||
+ | === Select All (⌘A) === | ||
+ | |||
+ | Selects all messages in the window. | ||
+ | |||
+ | === Duplicate (⌘D) === | ||
+ | |||
+ | Use the Duplicate command to send the same message to many events. | ||
+ | |||
+ | For example, with a single button of the Wiimote you can trigger two MIDI Control Change events. | ||
+ | |||
+ | === Split (⇧⌘D) === | ||
+ | |||
+ | " | ||
+ | |||
+ | This function creates two virtual messages, one for the low values of the incoming message (between 0 and 0.5, excluded) and the other one for high values of the incoming message (between 0.5 and 1). The outputs are scaled to 0 1. This is very useful when you have the input from the axis of a controller and want to assign a different event for each sides of the axis. For example, with the joystick of the Wiimote' | ||
+ | |||
+ | Since version 2.8, Split is actually the same Duplicate except it automatically configures the scalings so the previously described behaviour is achieved. | ||
+ | |||
+ | === Demux (⌃D) === | ||
+ | |||
+ | Demuxes or " | ||
+ | |||
+ | A simple use of that feature is to give a different event to the same Wiimote button (e.g. ''/ | ||
+ | |||
+ | * 1 when the button is pressed | ||
+ | * 0 when the button is released | ||
+ | |||
+ | Select the message ''/ | ||
+ | |||
+ | / | ||
+ | 0 - | ||
+ | 1 - | ||
+ | |||
+ | Be careful not to use this feature with continuous values as it can produce unexpected results. | ||
+ | ==== Routing Menu ==== | ||
+ | |||
+ | === Stop/Start Routing === | ||
+ | |||
+ | This menu command has the same effect as the play button in the toolbar. | ||
+ | When the routing is stopped, OSCulator will stop receiving OSC((this means that Bonjour service publishing is also stopped)), MIDI, and every inputs. | ||
+ | |||
+ | === Lock Input (⌘L) === | ||
+ | |||
+ | Locks the input so the message list can not be changed in any way. This function will prevent from altering the state of the running document. | ||
+ | |||
+ | === Solo (⌘R) === | ||
+ | |||
+ | Use this command to only enable the selected events. | ||
+ | |||
+ | On first call, it enables only the selected events, and disables all the other ones. On subsequent calls, toggles between the previous state and the Solo state. | ||
+ | |||
+ | < | ||
+ | |||
+ | For this, select the line you want to solo, hit ⌘R, and activate MIDI learn in Live. When you're done learning the MIDI event, go back to OSCulator and hit ⌘R again to restore the previous working state.</ | ||
+ | |||
+ | === Enable (⇧⌘R) === | ||
+ | |||
+ | Enables the selected messages. | ||
+ | |||
+ | === Disable (⌥⌘R) === | ||
+ | |||
+ | Disables the selected messages. | ||
+ | The disabled messages will not triggered their events. | ||
+ | |||
+ | === Collapse / Expand (⇧⌘E) === | ||
+ | |||
+ | Collapses or expands the selected lines. | ||
+ | |||
+ | === Quick Look === | ||
+ | |||
+ | Pressing the space bar will display a small graph window useful to have a visual readout of the data (see [[quick_look]] for more information). | ||
+ | |||
+ | === Manually Create Message… === | ||
+ | |||
+ | Prompts the user with a OSC message name, and displays it in the list. | ||
+ | This command is only useful in some very specific cases. | ||
+ | |||
+ | < | ||
+ | * Choose " | ||
+ | * When the message is displayed in the list, assign a MIDI Control Change event, | ||
+ | * In Live activate the MIDI learn mode and select the control you want to map with the LED, | ||
+ | * Back to OSCulator, click in the activity monitor corresponding to the ''/ | ||
+ | * Disengage learn mode in Live, and use the mapped control, this will create a back-mapping entry in OSCulator, thus changing the status of the LED in TouchOSC. | ||
+ | |||
+ | </ | ||
+ | |||
+ | |||
+ | ==== Keeping the main window on top of all others ==== | ||
+ | |||
+ | When you work with another software, it can be useful to keep OSCulator' | ||
manual/user_interface_in_a_nutshell.txt · Last modified: 2010/10/08 16:02 by camille