home *** CD-ROM | disk | FTP | other *** search
/ Late Night VRML 2.0 with Java CD-ROM / code.zip / Ch12 / readme.txt < prev    next >
Text File  |  1997-01-05  |  5KB  |  134 lines
  1. VermelGen Version 0.1
  2.  
  3. Copyright Justin Couch and Cameron Gillies
  4. The Virtual Light Company 1996
  5. justin@vlc.com.au
  6. csg@sg.adisys.com.au
  7.  
  8. Sections copyright Thomas Koch of GMD Germany
  9. thomas.koch@gmd.de
  10.  
  11. A GNU production.
  12. See the file license.txt for licensing conditions.
  13.  
  14. VermelGen is our attempt at producing a free VRML 2.0 editor. It is entirely
  15. written in Java and uses the External Application Interface (EAI) to talk to any
  16. VRML 2.0 capable browser that supports the EAI.
  17.  
  18. The source for this applet can be found at
  19.  
  20. ftp://ftp.vlc.com.au/pub/VermelGen/
  21.  
  22. Last updated 14:45 +10.00 5th Jan 1997
  23.  
  24. And a web page at (After the 8th Jan 1997)
  25.  
  26. http://www.vlc.com.au/VermelGen/
  27.  
  28. ---------------------------------------------
  29.  
  30. Installation
  31.  
  32. To install this program you need to have an empty directory which you then
  33. unpack the archived file into. It creates a number of subdirectories. Do not
  34. change the name of these directories unless you really know what you are doing
  35. with java.
  36.  
  37. In the top level directory (eg C:\Program Files\VermelGen\) you will need to
  38. edit the HTML file called index.html. In there you will need to change two
  39. things - the CODEBASE and top_directory parameters. These need to be changed to
  40. the directory that you installed the files into.
  41.  
  42. Once this small change is made you can start up you Java enabled browser and
  43. open the HTML file.
  44.  
  45. If you are a Netscape user on either Win95 or NT4 you must read the file
  46. NetscapeUsers.txt. It contains some very important information that about some
  47. problems experienced with there operating systems and the VRML browsers.
  48.  
  49. ---------------------------------------------
  50.  
  51. Features:
  52.  
  53. o This is a very early alpha release. It handles the most common nodes that
  54.   you will be using in VRML 2.0. At the moment this amounts to:
  55.     - Transform
  56.     - Group
  57.     - Shape
  58.     - Box
  59.     - Cylinder
  60.     - Cone
  61.     - Sphere
  62.     - Appearance
  63.     - Material
  64.     - TextureTransform
  65.     - ImageTexture
  66.     - MovieTexture
  67.  
  68. o Add and delete of supported node types. Cut and paste is not yet supported
  69.  
  70. o Browser independant. Because it uses the VRML 2.0 EAI there is no Web Browser
  71.   dependent features. This same interface also means that the software is
  72.   independent of the VRML 2.0 plugin that is used allowing you complete
  73.   flexibility.
  74.  
  75. o Will work even without a browser - ie on any Java enabled applet viewer.
  76.   The software attempts a number of different methods to grab a handle on the
  77.   VRML 2.0 browser. If none are available then it defaults to standalone
  78.   operation. All functionality is still available except you do not get output
  79.   to the Browser.
  80.  
  81. o Minimal file size generation. The editor will only write to the output the
  82.   fields that are not default values. This keeps file size to a minimum. For
  83.   readability the output is correctly indented. To further reduce file size you
  84.   can do the normal methods of using a file cruncher or gzip.
  85.  
  86. o Syntax checking. The editor will not allow you to generate a syntactically
  87.   incorrect file. It pulls you up if you try to add a node in the wrong spot.
  88.  
  89. ----------------------------------
  90.  
  91. Bugs and Notes:
  92.  
  93. - Due to the amount of initialisation at the start you might find that even after
  94.   the Editor window has popped up you will not be able to do anything. Wait for
  95.   the harddrive to stop thrashing and then try again :) On a P166/64MB this takes
  96.   about 5 - 7 seconds.
  97.  
  98. - Generating source files. At this stage I have not implemented the code to
  99.   write the VRML source out to a file. Much of this is to do with problems with
  100.   security of applets and the individual browser used. Some will not let you
  101.   write to the harddrive - even as a trusted applet. This will be coming in a
  102.   future version
  103.  
  104. - Getting started. To add your first node to the scene you will need to
  105.   click on the unknown.wrl node on in the display before doing anything. The
  106.   browser will pop up an error dialog telling you to select a node if you don't
  107.  
  108. - Resize and scrolling of the main window. There are some bugs with the resize
  109.   and display of the scroll bars in the main window. Sometimes when you resize
  110.   to smaller than the displayed error the scrollbars disappear completely! If
  111.   this happens resize the window by a very small amount until they reappear.
  112.  
  113. - Multiple string fields (in the URLs for Image/Movie Texture nodes, etc) At the
  114.   moment it only handles the first string typed in. Any after that will be
  115.   printed out as "null" in the file. You will need to remove these references
  116.   before viewing the file correctly.
  117.  
  118. - deleting a Shape node currently does not remove it from the Scene. Why? I
  119.   don't know. I'm looking into it at the moment.
  120.  
  121. Apart from that I believe the program is pretty rock solid for an alpha release.
  122. In just about every case it will stop you before you attempt to do something
  123. that has not been implemented yet. I would suggest however that you have the
  124. Java console (or whereever your Systme.out.print stuff gets shunted to) open
  125. while running the program.
  126.  
  127. As usual insert the usual legal crap in here about use of the product and no
  128. warranty yadda, yadda, yadda. Hey, you take, you try, you tell me if you like
  129. or not and any bugs.
  130.  
  131. Justin Couch & Cameron Gillies
  132. 5 Jan 1997
  133.  
  134.