home *** CD-ROM | disk | FTP | other *** search
/ Club Amiga de Montreal - CAM / CAM_CD_1.iso / files / 229.lha / XObj_v1.1 / XObj.doc < prev    next >
Text File  |  1989-04-09  |  8KB  |  200 lines
  1. ***************************************************************
  2.  
  3.     XOBJ - An "ObjectWare" program.
  4.     
  5.     (c) Copyright 1988, 1989. Phil Camp.
  6.     This program may be freely redistributed under the 
  7.     following conditions;
  8.       1) This file is included with the program.
  9.       2) The program is not described as Public Domain.
  10.       3) No profit is directly made from its sale.
  11.      
  12. *************************************************************
  13.  
  14. Version history:
  15.  
  16.     1.10a : Added Sculpt 3D file conversion
  17.         Changed Videoscape scaling factor
  18.     1.01a : Fixed bug causing small objects to be distorted.
  19.         Added CLI support.
  20.     1.00a : Initial version.
  21.      
  22. *************************************************************
  23.  
  24. XObj?:
  25.  
  26. What is it?.....
  27.  
  28. XObj is a handy utility to convert 3D objects from VideoScape 3D file
  29. format or Sculpt 3D file format into Turbo Silver object files.
  30.  
  31. Why is it?......
  32.  
  33. If you are, like me, not skilled in the art of designing and producing
  34. 3D objects for your Turbo Silver pictures, you will find there are a lot
  35. of cheaply or even freely available objects for use with VideoScape 3D or
  36. Sculpt 3D. I wrote this program to enable me to tap this supply of objects
  37. and use them in Turbo Silver.
  38.  
  39. How much is it?......
  40.  
  41. Its FREE (well it costs no money!). I have devised a new support scheme for
  42. XObj. XObj is not Public Domain, its not ShareWare (its not even BeerWare),
  43. its...........   OBJECTWARE!!!. To become a offical owner of XObj all you 
  44. have to do is provide me with any objects you might have. Objects 
  45. can be donated in two ways; 1) An object that I can release into the
  46. Public Domain. I hope to build a library of PD objects that will be of
  47. use to all Turbo Silver users. 2) A private object that you do not want to
  48. see redistributed, but you would not mind me playing with. 
  49.  
  50. In return for these objects you will be registered as an offical owner
  51. of XObj. If there is enough support I will continue to develop programs
  52. and utilities for use with the various 3D packages. In addition you can
  53. obtain the source of XObj for a minimal fee.
  54.  
  55. How does it work....
  56.  
  57. XObj can be run from either the CLI or workbench. Please note; the program
  58. requires the ARP library to be in your 'libs' directory as it uses this
  59. library for the file requester. XObj is very simple to use, it can be
  60. run in two basic ways;
  61.  
  62. 1) From the CLI with two filename arguments. The first filename is the
  63. object file to read, the second is the filename to write the
  64. Turbo Silver object onto (eg. "XObj MyObject.geo MyObject.obj" reads from
  65. MyObject.geo and writes to MyObject.obj). XOBJ automatically detects which
  66. file type the input file is.
  67.  
  68. 2) From the workbench or CLI with no arguments. XObj will use the file 
  69. requestor to determine the filenames. A file requester should
  70. appear asking for the input object's file name. Enter or select
  71. the required file. Next XObj will put up another file requester that will
  72. ask for the Turbo Silver file you want it to write. Either select an existing
  73. file or type in a new filename. XObj will then convert the file.
  74.  
  75. Whats all this stuff on the screen?.....
  76.  
  77. XObj gives you some status and stats on the object being converted. These
  78. include stats on the size of the object and the size of the resultant
  79. Turbo Silver object. When reading data XObj puts a '.' on the screen 
  80. every 10 points or polygons. This can help you locate errors in the 
  81. input file.
  82.  
  83. How do I use the resultant file?.....
  84.  
  85. When in Turbo Silver, simple select the 'LOAD' menu item from the Settings
  86. menu. This will load the object. You can then rotate/scale/manipulate the
  87. object using the obejct editors commands.
  88.  
  89. Sounds good. What cant it do?.......
  90.  
  91. XObj does have limitations (dont all free programs!). 
  92.  
  93. 1) Limits on the complexity of the object. Currently (1.10a) XObj can
  94. only convert objects within the following constraints;
  95.   a) The input object cannot contain more than 2700 points.
  96.   b) The V3D object cannot contain more than 5300 polygons.
  97.   c) The resultant TS object file cannot contain more than 8000 edges.
  98.   d) The resultant TS object file cannot contain more than 5000 edges.
  99. These are limitations, but you will find that not many objects are that
  100. big!. Because the V3D files are stored in text form it is simple to split
  101. objects should you need to.
  102.  
  103. 2) Complex polygons. V3D is a polygon based 3D package while all the ray
  104. tracing packages are based on Triangles. XObj can only handle polygons
  105. that have 3 or 4 vertices. You will find that 95% of all polygons out there
  106. fit into this system, those few complex polygons can be simply converted
  107. by hand. If you have Modeler 3D you can simply use the 'Statistics' window
  108. to select polygons with more than 4 vertices, then use the 'Polygon Split'
  109. command on them until they are comprised of a number of simple polygons.
  110. Or you can just remove them from the object then use Turbo Silver's editor
  111. to redo them on the converted objects.
  112.  
  113. 3) XObj will not handle the new binary format V3D files. Dont worry all the
  114. commercial object disks give you them in text format.
  115.  
  116. What about errors?......
  117.  
  118. XOBJ trys to detect any errors while processing the files and will issue
  119. informative messages. Below is a list of error messages and their meanings,
  120. many indicate a bad input object format:
  121.  
  122. ** Bad input number.        An integer number in the V3D file is illegal.
  123. ** Bad input FRACT high.        The whole portion of a real number is illegal.
  124. ** Bad input FRACT low.        The fractional part of a real number is illegal.
  125. ** Warning: missing edge.    The Sculpt 3D object contains a face that has
  126.                 an edge missing.
  127. Too many points/edges/faces.    The input object is too complex.
  128. Object has no points!.        The input object has no points.
  129. ** Polygon has no vertices?!.   A V3D polygon has no vertices.
  130. ** Two point poly skipped.    A V3D 2 point polgon (a line) has been 
  131.                 skipped. Turbo Silver can only draw faces not lines.
  132. polygon has too many vertices.  A V3D polygon has more than 4 vertices.
  133. ** EOF hit skipping details.    End of file reached reading V3D details section.
  134. surface details skipped.    Turbo Silver cannot fraw V3D surface details.
  135. object contains no data?!.    No polygons or faces found in object.
  136. File is not correct format.    Input file is not Videoscape or Sculpt 3D format.
  137. ** Cannot open file.        Input file not available for reading.
  138. ** Cannot create file.        Output file nor available for writing. 
  139.  
  140. Any other tips?......
  141.  
  142. Some objects can be a bit small when imported into TS. Use the TS object 
  143. editor to enlarge them. NB. I have noticed that some objects are VERY
  144. small!.
  145.  
  146. Colors. XObj sets each face of the TS object to the correct color as
  147. defined in the V3D file. DONT change the color of the object using the
  148. TS attribute requester or you will modify ALL the faces on the object.
  149.  
  150. When converting Sculpt objects XOBJ converts the entire scene file
  151. into one Turbo Silver object. I got the minimum info on the Sculpt
  152. file format from a transactor article but have been unable to get
  153. a full file spec. Until I can get the full spec, XOBJ only converts
  154. the points and faces. XOBJ discards the Sculpt edges as its faster
  155. to recreate them rather than perform the translation.
  156.  
  157.  
  158. ***********************************************************************
  159.  
  160. ObjectWare registration;
  161.  
  162. 1) Place any objects you wish to donate on a standard Amiga 3.5 inch
  163. disk. Please do not send commercial objects, this would be a violation
  164. of their copyright. 
  165.  
  166. 2) Indicate which objects are PRIVATE (for my use only) and which are
  167. PUBLIC DOMAIN.
  168.  
  169. 3) If you wish to obtain the source to XObj (its in M2S M2Sprint Modula-2)
  170. enclose $5 (or a rough conversion) in funds to cover postage etc. 
  171. Please do not send personal cheques in anything other than pounds sterling,
  172. they cost more than $5 to get cashed in the UK.
  173.  
  174. 4) Enclose you name and address.
  175.  
  176. 5) Send either Air or Surface mail to;
  177.  
  178.    Phil Camp
  179.    ObjectWare
  180.    48 Alma Vale Road
  181.    Clifton
  182.    Bristol BS8 2HS
  183.    United Kingdom.
  184.    
  185. *************************************************************************
  186.  
  187. Credits;
  188.  
  189. My thanks to Stan and Impulse people for releasing the Turbo Silver file
  190. format into the public domain, and for the wonderful Turbo Silver product.
  191.  
  192. Turbo Silver is a trademark of Impulse Inc.
  193. Sculpt 3D is a trademark of Byte by Byte.
  194. VideoScape 3D and Modeler 3D are trademarks of Aegis.
  195.  
  196. Phil Camp, 08-Mar-89.
  197. BIX: philc
  198. CIS: 76004,2054
  199.  
  200.