home *** CD-ROM | disk | FTP | other *** search
/ Graphics Plus / Graphics Plus.iso / libs / tsipp / tsipp.rdm < prev   
Encoding:
Text File  |  1980-02-09  |  6.3 KB  |  167 lines
  1.                             === Tcl-SIPP 3.0a ===
  2.  
  3.     This package provides a Tcl command interface to the SIPP rendering
  4. program.  SIPP, the SImple Polygon Processor, is a library for creating
  5. 3-dimensional scenes and rendering them using a scan-line z-buffer algorithm.
  6. Tcl is an easy to use, powerful, interpretive programming language, that is
  7. designed to be imbeddable in applications.
  8.  
  9.     Tcl-SIPP is a set of Tcl commands used to programmed SIPP without having to
  10. write and compile C code.  Commands are used to specify surfaces, objects,
  11. scenes and rendering options.  Scenes may be rendered to files in the PPM
  12. format or in Utah Raster Toolkit RLE format.
  13.  
  14.    This interface greatly speeds the development of scenes because no compile
  15. and link phase is required.  Data is represented in a simple ASCII form.
  16. This is particularly useful when for producing 3D scenes from ASCII data
  17. generated by other programs.  Since most of the work in creating a scene is
  18. still done in libsipp, the is only a small performance cost in programming from
  19. Tcl.
  20.  
  21.  
  22. REQUIREMENTS
  23. ============
  24. The following software packages are required to build and use Tcl-SIPP:
  25.  
  26.    o SIPP 3.0 - The SImple Polygon Processor
  27.         wuarchive.wustl.edu:/graphics/graphics/packages/sipp/sipp-3.0.tar.Z
  28.         isy.lie.se:/src/sipp-3.0.tar.Z (note: this site is in Sweden)
  29.  
  30.    o Tcl 6.4 - The Tcl command language
  31.         sprite.bekerley.edu:/pub/tcl/tcl6.4.tar.Z
  32.  
  33.    o TclX6.4c - Extended Tcl, an add on package for Tcl.
  34.         sprite.bekerley.edu:/pub/tcl/tclX6.4c.tar.Z
  35.         barkley.bekerley.edu:/tcl/extensions/tclX6.4c.tar.Z
  36.  
  37.    o Utah Raster Toolkit (optional) - This tool kit is great, check it out.
  38.         cs.utah.edu:/pub/urt/urt-3.0.tar.Z
  39.         cs.utah.edu:/pub/urt/urt-3.0.patch1
  40.         cs.utah.edu:/pub/urt/urt-3.0.patch2.Z
  41.  
  42.  
  43. VERSION NUMBERING
  44. =================
  45.     The Tcl-SIPP version number is a concatenation of the SIPP library version
  46. number that it works with and a single letter indicating the Tcl interface
  47. version.  The version may also include a patch level if Tcl-SIPP has been
  48. patched.  This is Tcl-SIPP 3.0a.
  49.  
  50.  
  51. DIRECTORY STRUCTURE
  52. ===================
  53.     The following is the directory structure of the Tcl-SIPP code:
  54.   
  55.  
  56.                                   tsipp3.0a
  57.                   src   sippsrc   man   tests   demos   help
  58.  
  59. o src - The source directory containing the Tcl interface to SIPP.
  60.  
  61. o sippsrc - Code from the SIPP that has been modified for use with Tcl-SIPP.
  62.   One file is modified (libsipp/rendering.c) to support optionally processing
  63.   scan lines in the opposite direction.  This change was made to support the
  64.   RLE file format.  The file rendering.c is included in the modified form along
  65.   with a context diff.  This code has been submitted to the SIPP developers.
  66.   Also contains a fix to the libsipp function spotlight_create.
  67.  
  68. o man - Contains the Tcl-SIPP manual page.
  69.  
  70. o tests - Contains basic tests that validate the individual commands.
  71.  
  72. o demos - A port of the demo programs from SIPP.  These also server to test
  73.   Tcl-SIPP functionality not checked by the basic tests.
  74.  
  75. o help - This directory is not actually included with the distribution, but
  76.   is built.  It contains help files that can read via the Extended Tcl help
  77.   system.
  78.  
  79.  
  80. BUILDING
  81. ========
  82.     Sipp 3.0, Tcl 6.4 and Extended Tcl 6.4c should all have been built before
  83. building Tcl-SIPP.  Extended Tcl should also be installed in its configured
  84. location, if not you will need to set the TCLDEFAULT environment variable
  85. to point to the TCLDEFAULT file in the Extended Tcl build directory before
  86. running Tcl-SIPP.
  87.  
  88.     Edit "Config.mk" to set the compilation options and to point to the
  89. other packages required by Tcl-SIPP.  Follow the instructions in Config.mk
  90. carefully.
  91.  
  92.     Enter the command:
  93.  
  94.         make
  95.  
  96. to compile and link Tcl-SIPP.  This should result in an interactive Tcl
  97. interpreter being created in top-level directory called tsipp.  This program
  98. is the Extended Tcl shell with the Tcl-SIPP commands built-in.  A very minimal
  99. test is to run tsipp to see if you get an interactive prompt (tsipp>).  Use
  100. the exit command or enter an EOF to exit tsipp.
  101.  
  102.  
  103. TESTING
  104. =======
  105.     A basic set of tests to validate Tcl-SIPP is run with the command:
  106.  
  107.         make test
  108.  
  109. This will do some basic validation of the commands.  If the RLE libraries are
  110. linked into Tcl-SIPP, then the URT program `rlehdr' should be in a directory in
  111. the PATH, or some tests will fail.
  112.  
  113.  
  114. DEMOS
  115. =====
  116.     The demostration pictures are built by entering the command:
  117.  
  118.         make demo
  119.  
  120. If you built Tcl-SIPP with the RLE library, the RLE format files will be
  121. built by default.  IF RLE is not available, PPM format files will be build.
  122. The can be overridden in the Config.mk file.  Other options controlling the
  123. creation of the demo images maye be set in Config.mk.
  124.  
  125.    The programs to create these images are ports of the C programs provided
  126. with SIPP.  They are good example on how to use Tcl-SIPP.  If your generate
  127. RLE images, use the Utah Raster Toolkit program getx11 (or what ever get
  128. command is appropriate for your environment). to display them.  If you have
  129. a 256 color display instead of full color, try the following:
  130.  
  131.         cat demos/*.rle | rlequant | getx11
  132.  
  133.    A RLE comment is added to the image to specify a correct image gamma for
  134. these images.  See Utah Raster Toolkit Documentation for more details.
  135.  
  136.    If you create PPM images, use your favorite view capable of handling them,
  137. or use the PBMPlus toolkit to convert them to a format that you can view.
  138.  
  139.  
  140. BUILDING HELP FILES
  141. ===================
  142.     Extended Tcl help files may be extracted from the man page with the
  143. command:
  144.  
  145.         make buildhelp
  146.  
  147. Note that this requires nroff to be installed on your system.  To install the
  148. help files copy everything that was created under the help directory into the
  149. help directory under the directory specified by TCL_TCLDIR in your Extended
  150. Tcl Config.mk file (usually /usr/local/tcl/help).  Note that there is a bug
  151. in the current Extended Tcl buildhelp.tcl that causes all help file names
  152. to be truncated to 14 characters, even on systems that have long file names.
  153.  
  154. INSTALLING
  155. ==========
  156.     No install script currently exists for Tcl-SIPP.  Install the help files
  157. as described above.  Copy tsipp to your favorite bin directory and
  158. man/tsipp.man to the appropriate manual directory.
  159.  
  160.  
  161. AUTHOR
  162. ======
  163.    Mark Diekhans - markd@grizzly.com
  164.  
  165. Please send all bugs, questions or comments to the above address
  166.  
  167.