Document BrushXY Guide BrushXY (E1013AK37) © 1994, 1995 Elbow Cay Enterprises Adjusts the x/y co-ords of an ILBM's BMHD. 0. Important, please read first 0.1. Copyright and License BrushXY © 1994, 1995 Elbow Cay Enterprises This is a freely distributable, copyrighted piece of software. You do not have to pay money to use it, and may upload it, or copy it, but you are not allowed to sell it for profit, or include it on a disk which is sold for profit, without the author's permission. You must also distribute it intact, including all documentation and other files. DISCLAIMER These Files and their related documentation, utilities, and examples are provided "AS-IS" and subject to change without notice; no warranties are made. All use is at your own risk. No liability or responsibility is assumed. 0.2. Release Notes Release 37.00 ( 09-Jun-94 ) - Initial Release. Release 37.10 ( 01-Jan-95 ) - changed GUI to include new features and controls - added online help facility thru AmigaGuide - replaced "view" feature with real-time brush adjustment - can now save over the original brush, the program no longer holds it open - chunk found in original brush should now appear in saved brush some non-standard chunks may not appear 1. Introduction This program loads an IFF ILBM brush file and allows the user to adjust/set the BMHD's (BitMapHeader) "x" and "y" co-ordinates. These are the offsets from the top left hand corner of the original bitmap. I put this tool together when I found out that DeluxePaint® does not store the x/y offset of a saved brush. ( nor does it read it ) 2. System Requirements Required: - Workbench 2.04+ Optional: - reqtools.library (version 38 or higher) 3. Installation 3.1. Using the Workbench To install "BrushXY" onto your system drag the "BrushXY" and "BrushXY.guide" icons into the "tools" drawer on your system disk. You may also with to drag the icons for "Diver.pic", "Diver1.win", and "Diver2.win" into the "tools" drawer as well. 3.2. Using the CLI Use the Workbench its easier. 3.3. Tooltypes At present only the following tooltypes are supported. PUBSCREEN= This is the name of the public screen you wish "BrushXY" to open its window on. Defaults to the Workbench. 4. Instructions 4.1. Starting and Stopping To run "BrushXY" simply double click on its icon and the program will start. You may also specify a brush to work on at this time by clicking once on then brush's icon then holding down the shift key clicking twice on "BrushXY"'s icon. This will cause the program to load up the brush when it starts. When the program starts it will display the `Toolbox window' on either the default public screen or the one you specified in `Tooltypes'. This window's `Gadgets' and `Menus' allow you to load, save, and manipulate brushes. Once you load a brush or a background the `Graphics window' will then be opened on a custom screen, compatible with the brush or background you loaded, for the graphic to be displayed, and the `Toolbox window' will move to this custom screen. To terminate "BrushXY" either select the `Quit' gadget or menu item. If you close the `Toolbox window' when no graphics are currently begin displayed this will also terminate the program. 4.2. Toolbox window The Toolbox window contains the `Gadgets' and `Menus' you will need to load, save, and manipulate brushes. Many of these tools also have `Keyboard Equivalents'. 4.2.1. Gadgets "X and Y Sliders" These allow you to quickly adjust the x/y co-ords of the brush. "Arrow Buttons" These allow you to make fine adjustments to the x/y co-ords of the brush. The single arrows adjust ± 1 pixel while the double arrows adjust ± 10 pixels. "Close Window Gadget" This will close the Toolbox window, and if there is no brush or background currently load it will also terminate the program. "Back" See `Load Background' menu item. "Brush" See `Load Brush' menu item. "Save" See `Save Brush' menu item. "Save as" See `Save Brush as' menu item. "New" See `New' menu item. "Info" See `Info' menu item. "HELP!" See `HELP!' menu item. "Quit" See `Quit' menu item. 4.2.2. Menus 4.2.2.1. New Clears any loaded brush or background closes the `Graphics window' and returns the Toolbox window to the public screen. If unsaved changes exist a confimation requester will ask for permission to proceed. If you reply "Okay" to this requester any unsaved changes will be lost. 4.2.2.2. Load Background Brings up a file requester from which you can select an ILBM file to use as a background. If you load a background its colours will be used instead of any brush you load, unless you select the `Brush Palette' option. 4.2.2.3. Load Brush Brings up a file requester from which you can select the ILBM file file you wish to use as a brush. If unsaved changes to a current brush exist a confimation requester will ask for permission to proceed. If you reply "Okay" to this requester any unsaved changes will be lost. 4.2.2.4. Save Brush Allows you to save any changes you make to the brush you previously loaded. If the file exists a confirmation requester will ask for permission to overwrite it. If you have selected the `Overwrite' option no confirmation is requested. 4.2.2.5. Save Brush as Brings up a file requester from which you can select a file to save the brush to. If the file exists a confirmation requester will ask for permission to overwrite it. If you have selected the `Overwrite' option no confirmation is requested. 4.2.2.6. Info Displays info about the currently loaded brush. 4.2.2.7. HELP! Opens "BrushXY.guide" to the "Instructions" page. The guide will always open on the default public screen. 4.2.2.8. About Displays information about "BrushXY". 4.2.2.9. Quit Exits "BrushXY". If unsaved changes exist, a confirmation requester will ask for permission to quit. If you answer "Okay" to this requester any unsaved changes will be lost. 4.2.2.10. Brush Palette Instructs the program to use the palette of the current brush over that of the background. DEFAULT: OFF 4.2.2.11. Create Icons Instructs the program to save an icon along with any saved brush file. If an icon already exists for a file it is left intact. DEFAULT: ON 4.2.2.12. Overwrite Instructs the program to overwrite an existing file and not ask for permission to do so. DEFAULT: OFF 4.2.2.13. Toolbox Opens the `Toolbox window' if it isn't already open. This option has no effect unless the `Graphics window' is also open. If the `Graphics window' is closed then closing the `Toolbox window' would terminate the program. DEFAULT: ON 4.2.2.14. Save Settings Saves the options, current brush path, current file pattern, and the current `Toolbox window' position to the "BrushXY.prefs" file. This file is kept in the "ENV:BrushXY" and "ENVARC:BrushXY" directories. 4.3. Graphics window The Graphics window displays the currently loaded brush plus over a background graphic, if the user has loaded one. When the user uses one of the brush adjustment tools the brush will move about the window. The brush is limited to the confines of the window, and no part of it may be moved outside of the window. The `Toolbox window' can also appear on this screen, and always in front of the Graphics window. If the toolbox is getting in your way you can always close it by either clicking on its close gadget or selecting the `Toolbox' menu item. To reopen toolbox simply select the `Toolbox' menu item again. While the toolbox is closed you can use the tools' `Keyboard Equivalents'. 4.4. Keyboard Equivalents All the `Gadgets' and `Menus' have a keyboard equivalent. Key(s) Function --------- --------------- right-cursor move brush 1 pixel right left-cursor move brush 1 pixel left up-cursor move brush 1 pixel up down-cursor move brush 1 pixel down shift right-cursor move brush 10 pixels right shift left-cursor move brush 10 pixels left shift up-cursor move brush 10 pixels up shift down-cursor move brush 10 pixels down ctrl right-cursor move brush to far right ctrl left-cursor move brush to far left ctrl up-cursor move brush to far top ctrl down-cursor move brush to far bottom R-Amiga N `New' R-Amiga B `Load Background' R-Amiga L `Load Brush' R-Amiga S `Save Brush' R-Amiga A `Save Brush as' R-Amiga I `Info' Help `HELP!' R-Amiga ? `About' R-Amiga Q `Quit' R-Amiga B `Brush Palette' R-Amiga C `Create Icons' R-Amiga O `Overwrite' R-Amiga T `Toolbox' R-Amiga K `Save Settings' 5. Demo Included with this program are three ILBM's to demonstrate "BrushXY". Diver.pic This is a background graphic. If you load this you will note that there is a blacked out area in the center. This is where the brush was taken from. Diver1.win This is the brush saved directly from DeluxePaint. If you load this you will see that it is displayed in the upper left hand corner of the display, not where it was originally made. This is because DeluxePaint does not save the x/y co-ordinates, but instead sets them to zero on write and ignores them on read. Diver2.win This is the brush that has been adjusted through "BrushXY". If you load this you will see that it is display in the correct position. If you have also loaded the background then the brush neatly fills in the blacked out area. 6. Bugs - If you load a background of one display type then load a second of a different type the screen remains in the first display mode. I'll fix this in a future release, just as soon as I can figure out a way to do it without going mad. - AGA? I have no idea? Try and if it doesn't work, tell me how to support AGA without two grand to buy an AGA machine to support it on, and I'll fix it. 7. Acknowlegments Compiled with : SAS-C® (v6.50) The SAS Instuitute. AmigaGuide via : Text2Guide © Stephan Surken 1993. GUI Designed in part with : GadToolsBox © 1992,1993 Jaba Development Some requesters: ReqTools.Library © Nico Francious 8. Author Mailing Address: Tom Landers o/a Elbow Cay Enterprises 176 Redgrave Dr Etobicoke, ON Canada M9R 3V9 Mail: User id: crs1881@inforamp.net