home *** CD-ROM | disk | FTP | other *** search
/ Virtual Reality Homebrewer's Handbook / vr.iso / claywork / help.txt < prev    next >
Text File  |  1996-03-19  |  9KB  |  311 lines

  1. ^UClayWorks on-line help.^U
  2.  
  3. Topics:
  4.  
  5. i.   Basics/General info..
  6. ii.  Drawing functions..
  7. iii. File Functions..
  8. iv.  Selection/editing functions..
  9. v.   Memory..
  10. iv.  Credits & contact info..
  11.  
  12.  
  13. ^uBasics/General info..^u
  14.  
  15. Drawing in 3d can be tricky, in
  16. writing Clay, I have tried to
  17. make it as as easy as possible.
  18. On startup you have a display
  19. showing a menubar along the top
  20. of the screen, a palette of
  21. drawing tool icons (also accesable
  22. using the 'edit' menu), a palette
  23. box (double click on a colour to
  24. edit it) and a central display
  25. containing 4 windows. These show
  26. the object as you are editing it
  27. and all but the perspective
  28. window (bottom-right) can be used
  29. to create new shapes.
  30. A range of function specific to
  31. the current drawing mode will
  32. appear at the top of the screen.
  33. The perspective window can show
  34. objects in several drawing modes
  35. from plain dots to gouraud shading,
  36. all in realtime. Surfaces are only
  37. visible in this window, the editing
  38. window just views the wireframe
  39. representation.
  40.  
  41. The first tool you must master is
  42. the 3d cursor. This is visible in
  43. all 4 windows as a red cross. To
  44. move it, hold down the right mouse
  45. button in any of the 3 editing
  46. windows and move the mouse around.
  47. The cursor will follow the movement
  48. in all of the windows. The 3
  49. editing windows show the object flat
  50. along a 2d-plane and are therefore
  51. missing one dimension each, the
  52. cursor is used to make up for that
  53. missing dimension. For example,
  54. select the drawing mode 'Square'.
  55. To draw a square you must click and
  56. drag the mouse in any of the editing
  57. windows. Try this and then try to
  58. move the cursor so that it at a
  59. 'deeper' position. Now draw another
  60. square in the same plane as before.
  61. That is all you need to do to draw
  62. in 3d.
  63.   The other basic tool is the select
  64. tool. The icon for this is the
  65. little mouse cursor in the top-left
  66. of the tool box. Try clicking on a
  67. node (the white squares inbetween
  68. the lines), holding down the mouse
  69. and draging it around. 
  70. Now try draging a box over a number
  71. of nodes. A bounding box should appear.
  72. You can use this to move, resize and
  73. copy selected nodes, lines and surfaces.
  74. To make a copy of the selected items
  75. simply move the box and click the right
  76. button as well as the left, you should
  77. leave a copy under the mouse cursor.
  78. There are 3 different selection modes:
  79. move/resize, rotate and deform. Select
  80. these different modes using the list
  81. displayed at the top of the screen.
  82. If you click on 'extrude' then when you
  83. copy a selection, lines and surfaces will
  84. connect between the old selection and the
  85. copy. The box containing a number donates
  86. the amount of copies you create in one
  87. use of the copy function.
  88. You can make multiple selections by
  89. holding down 'Alt' when selecting and to
  90. select only a subset of the current
  91. selection, hold down 'Ctrl' (that has no
  92. effect when nothing is selected).
  93.   Another point to node is that the
  94. centre of the editing space is shown by
  95. a red 'X'.
  96.  
  97. ^uDrawing Functions^u
  98.  
  99. ^uSquare:^u
  100. Simply click and drag in any of the editing
  101. windows. The surface of the square is
  102. realized as a double sided polygon in the
  103. current foreground colour.
  104.  
  105. ^uCube:^u
  106. Draw as above. The depth of the cube is 
  107. taken from the width. All polygons are
  108. single sided.
  109.  
  110. ^uDot:^u
  111. Simply creates a single node with no
  112. polygon or wireframe connections.
  113.  
  114. ^uLine:^u
  115. Not yet implemented.
  116.  
  117. ^UCone:^u
  118. Creates a cone with a base (all
  119. polygons are single sided, if you go
  120. inside the cone you will not see surfaces,
  121. see 'Selection/editing functions..' to find
  122. out how to make surfaces double sided).
  123. The base can be any equalatrial polygon
  124. with 3 to 30 sides.
  125.  
  126. ^uCircle^u
  127. Not actually a circle but again, an
  128. equalatrial polygon with 3 to 30 sides.
  129. Surface is double sided as default.
  130.  
  131. ^uSphere^u
  132. The number selector controls the amount
  133. of segements and the number of sides on
  134. each segment of the spherical shape.
  135.  
  136. ^uRoted form^u
  137. You need to make a selection first.
  138. You can then draw a circle using the
  139. current selection as a 'brush'.
  140.  
  141. ^uGrid^u
  142. Creates a grid with the X and Y counts
  143. specified using the two number box's.
  144.  
  145. ^uText^u
  146. Enter text into the grey box at the top
  147. of the screen and click in an editing
  148. window. If a font is loaded, text will
  149. appear at that point. To load a font,
  150. goto the font menu and select 'load
  151. font'. Fonts are Borland '.CHR'
  152. stroked font files.
  153. NB. Borland fonts are wireframe and
  154. therefore no surfaces are created
  155. when a font is drawn. You can give
  156. them depth, however with the 'extrude'
  157. tool.
  158.  
  159. ^UFile Functions^U
  160. ClayWorks allows you to load, save and
  161. append files in a number of formats,
  162. these formats are as follows:
  163.  
  164. '.3d' :Clayworks internal format.
  165. '.RWX':RenderWare scripting format.
  166. '.POV':Pov scene file- now works!.
  167. '.OBJ':Simple triangle format.
  168. '.PLG':Avril/Rend386 single object.
  169.  
  170. Saving in these formats will work fine
  171. but in some cases I am only able to
  172. parse a subset of the original file
  173. when loading and/or some detail might be
  174. comprimized in converting these files to
  175. ClayWorks' internal representation. (eg,
  176. definitions of primatives will be
  177. converted to surfaces and saved as such,
  178. so keep a copy of your original objects).
  179.  
  180. ^uSelecting/editing functions^u
  181. There are serveral useful tools in the
  182. select menu.
  183.   Clear simply delselects any selected
  184. nodes. Delete will remove any selected
  185. nodes and any polygons or lines and
  186. touch them. Merge will combine all the
  187. selected nodes.
  188.   The 'Flip' menu will flip the selection
  189. in any of the 3 axis.
  190.   The 'Polygons' menu is concearned only
  191. with surfaces. To see any changes, you
  192. will need to have the 3d window on a
  193. surface viewing mode (hidden line upto
  194. gouraud).
  195.   Double sided will make all the surfaces
  196. selected visible from both sides, single
  197. sided will render them invisible when they
  198. point away from you. 'Flip normals' will
  199. change the direction in which a surface is
  200. visible (a normal is a line that sticks
  201. out perpendicular to a surface). Delete
  202. will remove all selected surfaces. Apply
  203. colour will paint to current foreground
  204. colour on all selected surfaces.
  205.  
  206. ^UThe surface dialog^U
  207. Does a similar job to the 'apply attrib' 
  208. menu (setting the colour and attrib flags
  209. for the polygons) but you can also change
  210. the RGB/HSV value of the colours by double
  211. clicking on the pallete. The default 
  212. attributes are set by the toggle buttons at
  213. the top of the dialog.
  214.  
  215. ^UViewing the object^U
  216. The 3d window is used to view the object
  217. in a slightly fuller way than the drawing
  218. windows. The display is still a little
  219. primative (16 colours is very limiting)
  220. but it shows the important attribute 
  221. modes of the polygons -wireframe, 
  222. solid and gouraud shaded. This view is 
  223. not yet  light source shaded but it does 
  224. gives a running indication as to the 
  225. final appearance of the object. Using 
  226. the program 'Viewer' (or a commercial 
  227. viewer) you can see the object fully 
  228. shaded form. The viewer program will 
  229. soon be intergrated into ClayWorks.
  230.  
  231. ^UMemory^U
  232. The current version of ClayWorks does not
  233. use extended memory. Future versions will
  234. use 32-bit memory access (no need for an
  235. ems-driver) but until then, memory is tight.
  236. Large objects can be edited in Clay
  237. nonetheless but memory might run short if
  238. a large font is loaded and/or many devices
  239. are running.
  240.  
  241. ^UCredits and contact info^U
  242.  
  243. ClayWorks is written by myself, Tim Lewis
  244. in Turbo Pascal 7 and tasm assembler.
  245. A portable C++ version is in development
  246. and should be complete by 1996. 
  247. ClayWorks uses Twin, an object
  248. orientated fully functional multi-tasking
  249. (if non- preemptive) GUI. ClayWorks has
  250. existed in one form or another since 1992.
  251. The original version was written in
  252. Archamidies interperated Basic! It has
  253. improved since then.
  254.  
  255. ClayWorks is distributed by Imaginative
  256. Entertainment and is copyright
  257. T.Lewis 1992-1995.
  258.  
  259. Credits:
  260.  
  261. My friends and family for being
  262. supportive and making sure I get out
  263. and enjoy myself, Lancaster Uni for having
  264. internet access, the bar-staff at Grizedale
  265. bar for doing cheap Guiness, Chuck Durham
  266. and Zach for their kind words and general
  267. interest in my work, Todd Porter for his
  268. help and again, interest in my work (his
  269. is pretty good too, check it out), to
  270. Borland international for doing a good job
  271. of Pascal 7, my bike for taking me to campus
  272. each day, Autodesk for providing a goal to
  273. try and outperform and underpice (I wish
  274. the former but can manage the latter)
  275. Richard F. Ferraro for writing 'Programers
  276. guide to the EGA and VGA cards', Alan Watt
  277. for the book '3d computer Graphics',
  278. Gorsinon College, Swansea for getting me
  279. interested in programming 4 years ago but
  280. _not_ for chucking me off the network there!
  281. To Tom Rodden and the rest of Lancaster
  282. computing dept for being a freindly and
  283. understanding lot and to all the people 
  284. that developed the 3d maths, shading 
  285. techniques and whatever else that I have 
  286. used in this software. Finally, to all 
  287. those kind people who have spotted errors 
  288. and kept on nagging me to get them fixed. 
  289. Carry on doing so, please!
  290.  
  291. ^UContact info^U
  292.  
  293. Please contact me at this email
  294. address:
  295.  
  296. csc023@cent1.lancs.ac.uk
  297.  
  298. and at this snail mail address:
  299.  
  300. Tim Lewis, Grizedale college,
  301. Lancater uni, Lancaster,
  302. North England, Britain,
  303. LA14YU.
  304.  
  305.  
  306.  
  307.  
  308.  
  309.  
  310.  
  311.