home *** CD-ROM | disk | FTP | other *** search
/ X-Ray / X-Ray.iso / gfx-soft / iopeditor / iopeditor.txt < prev    next >
Text File  |  1996-09-20  |  11KB  |  304 lines
  1.  
  2.                  Imagine Object Path Editor Manual
  3.                  
  4.                      Written by Darran Williams
  5.                      
  6.                             April 1996
  7.  
  8.  
  9.  
  10. DISCLAIMER
  11. ----------
  12.  
  13. THIS PROGRAM IS PROVIDED ON AN "AS IS" BASIS, NO WARRANTIES ARE MADE, EITHER 
  14. EXPRESSED OR IMPLIED. IN NO EVENT WILL I, DARRAN WILLIAMS, BE LIABLE FOR ANY 
  15. DIRECT, INDIRECT, INCIDENTAL, OR CONSEQUENTIAL DAMAGES ARISING FROM ANY USE 
  16. OR MISUSE OF THIS PROGRAM. 
  17.  
  18.  
  19.  
  20. Distribution
  21. ------------
  22.  
  23. This program is PUBLIC DOMAIN. You may freely distribute this program as
  24. long as the following files are distributed with it.
  25.  
  26. IOPEditor                      (Program File)
  27. IOPEditor.Info                 (Program 4 Colour Icon)
  28. IOPEditor.Guide                (AmigaGuide Documentation)
  29. IOPEditor.Guide.info           (AmigaGuide Icon)
  30. IOPEditor.txt                  (This Documention)
  31. IOPEditor.txt.info             (Text file Icon)
  32. IOPEditor.Install              (Install Script)
  33. IOPEditor.Install.info         (Install script Icon)
  34. MagicWB/IOPEditor.Info         (Program MagicWB Icon)
  35. MagicWB/IOPEditor.Guide.Info   (AmigaGuide MagicWB Icon)
  36. MagicWB/IOPEditor.txt.info     (Text Doc MagicWB Icon)
  37.  
  38.  
  39.  
  40. Acknowledgements
  41. ----------------
  42.  
  43. I would like to acknowledge the following companies for their continued
  44. support of the Amiga and any copyright information.
  45.  
  46. Imagine is copyright Impulse Inc.
  47. HiSpeed Pascal is copyright Hisoft.
  48. Amiga is copyright Amiga Technolgies.  
  49.  
  50.  
  51.  
  52. What is it ?
  53. ------------
  54.  
  55. The Imagine Object Path Editor allows you to change the paths of Brushes
  56. and Textures assigned to an Imagine Object without the need to go into
  57. Imagine's Attribute requester to change every individual path. It allows
  58. you to change individual paths or globally alter all paths in the File.
  59. The program can cater for objects saved from versions 2, 3.x and 4 of 
  60. Imagine. 
  61.  
  62.  
  63. What it does not do.
  64. --------------------
  65.  
  66. You can only change the path of a brush or texture. You cannot change
  67. the name of the brush/texture or it's attributes. In order to do that
  68. you must go into Imagine and use the attribute requester.
  69.  
  70. You cannot change the version of an object file. An object loaded as
  71. a 3.x object will be saved as a 3.x object. If you want to convert 
  72. the version up load the object into Imagine and resave it. The Object
  73. will always be saved in the version of the program being used. You
  74. cannot downgrade a version. Apart from loosing information why would
  75. you want to ?.
  76.  
  77. Note: Because of changes between versions of Imagine. Imagine 3 (for
  78. instance) will not recognise brushes and textures assigned to an
  79. Imagine 4 object. It probably wouldn't load anyway (I've not tried),
  80. as I expect other changes have been made to the TDDD format other
  81. than the Brush and Texture Chunks.
  82.  
  83.  
  84. Advice on Setting up new Objects
  85. --------------------------------
  86.  
  87. My advice to anyone creating new objects would be to assign a logical
  88. device to the directory where the object, brushes and textures are then
  89. use this device (volume) name to select the brush or texture. This way 
  90. if the objects and or brushes/textures are moved only the assigned path 
  91. need be changed not the object, and this program is not needed. 
  92. Personally I use Project: which points to a subdirectory containing all 
  93. my projects, objects, brushes etc.
  94.  
  95.  
  96.  
  97. Why write this program?
  98. -----------------------
  99.  
  100. This program was written to save me a lot of time and effort when 
  101. transferring Imagine Object files about, especially those that 
  102. either originated off the PC or from one of the numerous CD's 
  103. available. Apart from labouriously identifying which parts of the 
  104. object had textures or brushes, complicated objects could have 100 
  105. or more textures and brushes, all of which had to be individually 
  106. changed in the Attribute editor. Also in some 3.x versions of 
  107. Imagine error messages would appear when in the Attributes requester 
  108. if the path could not be found which was very annoying (thankfully 
  109. this feature appears to have been changed in version 4). As most of 
  110. the brushes or textures are almost always in the same directory I 
  111. wanted a way of globally changing the paths. I also wanted a quick
  112. way of amending the paths so that it could be copied to a PC. I
  113. couldn't find a program that already did this so I decided to write
  114. one myself. So Here it is.
  115.  
  116.  
  117.  
  118. Requirements.
  119. -------------
  120.  
  121. An Amiga. 
  122.  
  123. Workbench 2.04 or Above.
  124.  
  125. The program holds the whole file in memory so the minimum would be
  126. the size of the file + about 200k.(A 1MB file requires about 1.3MB
  127. of memory. The requirement goes up about 1K for each brush/texture). 
  128.  
  129. The program currently works with TDDD Files saved from Imagine 
  130. versions 2, 3.x and 4. I cannot guarantee that it will work with any
  131. later versions.
  132.  
  133. This program has been tested on an Amiga 1500 with 5MB ram and an
  134. Amiga 4000/030 (50MHz) with 18MB ram.
  135.  
  136.  
  137.  
  138. How to Use it.
  139. --------------
  140.   
  141. Click on the IOBEditor Icon. 
  142.  
  143. Initially you will be presented with a title window. Select Open from
  144. the menu or click on the Open button and select the TDDD File you wish
  145. to open. The program uses the standard ASL filerequester. 
  146.  
  147. If the TDDD File contains brushes or textures then you will be 
  148. presented with the path summary list. The List View shows all the 
  149. unique paths of textures and brushes in the file. Typically there will 
  150. only be one path displayed but if brushes and textures have been 
  151. seperated into different directories there will be more. 
  152.  
  153. The two methods for changing paths are as follows:-
  154.  
  155. 1. Globally change the paths of all Brushes and Textures.
  156. 2. Change indivdual paths of Brushes and Textures. 
  157.  
  158.  
  159.  
  160. 1. Globally change paths for all Brushes and Textures.
  161. ------------------------------------------------------
  162.  
  163. Initially you are presented with a summary of all the unique paths of 
  164. the textures and brushes assigned to the object. By changing one of 
  165. these paths you are affecting all brushes and textures which use that path.
  166.  
  167. Steps to change the path.
  168.  
  169. 1. Select the Summary Path List with the Cycle Gadget.
  170. 2. Click on the path to be changed in the Path List.
  171. 3. Click in the New Path edit box.
  172. 4. Either amend the path by retyping or use the Browse Button to select
  173.    a path with the standard ASL directory requester.
  174.    If you make a mistake then pressing the Reset Button will reset the
  175.    path back to the old one.
  176. 5. At this point only the summary info has changed the individual paths
  177.    are still the same. To save the changes click on the Save Button and
  178.    enter the object name. By default it is set to the original object
  179.    name with an extention .new. 
  180.    WARNING: DO NOT overwrite your original, you can never be sure that
  181.    something will not go wrong during a save. Make backups and check 
  182.    that the new object is as it should be before disposing of the 
  183.    original.
  184. 6. There is also an Update Button. This updates the paths in memory
  185.    ONLY so that you can go into the detailed list and change individual
  186.    paths without saving the file first.
  187.    
  188. N.B. Once the object file is saved the path list is not automatically 
  189.      updated. You will need to reload the saved object to update the
  190.      display.
  191.      
  192. PC USERS: If you want to change the path to PC format make sure the path 
  193.           contains a '\' otherwise the program assumes an Amiga path. Add 
  194.           a '\' to the end of the path if it does not contain one.
  195.  
  196.  
  197.  
  198. 2. Changing an indivdual path of a Brush or Texture.
  199. ----------------------------------------------------
  200.  
  201. This time the list box displays the Object Part Name and brush/texture
  202. name. The old path is listed under the list box as well as the new path.
  203.  
  204. Steps to change the path.
  205.  
  206. 1. Select the Detailed Path List with the Cycle Gadget.
  207. 2. Click on the brush/texture from the List box. The old path will be
  208.    displayed below.
  209. 3. Click in the New Path edit box.
  210. 4. Either amend the path by retyping or use the Browse Button to select
  211.    a path with the standard ASL directory requester.
  212. 5. To save the changes click on the Save Button.
  213.  
  214. Note that there is no Update Button because individual paths are updated
  215. in memory immediately. The Update Button is useful if you want to change
  216. all brushes and textures except one or two. You can go to the summary 
  217. path list, select the path, amend it and then click on update. This will 
  218. amend all brushes and textures with that path. Now click on the 
  219. Cycle Gadget to display the detailed list. Each brush/texture with the changed 
  220. paths will now show the altered path in the New Path Box when selected.
  221. Select the brushes/textures  which were going to remain unaltered and change
  222. them back to the old path either by retyping the path or simply pressing
  223. the Reset Button. Now click on the Save Button and select the new filename.
  224.  
  225.  
  226.  
  227. Gadgets
  228. -------
  229.  
  230.  
  231. Path Cycle Gadget  - Changes list view between a summary of brush / texture 
  232.                      paths and a detailed list of all paths for each 
  233.                      indivdual brush and texture.
  234.  
  235. Path List View       - With the Summary option this lists all the unique paths 
  236.                      used within the TDDD File. With the details option the 
  237.                      list contains the object part name and the brushes
  238.                      /textures assigned to it. The path is listed below the 
  239.                      list box when an item is selected.  
  240.  
  241. New Path Edit Box  - New path of Brush/Texture. Initially set to old path 
  242.                      from file. editable by user. 
  243.  
  244. Browse Button      - Selects a new path from a requester list. 
  245.  
  246. Reset Button       - Resets the New Path setting to the original path. 
  247.  
  248. Save Button        - Brings up save rquester to save file.
  249.  
  250. Update Button      - Updates the new path setting of individual brushes/
  251. (Summary Only)       textures in memory, so that the settings appear in the 
  252.                      Detailed list. 
  253.  
  254. Cancel Button      - Exit Program. 
  255.  
  256.  
  257.  
  258. Technical
  259. ---------
  260.  
  261. The program recognises TXT2, TXT3, TXT4, BRS3, BRS4 and BRS5 Chunks as being 
  262. the chunks in a TDDD file containing texture and brush information. All other 
  263. chunks are stored in memory and saved back out unchanged with the exception 
  264. of some size changes to the DESC chunks and TDDD header. Only the path names
  265. are changed within these chunks and therefore all other information 
  266. pertaining to the brush or texture will remain unchanged.
  267.  
  268. A new file specification is expected for the Windows 95 version of Imagine,
  269. when it is released I may consider finishing the PC version of this program
  270. and also update the Amiga one (If version 4 can read 95 files).
  271.  
  272.  
  273.  
  274. Other Information
  275. -----------------
  276.  
  277. Comments,bug reports,suggestions can be emailed to me at the following
  278. address:-
  279.  
  280. 101656.2143 @ Compuserve.com   (Darran Williams)
  281.  
  282.  
  283. Future Improvements
  284. -------------------
  285.  
  286. This program has been tested on a wide range of object files and so far 
  287. I have not hada problem except when I ran out of memory on a 1MB Amiga 1500.
  288.  
  289. The following are ideas I have on improving the program which I may
  290. implement at a later date. Other suggestions are welcome.
  291.  
  292.  
  293. Sizeable window. (Some paths are too long to be displayed in list box)
  294. Selectable Font.
  295. MUI version. 
  296.  
  297. Ability to delete brushes/textures from the object file.
  298. Ability to change the short name of Brushes/Textures. (Imagine 3.2 - 4)
  299.  
  300.  
  301.  
  302.  
  303. @EndNode
  304.