Tool Bars

Both the Panel and the Workspace have tool bars. Since either window may be hidden, several toolbar icons are duplicated in each. Also, some icons do the same functions but are specific to the area.


Panel Tool Bar

ArtWonk
MusicWonk

Full Screen/Split Screen

Click to show only Panel or only Workspace. Click again for normal split screen.

Patch Help

This button is visible only if patch help is available. When showing, there is a help file for the patch, click the button to view.  Patch help files are .htm files with the same name as the patch.  You can make your own patch help files by creating an .htm file with an htm editor (this document was prepared with the excellent and free BlueGriffon editor), or you can use Word and save the file as an htm document.

Lock/Unlock Panel Widgets

Locks the Panel Widgets so they can't be moved or opened. If the properties button isn't working, it's most likely because the Panel is locked.

Capture Panel (ArtWonk only)

Captures an image of the of the panel to screen 1. Use the Workspace capture button to capture the entire ArtWonk window, as well as the separate window components.Once captured you can use the right click context menu on the screen to save the image.

All Notes Off

Turns off stuck notes on all connected MIDI devices. You can select various All Note Off options with the MIDI Option dialog. Duplicated in the Options menu. Keyboard F2 also sends ANO.

Graphics Screens (ArtWonk only)

These buttons show and hide the Canvas and the four Screens.

Refresh Strobe

This is a strobe that is True (1) for exactly one full cycle of the Main Loop. It may be used for anything you like; it has no specific use in ArtWonk. Access the output value from the System Module Refresh output.

Play Button

Play is a state button that remains pressed until you click on it a second time. Play normally would be used to start up clocks, enable MIDI output modules, and generally start off a process. However you are free to use the button for whatever you like. ArtWonk does nothing with Play except to monitor it when the Record button is pressed (both Play and Record must be pressed in order to start the MIDI file recorder). The Play button state is available in the System Module Play output, as well as the reverse state in the Stop output; you can also programmatically initiate Play by setting the System module Play input to non zero.

The Play button can also be placed in the Windows toolbar tray, for easy access when other programs are running. Set from Global Options in the Options menu whether the it should appear in the tray always, never, or only when ArtWonk is minimized. Left click works the same as on the toolbar, switching between Play and Stop. Right click sends All Notes Off, and goes to Stop. Shift left click to increment the Snapshot number, shift right click to decrement it.

Record Button

Use this button to record a MIDI file. Both the Play and the Record button must be pressed before MIDI recording starts. Recording will continue until either button is released (the other button will pop out automatically). MIDI is always recorded to a temporary MIDI file, "temp.mid," in the ArtWonk Settings folder. The Record button state is available in the System Module Record output.

Play MIDI File Button

Plays the MIDI file, "temp.mid," located in the ArtWonk Settings folder, which will have been created upon the completion of a MIDI file Record. In order for MIDI file play to be an accurate test of your recording, ArtWonk does not directly play the file, instead it effectively shuts down and calls the Windows multimedia driver to play the file. Thus all clocks and ArtWonk-generated MIDI activity will be shut down for the duration of the play. The MIDI device the Windows MM player uses is the default MM device, which normally will be the same one used when you double click on a .mid file in the Windows explorer.

Save Recorded MIDI File Button

Copies the temporary MIDI file, "temp.mid," in the ArtWonk Settings folder, which will have been created upon the completion of a MIDI file Record, to a folder and file name of your choosing.

Create Snapshot Flag

Pops up a dialog showing all 128 snapshot slots to enable you to create, update or edit a snapshot. Snapshots store the settings of all active Panel Widgets (knobs, sliders, etc.). To edit a snapshot name, type the name into the text box just above the snapshot list. To select which snapshot is used to save current settings, click on it in the list. Click OK to save the snapshot name and settings, Cancel to cancel. The first time a snapshot is saved, all slots are initialized to that value, so the first snapshot value saved becomes the default snapshot value for all 128 snapshot slots.

Select Snapshot Drop Down List

Selects the current snapshot. All active Panel widgets that have saved snapshots will jump to the new settings. Widgets that have never had a snapshot saved will not be affected. Snapshots can be changed programmatically with the Snap input to the System Module, and the current snapshot can be read from the System Module Snap output. Snaps can also be changed via MIDI Program Change if the option is selected in the MIDI Options dialog.

Since changing snapshots cause widgets to change their settings to those stored in the new snap, a problem can arise when using a widget to set the snapshot via the System module. To avoid this, many of the widgets have an "Ignore snapshots" property that will make them exempt from recursively changing with the snapshot.

Snapshots are stored with the patch (.awp) file, and when a patch file is loaded all widgets that had previously been saved to a snapshot will be set to the snapshot that was in effect when the file was saved. When you load a Macro, the snapshot for any widgets are loaded and added to the snapshot list, but the loaded modules will not be set to the system snapshot, they will remain at the settings that were in effect when the Macro was saved.

Save Bookmark (same icon in both toolbars, but works slightly differently)

Creates a bookmark that saves the current Panel location. Only the screen location is saved, use the Workspace bookmark to save the module location. When a bookmark is created the next empty bookmark letter (A to Z) is used and it appears on the toolbar to the right of the bookmark icons.

Add Comment to Bookmark

Pops up a dialog box to enable you to edit the tool tip of the bookmark currently in effect (a bookmark is in effect when you click on it, and the screen is changed to that location). Gives error message if no bookmark has been created or if the bookmark is not in effect. Note that when a bookmark is created it is given a default comment. For Panel bookmarks this is simply the letter name of the bookmark.

Delete a Bookmark

Deletes the bookmark currently in effect.

Previous Location
Keyboard shortcut: Shift-F5 (Panel)

Jumps to the previous screen location. You do not need to be on a bookmark; clicking this button moves you between the last screen location and the current location regardless of bookmarks. You can use the keyboard shortcuts even while dragging objects, in order to reach a screen area not currently visible.

Go Home (same icon in both toolbars, but works slightly differently)
Keyboard shortcut: Shift-F6

In the Panel toolbar this button always takes you to the upper left corner of the Panel screen area; in the Workspace toolbar, it take you to the location of the Self module in the current Macro level.

Bookmarks A, B, C...

Appears when bookmarks are set. Jumps to the location that was stored in the bookmark.


Workspace Tool Bar

ArtWonk
MusicWonk

Full Screen/Split Screen

Click to show only Panel or only Workspace. Click again for normal split screen.

Default Window

Resizes to the default window size. You can save the default size with Global Options.

Quick Load & Save

Loads and saves the current Workspace into a quick file. Loads the Quick file that was last saved by Quick save, which is the next Quick file in a rotating set of 10 Quick files. This allows you to backtrack to a previously saved Quick file. The tool tip indicates which Quick file, 0 to 9, will be loaded or saved. You can also load any of the Quick saved files from the Files menu.

Note that Save increments the Quick#, as it is saving a new patch file each time; however Load never increments the Quick# - it only loads (or reloads) the last Quick saved patch.  So to go back earlier than the most recent Quick save, use "Open Quick..." from the main menu.

  Open, Save & SaveAs

Open a new patch file, Save the currently opened Patch file. Same as from the main menu.

Macro-ize

Converts the current Workspace page into a macro. It works slightly differently on the top level Workspace than any other level because the top level System module cannot be duplicated. So at the top level, a standard 1-Input, 1-Output macro is created and all modules that exist on the page are put into it. On any other page, the a macro is created that reflects the inputs and outputs of the page's Self module, and all connections to the Self module are passed through the new Macro.

Debug, Single Step

This is a state button that remains pressed until you click on it a second time. It causes all Loop clocks and module processing to stop. This gives you a chance to load a problem file and examine it without it instantly executing, or to stop a program that is showing multiple errors so you can freeze the error message. Single Step is visible only when Debug is in effect.  Each time it is clicked, ArtWonk advances one cycle.  You can see the Main loop count in the System module advance each time the Single Step button is clicked.

Refresh the Macro & Function Menus

The Macro and Function menus are constructed from the respective folders and files, a process that can take a few seconds. This is part of the normal program start up and initialization and typically does not need to be performed again. However if you create a folder or copy macro or function files, they will not show up in the menu until the next time you run ArtWonk. With this button you can force a menu refresh, and thereby avoid having to exit and restart the program in order to see the menu changes.

Load Event

A Load event occurs when ArtWonk is first initialized, or when a file is loaded. All loop clocks are reset to 0, and both Reset Flag and Load Flag strobe are sent to the modules. This button forces a Load event, and is available for testing or resetting patches. When the button is pressed, the Load output of the System module goes True (1) for exactly one Main Loop cycle. You can also force a load event programmatically by strobing the Load input of the System Module.

Reset Event

Reset occurs whenever the normal clock flow is interrupted, as when a module is inserted or deleted, or a Workspace page is changed. When you see the Module Tree flashing because it is being rebuilt, it will be followed by a Reset so all loop timers and clocks are synchronized. A Reset is the same as a Load, except the Load flag is not sent to the modules, only the Reset flag. The reason for the two different flags is that some processes should be initialized only when the file is first loaded, but some should be reset whenever there is a chance of the clocks loosing synchronization. This button forces a Reset event. When the button is pressed, the Reset output of the System Module goes True (1) for exactly one Main Loop cycle. You can also force Reset by strobing the Reset input of the System Module.

Refresh Strobe

This is a strobe that is True (1) for exactly one full cycle of the Main Loop. It may be used for anything you like; it has no specific use in ArtWonk. Access the output value from the System Module Refresh output.

Play Button

Play is a state button that remains pressed until you click on it a second time. Play would normally be used to start up clocks, enable MIDI output modules, and generally start off a process. However you are free to use the button for whatever you like. ArtWonk does nothing with Play except to monitor it when the Record button is pressed (both Play and Record must be pressed in order to start the MIDI file recorder). The Play button state is available in the System Module Play output, as well as the reverse state in the Stop output; you can also programmatically initiate Play by setting the System module Play input to non zero.

The Play button can also be placed in the Windows toolbar tray, for easy access when other programs are running. Set from Global Options in the Options menu whether the it should appear in the tray always, never, or only when ArtWonk is minimized. Left click works the same as on the toolbar, switching between Play and Stop. Right click sends All Notes Off, and goes to Stop. Shift left click to increment the Snapshot number, shift right click to decrement it.

Record Button

Use this button to record a MIDI file. Both the Play and the Record button must be pressed before MIDI recording starts. Recording will continue until either button is released (the other button will pop out automatically). MIDI is always recorded to a temporary MIDI file, "temp.mid," in the ArtWonk Settings folder. The Record button state is available in the System Module Record output.

Play MIDI File Button

Plays the MIDI file, "temp.mid," located in the ArtWonk Settings folder, which will have been created upon the completion of a MIDI file Record. In order for MIDI file play to be an accurate test of your recording, ArtWonk does not directly play the file, instead it effectively shuts down and calls the Windows multimedia driver to play the file. Thus all clocks and ArtWonk-generated MIDI activity will be shut down for the duration of the play. The MIDI device the Windows MM player uses is the default MM device, which normally will be the same one used when you double click on a .mid file in the Windows explorer.

Save Recorded MIDI File Button

Copies the temporary MIDI file, "temp.mid," in the ArtWonk Settings folder, which will have been created upon the completion of a MIDI file Record, to a folder and file of your choosing.

Capture Workspace (ArtWonk only)

Captures the entire ArtWonk window to screen 1, and also captures the Workspace only to screen 2, the Tree only to screen 3, and the Panel only to screen 4.

Document Workspace Button

This button pops up the Workspace documentation dialog, which enables you to create, delete, or edit background documentation objects (text, doc boxes, doc pictures, and grouping frames). Right clicking on an existing documentation object will also pop up the dialog, with the object selected.

Save Bookmark (same icon in both toolbars, but works slightly differently)

Creates a bookmark that saves the current Workspace or Panel location. Workspace buttons save both the screen location and the macro level (Workspace page); Panel buttons save only the screen location. When a bookmark is created the next empty bookmark letter (A to Z) is used and it appears on the toolbar to the right of the bookmark icons.

Add Comment to Bookmark

Pops up a dialog box to enable you to edit the tool tip of the bookmark currently in effect (a bookmark is in effect when you click on it, and the screen is changed to that location). Gives error message if no bookmark has been created or if the bookmark is not in effect. Note that when a bookmark is created it is given a default comment. In the Panel this is simply the letter name of the bookmark, but in the Workspace this will be the path name of the Macro level.

Previous Location
Keyboard shortcut: F5

Jumps to the previous Macro level and current screen location. You do not need to be on a bookmark; clicking this button moves you between the last location and the current location regardless of bookmarks. You can use the keyboard shortcuts even while dragging objects, in order to reach a screen area not currently visible.

Go Home (same icon in both toolbars, but works slightly differently)
Keyboard shortcut: F5 (Workspace), Shift-F5 (Panel)

In the Panel toolbar this button always takes you to the upper left corner of the Panel screen area; in the Workspace toolbar, it take you to the location of the Self module in the current Macro level.

Bookmarks A, B, C... (similar in both toolbars)
Keyboard shortcut for A-D only: F6-F10 (Workspace), Shift-F6-F10 (Panel)

Jumps to the location that was stored in the bookmark (in Workspace, jumps to Macro level and screen location).

 

ArtWonk is Copyright 2003-2014 by John Dunn and Algorithmic Arts. All Rights Reserved.