home *** CD-ROM | disk | FTP | other *** search
/ ProfitPress Mega CDROM2 …eeware (MSDOS)(1992)(Eng) / ProfitPress-MegaCDROM2.B6I / GRAPHICS / MISC / 3D110.ZIP / 3D.DOC < prev    next >
Encoding:
Text File  |  1991-02-23  |  12.4 KB  |  238 lines
  1.  3D environment program documentation   : 3D.DOC
  2.  LAST UPDATE                            : Feb 23, 1991.
  3.  RELEASE No.                            : 1.10
  4.  
  5.  
  6.                                   WHAT'S NEW
  7.                                   ----------
  8.  
  9.   - Version 1.10 offers a better heap memory managment routine, VGA users
  10.    will not face the "Out of memory" message so frequently as did 
  11.    Version 1.00 users.
  12.  
  13.   - PC3270, 8514 and AT&T graphic users will need to use BGI drivers from
  14.    TP5.5, these drivers are no longer included in the code.
  15.  
  16.   - The source files required by the generated "Compiled" files are now
  17.    available within 3D110.
  18.  
  19.                                  INTRODUCTION
  20.                                  ------------
  21.  
  22.   This is the first documentation file to 3D, a WWToolKit demo application,
  23.  by Loewy Ron (LR) and Ishai Ben-Aroya (IBA), 1990 - 1991, This program is
  24.  released to the public domain, 1990, 1991.
  25.  
  26.  
  27.   The distribution file 3D110 contains the following files :
  28.  
  29.         3D.EXE          - 3D object code.
  30.         3D.HLP          - 3D on-line help file.
  31.         README.WWT      - WWToolKit description.
  32.         3D.DOC          - This file.
  33.         *.M3D           - 3D macro files.
  34.         *.3D2           - Simple 3D object definition files.
  35.         *.3DS           - Complex 3D object definition files.
  36.         *.PAS           - Units required by the generated "compiled macros".
  37.  
  38.   Please notice :
  39.  
  40.   The 3D source files (except WWToolKit sources) are available in the
  41.  3D110SRC archive file, if you want to try and compile te 3D program,
  42.  you will need the WWT10TPU archive file - for the WWToolKit units,
  43.  and probably also the WWT10DOC archive file, that contains documents
  44.  to these units.
  45.  
  46.  
  47.                                   What is 3D ?
  48.                                   ------------
  49.  
  50.   3D is an environment program that uses the WWToolKit GUI, to enable the
  51.  design, creation, study and use of 3D objects in a 3D object space, the
  52.  program includes a Graphic editor, an On-line test module, a graphic
  53.  based Text Editor, an animation macro language Interpreter, a macro to
  54.  Pascal compiler (translator), and (available separately in the 3D110SRC file)
  55.  Pascal library files, to create stand alone animation executables, from the
  56.  Pascal code created by the compiler.
  57.  
  58.  
  59.                                 User Interface 
  60.                                 --------------
  61.  
  62.   3D uses the WWToolKit GUI, the user interface is documented in the 
  63.  TOOLKIT.DOC file, in the WWT10DOC archive file, basically, this is a
  64.  windowed, menu - driven, mouse (and keyboard, if a mouse is not present)
  65.  desktop environment, The top of the screen (Desktop) contains the main 
  66.  program menu, from which drop down windows can be opened (using the mouse
  67.  or the F10 key on keyboard only systems) to choose (point and release)
  68.  program options, the desktop contains application windows, with a top
  69.  (active) window, by pointing with the mouse (or using the F6 key in keyboard
  70.  systems) - you can bring a window to the top of the desktop. A window may
  71.  contain controls (buttons), option lists, or other action elements. If the
  72.  application needs a response from the user it will open a dialogue-box, a 
  73.  non-removable window, that waits for some input from the user. Normal 
  74.  ( well.. market common ) conventions are used - re-sizing through the
  75.  bottom-right grow box (F9), closing through the top-left close box (F3), 
  76.  dragging - in the header line (Alt-F9), choosing by clicking, or 
  77.  double-clicking, as needed. Please notice - because this program was used to 
  78.  compile, develope and test the WWToolKit library, the right mouse button is 
  79.  used to terminate the program!.
  80.  (This item is discussed in the TOOLKIT.DOC file, in the WWT10DOC archive 
  81.  file). If you do not have access to the WWT10DOC file, you can get basic
  82.  explanation, by using the 3D on-line help windows, open a help window by
  83.  choosing a topic from the help menu, and double click on underlined items
  84.  of interest - to receive hyper-text help about the 3D program and user
  85.  interface.
  86.  
  87.  
  88.                                    OBJECTS
  89.                                    -------
  90.  
  91.   3D objects supported by the 3D program are wire-mesh objects, 
  92.  (no solid objects support in this version), there are 2 object types
  93.  defined by 3D - simple objects : wire mesh points and lines, and 
  94.  complex objects : sets of simple objects, with a common frame of reference.
  95.  3D defines an "active" object, all of the 3D object operations are performed
  96.  on this object, to set the "active" object - choose from the list created by
  97.  the ACTIVE option in the objects menu. Please notice - clicking on an 
  98.  object's edit window, loading an object, or testing it in the on-line
  99.  window automatically brings it to the top of the object list, and makes
  100.  it the "active" object. Use the LOAD option in the object menu to load an
  101.  object from disk to memory, please notice - simple objects are saved in
  102.  OBJNAME.3D2 files, while complex objects are saved in OBJNAME.3DS files.
  103.  When you load an object, no window is opened, choose the EDIT option in 
  104.  the objects menu to open a graphic editor window for the object. 
  105.  (notice that a simple object has 2 types of editors - points, and lines
  106.  editors). Use the NEW option from the objects menu to create new objects.
  107.  Please refer to the on-line help facility, or to the technical documentation
  108.  in the 3D110SRC archive file, objects are defined in the OBJECT3D.PAS,
  109.  SUPEROBJ.PAS, RTOBJ.PAS files, graphic editors are defined in the 
  110.  LINEWIND.PAS, PNTWIND.PAS and SEDTWIND.PAS files in the 3D110SRC archive.
  111.  
  112.  
  113.                                     MACROS
  114.                                     ------
  115.  
  116.  
  117.   Macros are 3D scripts that animate (used to create animation) 3D objects,
  118.  the macro language is described in the on-line help macros topic, and can be
  119.  found also in the technical documentation, and source files in the 
  120.  3D110SRC archive file. Use the 3D built in Text Editor, or any plain
  121.  ASCII text editor of your choice - to create macro files, 3D macro files
  122.  should carry the .M3D extension. (e.g. BOX3MV.M3D), use the macro menu
  123.  to manipulate the Text Editor text files. The run menu offers the 
  124.  INTERPRET option, that opens a window, and displays the animation
  125.  sequence defined in the "active" macro, (please refer to the objects "active"
  126.  description - the "active" macro has the same meaning for macro files), 
  127.  the macro can be debugged, and developed using the Text Editor, and the
  128.  INTERPRET option, use the COMPILE option from the run menu to create a 
  129.  Pascal source code, ready to be (Turbo - Pascal) compiled into a stand alone
  130.  3D animation EXE file. The macro text-editor is defined in the MCRWIND.PAS
  131.  file, and is a derived object of the TEXTWINDOW object of the WWToolKit
  132.  window, the macro language interpreter, and compiler are documented in the
  133.  INTERPER.PAS and CMPL3D.PAS - in the 3D110SRC archive file, some more 
  134.  animation consideration topics can be found in the PROJECT3.PAS, PRJWIND.PAS
  135.  and CTM3D.PAS files.
  136.  
  137.  
  138.                                    WARRANTY
  139.                                    --------
  140.  
  141.  
  142.       There is no warranty what-so-ever, this package is supplied as is,
  143.     and the authors  will not  be responsible  for  any  lost  profits, 
  144.     inconveniences or other damages caused by the use of or inability to 
  145.     use this package. We do however state that we hope we will be able to
  146.     eliminate most bugs and performance drawbacks during the development
  147.     of the package.
  148.  
  149.  
  150.  
  151.                                    CONTACT
  152.                                    -------
  153.  
  154.  
  155.  
  156.       Contact :                 
  157.  
  158.         Loewy Ron,                      Ben-Aroya Ishai
  159.         9 Haneveem st.,         or      48-A Harofe St.
  160.         Herzeliya, 46465                Haifa
  161.         ISRAEL.                         ISRAEL.
  162.  
  163.  
  164.                                     History
  165.                                     -------
  166.  
  167.  
  168.   The 3D program had been written several times, before this ("version 1.10")
  169.  was released to the public domain, The first 3D design, creation and test
  170.  program was created by LR, on an Apple //e, in 1984, written in BASIC,
  171.  some help from Paluda Oded (PO) - in mathematical definitions - was used
  172.  to create the 2.nd Apple implementation - that introduced the macro idea,
  173.  used self center of gravity to create relational frames, and used a basic
  174.  compiler (OOWWAOO) - to achieve faster execution time. LR used Turbo-Pascal
  175.  version 3.01, with the GRAPHIX TOOLBOX to learn Pascal and PC programming,
  176.  in 1988, the result 3D program was never released, and supported only
  177.  integer math, keyboard interface, and HGC graphic adapter. (No CGA version 
  178.  pal, sorry). With Turbo-Pascal 4.0 a new - BGI version was created by LR,
  179.  and was renamed THREE_D, this version still used keyboard interface, however
  180.  the window system did not use the GRAPHIX TOOLBOX, THREE_D version 1.10
  181.  replaced the integer math, with a real math version, and version 1.20
  182.  introduced (along with Turbo-Pascal 5.0) the macro to Pascal compiler.
  183.  Versions 1.23 to 1.25 were for a short time distributed in the U.K. as a
  184.  shareware product. From FEB 1990, IBA joined LR to rewrite the entire
  185.  3D program (renamed again to 3D) using OOPS technology, and Turbo-Pascal 5.5,
  186.  The new 3D program was used as a test bed to the new LR & IBA developed
  187.  GUI - WWToolKit. Because the 3D program was big enough, and complex enough
  188.  to test and build most of the ideas in the WWToolKit library, many WWToolKit
  189.  files still carry the something3D name, (like the WINDOW3D window unit file).
  190.  This version was re-worked, and released as version 1.00 on SEP 1990. Minor
  191.  changes to the WWToolKit library were made during OCT, and NOV 1990, and the
  192.  3D program had to wait for the documentation file (this file), before
  193.  it could be released to BBS, and FTP sites. Some users complained about VGA
  194.  systems that crashed because of lack of memory, version 1.10 improves this
  195.  situation by using a smarter heap managment error routine, that will lead 
  196.  to slower window re-draws, but will consume less memory. This fix is 
  197.  acceptable because 3D 1.00 was written on a 10 MHz XT machine with a HGC
  198.  card, and needed any bit of performance it could get, if you use an XT
  199.  machine with a VGA display - you are in trouble, however, any AT or 386
  200.  machine will perform resonably. (My 286 AT and 386-33 AT run this version
  201.  fast enough).
  202.  A Macintosh version was written by LR during 1989, using .. Turbo-Pascal, 
  203.  but was never debugged to be considered anything more then a test project.
  204.  
  205.  WWToolKit is a copyright of Loewy Ron & Ishai Ben-Aroya.
  206.  PC is a trademark of International Business Machines.
  207.  Apple, Apple //e and Macintosh are trademarks of APPLE Computer Inc.
  208.  Turbo-Pascal (V3.0, 4.0, 5.0, 5.5) and GRAPHIX TOOLBOX are copyrights and
  209.   trademarks of BORLAND INTL'. LTD.
  210.  
  211.  Other products or registered names mentioned are trademarks, or copyrights
  212.  of their respective trademark/copyright holders/owners.
  213.  
  214.  
  215.      ██      ∙          ██      ██                 ██          ∙
  216.     ▓▓█                ▓▓█     ▓▓█   ∙           ▓▓█      ∙
  217.    ▒▒▓█    ∙    ∙     ▒▒▓█    ▒▒▓█               ▒▒▓█    ∙          ■
  218.   ░░▒▓██      ███    ░░▒▓█   ░░▒▓██      ███    ░░▒▓█         ∙
  219.   ░░▒▓▓█     ▓▓▓█    ░░▒▓█   ░░▒▓▓█     ▓▓▓█    ░░▒▓█   ∙
  220.   ░░▒▒▓██   ▒▒▒▓██  ░░▒▓█    ░░▒▒▓██   ▒▒▒▓██  ░░▒▓█               ·    ■
  221.    ░░▒▓▓██ ░░░▒▓▓██ ░░▒▓█     ░░▒▓▓██ ░░░▒▓▓██ ░░▒▓█                        ·
  222.    ░░▒▒▓▓█░░▒░░▒▓▓█ ░░▒▓█     ░░▒▒▓▓█░░▒░░▒▓▓█ ░░▒▓█   ·      ·
  223. ∙   ░░▒▒▓░░▒▓█░░▒▓▓░░▒▓█       ░░▒▒▓░░▒▓█░░▒▓▓░░▒▓█
  224.      ░░▒░░▒▓█  ░░▒░░▒▓█         ░░▒░░▒▓█  ░░▒░░▒▓█
  225.       ░░░▒▓█    ░░░▒▓█          ░░░▒▓█    ░░░▒▓█          ·               ·
  226.                                                       ·
  227.   ∙                                                           ·
  228.                   ∙                ·         ·                   ·
  229.                               ·            ▀▄▀▄▀▄ ·   ▀▄▀▄▀▄              ·
  230.     ∙                                            ▄▀    ▀▄    ▀▄  ·
  231.                               ·        ·        ▀▄   · ▀▄  · ▀▄         ·
  232.            ·       ∙             ·           ▄ ▄ ▄▀    ▀▄ ▄ ▄▀
  233.                        ∙      ·             ▀ ▀ ▀      ▀ ▀ ▀
  234.         ·     ·                            ·          · ·          ·  ·
  235.                           ∙                       ·
  236.     · The 3D environment program. ·                    ·        ·
  237. 
  238.