home *** CD-ROM | disk | FTP | other *** search
/ Fresh Fish 9 / FreshFishVol9-CD2.bin / bbs / util / palettetool-1.4.lha / PaletteTool / PaletteTool.guide (.txt) < prev    next >
Amigaguide Document  |  1994-06-18  |  28KB  |  537 lines
  1. @database PaletteTool.guide
  2. @node Main "PaletteTool" 
  3. PaletteTool - A Public Screen palette for 8 or more colors
  4. Copyright 
  5. 1994 by Timothy B. Kreuzer.  All rights reserved.
  6. Version: 1.4
  7. Author: Tim Kreuzer (and the KreuzerSoft support team)
  8. Language: SAC/C V6.5
  9.       @{"Features" link features}
  10.       @{"Limitations" link limitations}
  11.       @{"Release Notes" link releasenotes}
  12.       @{"Notes from the Author" link notesfromtheauthor}
  13.       @{"Why PaletteTool?" link whypalettetool}
  14.       @{"Terminology Disclaimer" link terminologydisclaimer}
  15.       @{"Starting PaletteTool" link startingpt}
  16.       @{"Main PaletteTool Window Description" link mainptwindowdescription}
  17.       @{"Palette Window Description" link palettewindowdescription}
  18.       @{"ColorByName Window Description" link cbnwindowdescription}
  19.       @{"Iconified Window Description" link iconwindowdescription}
  20.       @{"Basic PaletteTool Operation" link basicptoperation}
  21.       @{"Icon Tooltypes" link icontooltypes}
  22.       @{"Credits" link credits}
  23.       @{"Contacting the Author" link contactingtheauthor}
  24.       @{"Legal Stuff" link legalstuff}
  25.       @{"KreuzerSoft Products" link kreuzersoftproducts}
  26. @endnode
  27. @node features "Features"
  28.       Opens and operates on the default public screen
  29.       Gadtools-based user interface, with keyboard equivalents for
  30.        many of the program functions
  31.       Full 8 bit RGB support
  32.       Full AmigaDOS 3.0-compliant locked pen "protect" mode as well
  33.        as standard "free" mode
  34.       Fully integrated "color by name" selection, with a built-in
  35.        database of 507 colors
  36.       Supports the follow actions:
  37.          - color spread (multi-directional)
  38.          - individual color copy
  39.          - individual color exchange
  40.          - rotation of palette in both direction
  41.          - cycling of entire palette in both directions
  42.            with adjustable cycle speed
  43.          - individual color "show" (flash selected color)
  44.       User interface consists of separately controllable windows for:
  45.          - main functions
  46.          - color palette (2 sizes)
  47.          - "color by name" selection
  48.       Features a single-level "undo" capability
  49.       Iconifiable, with color cycling controls also available from
  50.        the programs iconified state
  51.       Features ability of pick a pen/color from anywhere on the
  52.        current screen (using the mouse pointer and either the space
  53.        bar or middle-mouse-button).  This type of color "pick" can
  54.        also be used with the copy, spread, and exchange actions
  55.       Freatures a "panic" restore button (and key equivalent) so
  56.        you can restore the palette to where it was at program start
  57.       "Smart" iconify function
  58.       Help text (displayed on screen banner) for the copy, spread,
  59.        exchange, and pick actions
  60.       Upon exit, restores palette to where it was at start-up
  61.       Single version for 68020 and up CPUs (all AGA Amigas)
  62.       Tested OK using the Enforcer
  63. @endnode
  64. @node limitations "Limitations"
  65.       Can only be used from the Workbench (start via Icon) 
  66.       Requires AmigaDOS 3.0(+) and the AGA chipset
  67.       Requires a 68020(+) CPU
  68.       Designed for use with higher-resolution screen modes (640x400 and
  69.        higher).  Note that this does NOT mean the program will not work
  70.        on lower-resolution screens.  What it DOES mean is that you may
  71.        find the programs windows take up a lot of screen "real estate"
  72.        on lower-resolution screens
  73.       For some reason, the "pick" capability (using the space bar and/or
  74.        middle-mouse-button) does not work correctly when using any of
  75.        the screen modes supplied by EGS Spectrum graphics boards.  I'm
  76.        guessing this is a problem with the EGS "Amiga screen" emulation
  77. @endnode
  78. @node releasenotes "Release Notes"
  79. -----------------
  80. Version 1.4 Notes
  81. -----------------
  82. Completed reworked the user interface:
  83.    - Moved the palette display to a separate window
  84.    - Palette window can be displayed in two (user selectable) sizes
  85.    - Added keyboard equivalents
  86.    - Palette cycling controls now available on the iconify window
  87.      as well as the main control window
  88. Added the (incremental) palette rotation capability
  89. Added the color exchange capability
  90. Added the keyboard equivalents
  91. Reworked major sections of the source code
  92. ------------------
  93. Version 1.3b Notes
  94. ------------------
  95. Fixed bug which caused inaccurate color "Spread" to occur while in the
  96. "Protect" palette mode
  97. ------------------
  98. Version 1.3a Notes
  99. ------------------
  100. Fixed bug which caused the 3 pointer colors to be skipped on a Spread
  101.  action in "Free" mode (would only see this on screens with 32 or more
  102.  pens).  I really apologize for this, as I am very picky about only 
  103.  uploading fully tested programs!
  104. -----------------
  105. Version 1.3 Notes
  106. -----------------
  107. Screens with a minimum of 8 colors now supported
  108. Added "color by name", "panic restore", "pick from screen", full 
  109.  AmigaDOS 3.0 palette "protect" mode, and "free" mode capabilities.
  110.  Note that "protect" mode takes the place of the old "hardcoded"
  111.  method of avoiding pens/colors used by the system
  112. Fixed bug in "Iconify", where the previous positions of the main PaletteTool
  113.  window and the inconified window were not restored when they (re)opened.
  114.  Windows were opening at a fixed location (yech!)
  115. The currently selected pen/color in the main palette display is now
  116.  recessed, allowing for easier visual confirmation
  117. Main palette gadget is no longer disabled during cycling
  118. Miscellaneous code and user interface cleanup
  119. -----------------
  120. Version 1.2 Notes
  121. -----------------
  122. Added full 8-bit RGB support (Hurray!)
  123. Added Iconify ("I" button) support
  124. Added About ("?" button)
  125. Added support for "X" and "Y" icon tooltypes to determine position
  126.  of PaletteTool window at startup
  127. Corrected the Spread function's math to allow "smoother" spreads
  128. PaletteTool will no longer open on a screen that supports less than
  129.  32 colors; a nice requester will pop up to remind you of this if you try
  130. Fixed problem where original palette was not correctly restored upon
  131.  quiting following certain types of Undo actions
  132. Fixed problem where the currently selected color's RGB slider values were
  133.  not correctly reset after an Undo action
  134. All other features operate the same as in version 1.1
  135. -----------------
  136. Version 1.1 Notes
  137. -----------------
  138. Added the Copy, Undo, and Spread capabilities
  139. Added the "restore palette at exit" capability
  140. All other features operate the same as in initial release version
  141. The loading and unloading of the palettes at the beginning and end of
  142. cycling can lock up your Amiga for 1 second or so
  143. DON'T PANIC IF THIS SHOULD HAPPEN!  OK?  Sorry for yelling!
  144. @endnode
  145. @node notesfromtheauthor "Notes from the Author"
  146. Upon release of V1.3 of PaletteTool, the program grew in size by about
  147. 100%.  The biggest reason for the size increase was the addition of
  148. the color-name database.  With this version (V1.4) I've managed to keep
  149. the program size roughly the same as before (approx 46K bytes) while
  150. adding a lot of new features. 
  151. I'd like the get the program "smaller" if possible, and will continue
  152. looking for ways to do this.
  153. I decided a few versions ago that separate executables for 68020/30/40 
  154. CPUs were really not needed, as the most "intensive" thing PaletteTool
  155. does is cycling.
  156. I really didn't want to use the "space bar" for the "pick" action, but I 
  157. don't know any other method (short of middle or right mouse button).
  158. I ran into weird system-lockup problems trying to trap an IDCMP window
  159. inactiviate (and update the gadgets) when the left mouse button was
  160. pressed outside the PaletteTool window.  I also didn't want to use the
  161. right mouse button because of their standard use with menus.
  162. The creation and evolution of PaletteTool has served as a wonderful
  163. introduction-to and expansion-of my learning more about both the "C"
  164. programming language and the Amiga.  It's a real joy developing code
  165. on such a wonderful machine (and operating system).
  166. @endnode
  167. @node whypalettetool "Why did I create PaletteTool?"
  168. 18 months ago, after deciding to take the plunge and buy an A4000 
  169. (which, by the way, is a fantastic machine!), I was disappointed in
  170. the lack of applications which exploited t