home *** CD-ROM | disk | FTP | other *** search
/ Otherware / Otherware_1_SB_Development.iso / amiga / video / render / radiance.lzh / ray / doc / cat1 / oconv.doc < prev    next >
Encoding:
Text File  |  1991-11-24  |  5.5 KB  |  199 lines

  1.  
  2.  
  3.  
  4. OCONV(1)                 USER COMMANDS                   OCONV(1)
  5.  
  6.  
  7.  
  8. NAME
  9.      oconv - create an octree from a RADIANCE scene description
  10.  
  11. SYNOPSIS
  12.      oconv [ -i octree | -b xmin ymin zmin size ][ -n  objlim  ][
  13.      -r maxres ][ -f ][ -w ][ - ] [ input .. ]
  14.  
  15. DESCRIPTION
  16.      Oconv adds each scene description input to octree and  sends
  17.      the result to the standard output.  Each input can be either
  18.      a file name, or a command (enclosed in quotes  and  preceded
  19.      by  a  `!').  If any of the surfaces will not fit in octree,
  20.      an error message is printed and the program aborts.   If  no
  21.      octree  is  given, a new one is created large enough for all
  22.      of the surfaces.
  23.  
  24.      The -b option allows the user to give a  bounding  cube  for
  25.      the  scene,  starting  at  xmin  ymin zmin and having a side
  26.      length side. If the cube does not contain all  of  the  sur-
  27.      faces, an error results.  The -b and -i options are mutually
  28.      exclusive.
  29.  
  30.      The -n option specifies the maximum  surface  set  size  for
  31.      each voxel.  Larger numbers result in quicker octree genera-
  32.      tion, but potentially slower rendering.  The default  number
  33.      is 5.
  34.  
  35.      The -r option specifies the maximum octree resolution.  This
  36.      should  be greater than or equal to the ratio of the largest
  37.      and smallest dimensions in the scene (ie.  surface  size  or
  38.      distance between surfaces).  The default is 1024.
  39.  
  40.      The -f option produces a frozen octree  containing  all  the
  41.      scene  information.  Normally, only a reference to the scene
  42.      files is stored in the octree, and changes  to  those  files
  43.      may invalidate the result.  The freeze option is useful when
  44.      the octree file's integrity and loading speed is more impor-
  45.      tant than its size, or when the octree is to be relocated to
  46.      another directory, and is  especially  useful  for  creating
  47.      library  objects  for the "instance" primitive type.  If the
  48.      input octree is frozen, the output will be also.
  49.  
  50.      The -w option suppresses warnings.
  51.  
  52.      A hyphen by itself ('-') tells oconv to read scene data from
  53.      its standard input.  This also implies the -f option.
  54.  
  55.      The only scene file  changes  that  do  not  require  octree
  56.      regeneration  are  modifications  to non-surface parameters.
  57.      If the coordinates of a surface are changed, or  any  primi-
  58.      tives  are  added or deleted, oconv must be run again.  Pro-
  59.      grams will abort with  a  "stale  octree"  message  if  they
  60.  
  61.  
  62.  
  63. Sun Release 4.1           Last change:                          1
  64.  
  65.  
  66.  
  67.  
  68.  
  69.  
  70. OCONV(1)                 USER COMMANDS                   OCONV(1)
  71.  
  72.  
  73.  
  74.      detect  any dangerous inconsistencies between the octree and
  75.      the input files.
  76.  
  77.      Although the octree file format is binary, it is meant to be
  78.      portable  between  machines.   The  only  limitation is that
  79.      machines with radically different  integer  sizes  will  not
  80.      work  together.   For the best results, the -f option should
  81.      be used if an octree is to be  used  in  different  environ-
  82.      ments.
  83.  
  84. DIAGNOSTICS
  85.      There are four basic error types reported by oconv:
  86.  
  87.           warning - a non-fatal input-related error
  88.  
  89.           fatal - an unrecoverable input-related error
  90.  
  91.           system - a system-related error
  92.  
  93.           internal - a fatal error related to program limitations
  94.  
  95.           consistency - a program-caused error
  96.  
  97.      Most errors are self-explanatory.   However,  the  following
  98.      internal errors should be mentioned:
  99.  
  100.      Too many scene files
  101.           Reduce the number of scene files by combining  them  or
  102.           using  calls  to  xform(1)  within  files  to  create a
  103.           hierarchy.
  104.  
  105.      Set overflow in addobject (id)
  106.           This error occurs when  too  many  surfaces  are  close
  107.           together  in  a  scene.  Sometimes a dense scene can be
  108.           accomodated by increasing the  maximum  resolution  (by
  109.           powers  of  two)  using the -r option, but usually this
  110.           error indicates something is wrong.   Either  too  many
  111.           surfaces  are  lying right on top of each other, or the
  112.           bounding cube is inflated from an oversized  object  or
  113.           an improper -b specification.  Chances are, the surface
  114.           "id" is near one of those causing the problem.
  115.  
  116.      Hash table overflow in fullnode
  117.           This error is caused by too many surfaces.   If  it  is
  118.           possible  to  create an octree for the scene at all, it
  119.           will have to be done in stages using the -i option.
  120.  
  121. EXAMPLE
  122.      To add book1, book2 and a transformed book3  to  the  octree
  123.      ``scene.oct'':
  124.  
  125.        oconv -i scene.oct book1 book2 '\!xform -rz  30  book3'  >
  126.  
  127.  
  128.  
  129. Sun Release 4.1           Last change:                          2
  130.  
  131.  
  132.  
  133.  
  134.  
  135.  
  136. OCONV(1)                 USER COMMANDS                   OCONV(1)
  137.  
  138.  
  139.  
  140.        newscene.oct
  141.  
  142. AUTHOR
  143.      Greg Ward
  144.  
  145. NOTES
  146.      In the octree, the names  of  the  scene  files  are  stored
  147.      rather  than  the  scene information.  This means that a new
  148.      octree must  be  generated  whenever  the  scene  files  are
  149.      changed  or moved.  Also, an octree that has been moved to a
  150.      new directory will not be able  to  find  scene  files  with
  151.      relative  pathnames.   The  freeze option avoids these prob-
  152.      lems.  Make(1) can be used to automate octree  creation  and
  153.      maintenance.
  154.  
  155. SEE ALSO
  156.      getbbox(1),   getinfo(1),   make(1),   rpict(1),   rview(1),
  157.      rtrace(1), xform(1)
  158.  
  159.  
  160.  
  161.  
  162.  
  163.  
  164.  
  165.  
  166.  
  167.  
  168.  
  169.  
  170.  
  171.  
  172.  
  173.  
  174.  
  175.  
  176.  
  177.  
  178.  
  179.  
  180.  
  181.  
  182.  
  183.  
  184.  
  185.  
  186.  
  187.  
  188.  
  189.  
  190.  
  191.  
  192.  
  193.  
  194.  
  195. Sun Release 4.1           Last change:                          3
  196.  
  197.  
  198.  
  199.