home *** CD-ROM | disk | FTP | other *** search
/ NEXT Generation 27 / NEXT27.iso / pc / demos / emperor / dx3.exe / DOCS / README / CONV3DS.TXT next >
Text File  |  1996-07-08  |  6KB  |  171 lines

  1. conv3ds
  2. -------
  3.  
  4. conv3ds converts 3ds models produced by Autodesk 3D Studio and other
  5. modelling packages into X Files. By default it produces binary X files
  6. with no templates.
  7.  
  8.  
  9. How to use it
  10. -------------
  11.  
  12. At its simplest you can run it with no options and it will (endeavour) to
  13. produce an X file containing a hiearchy of frames. For example:
  14.  
  15. conv3ds file.3ds 
  16.  
  17. will produce an X File file.x. Use Frame::Load to load the frame.
  18.  
  19. If the 3ds file contains key frame data then you can produce an X file
  20. which contains an animation set using the -A option. For example:
  21.  
  22. conv3ds -A file.3ds
  23.  
  24. Use AnimationSet::Load to load the animation.
  25.  
  26. If you want to make an X file containing a single mesh made from all the 
  27. objects in the 3ds file then use the -m option.
  28.  
  29. conv3ds -m file.3ds
  30.  
  31. Use MeshBuilder::Load to load the mesh.
  32.  
  33.  
  34. Other useful options
  35. --------------------
  36.  
  37. * The -T option will wrap all the objects and frame hierarchies in a single
  38. "toplevel" frame. This enables you to load all the frames and objects in
  39. the 3ds file with a single call to Frame::Load, using the default options
  40. (ie. Load the first toplevel frame hiearchy in the X file). The frame 
  41. containing all the other frames and meshes is called "x3ds_filename" 
  42. (without the .3ds extension). When used with the -m option this option has
  43. no affect.
  44.  
  45.  
  46. * The -s option allows you to specify a scale factor for all the objects
  47. converted in the 3ds file. For example 
  48.  
  49. conv3ds -s10 file.3ds
  50.  
  51. will make all the objects 10 times bigger, and
  52.  
  53. conv3ds -s0.1 file.3ds 
  54.  
  55. will make all the objects 10 times smaller
  56.  
  57.  
  58. * The -r option reverses the winding order of the faces when the 3ds file is
  59. converted. If after converting the 3ds file and viewing it in D3D, the object
  60. appears "inside-out" try converting it with the -r option. All Lightwave
  61. models (see notes below) exported as 3ds files will need this option.
  62.  
  63.  
  64. * The -v option turns on verbose output mode. Specifiy an integer with it.
  65. The only useful (currently) integers are: 
  66.   -v1, print out warnings about bad objects and general information 
  67.        about what the converter is doing 
  68.   -v2, print out basic keyframe information, objects being included in the
  69.        conversion process, and information about the objects while being saved.
  70.   -v3, very verbose (mostly useful for debugging) information.
  71.  
  72. The default is -v0.
  73.  
  74.  
  75. * The -e option allows you to change the extension for texture map files. For
  76. example:
  77.  
  78. conv3ds -e"ppm" file.3ds
  79.  
  80. and file.3ds contains objects which reference the texture map file brick.gif,
  81. the X file will reference the texture map file brick.ppm. The converter does
  82. not convert the texture map file. The texture map files must also be in the
  83. D3DPATH when the resulting X File is loaded.
  84.  
  85. * The -x option forces conv3ds to produce a text X file, not a binary
  86. X file. Text files are larger but can be hand edited easily.
  87.  
  88. * The -X option forces conv3ds to include the D3DRM X File templates in
  89. the file. By default the templates are not included.
  90.  
  91.  
  92. Other options
  93. -------------
  94.  
  95. * The -t option specifies that the X File produced will not contain texture
  96. information.
  97.  
  98. * The -N option specifies that the X file produced will not contain Normal
  99. information. All the D3DRM Load calls will generate normals for objects
  100. with no normals in the X file.
  101.  
  102. * The -c option specifies that the X file produced should not contain
  103. texture coordinates. By default if you use the -m option the outputted mesh
  104. will contain 0,0 uv texture coordinates if the 3ds object had no texture
  105. coordinates.
  106.  
  107. * The -f option specifies that the X file produced should not contain any
  108. FrameTransformMatrix.
  109.  
  110. * The -z and -Z options allow you to adjust the alpha face color value of 
  111. all the  materials referenced by objects in the X File. 
  112. This is best illustrated with an example:
  113.  
  114. conv3ds -z0.1 -Z0.2 file.3ds 
  115.  
  116. says add 0.1 to all alpha values under 0.2. And
  117.  
  118. conv3ds-z"-0.2" -z1 file.3ds
  119.  
  120. says subtract 0.2 from the alpha values for all alphas.
  121.  
  122. * The -o option allows you to specify the filename for the .X File produced.
  123.  
  124. * The -h option tells the converter not to try to resolve any hiearchy
  125. information in the 3ds file (usually produced by the keyframer). Instead all
  126. the objects (when the converter is not used with the -m option) are outputted
  127. in toplevel frames.
  128.  
  129.  
  130. 3ds file produced from lightwave objects
  131. ----------------------------------------
  132.  
  133. There are a number of issues with 3ds files exported by the trans3d
  134. plugin for lightwave. These are best handled using the following
  135. options to conv3ds.
  136.  
  137. conv3ds -r -N -f -h -T|m trans3dfile.3ds
  138.  
  139. All the 3ds objects which we've come across produced by trans3d and the
  140. lightwave object editor need their winding order reversing (otherwise they
  141. appear "inside-out" when displayed) and contain no normal information.
  142.  
  143.  
  144. Hints and Tips
  145. --------------
  146.  
  147. Some of these are pretty obvious but are probably worth saying anyway.
  148.  
  149. If, after loading an object produced by conv3ds into the D3DRM viewer,
  150. you can't see the object then try using the -s object
  151. with an integer of say, 100, to increase the X file objects scale.
  152.  
  153.  
  154. If, after loading the object into the viewer and switching from flat
  155. shading into Gourard shading the object turns dark grey try converting 
  156. with the -N option. 
  157.  
  158. Textures can be the biggest problem. If after converting the object the
  159. textures don't get loaded then make sure that the object is referencing
  160. either .ppm or .bmp files (using the -e option), make sure the textures
  161. width and height is a power of 2, and make sure the textures are stored 
  162. in one of the directories in your D3DPATH.
  163.  
  164.  
  165. Known bugs and problems
  166. -----------------------
  167.  
  168. Currently conv3ds can't handle dummy frames used in 3ds animations. 
  169. It just ignores them (but will convert any child objects).
  170.  
  171.