Changeset 248 for trunk/thune/doc

Timestamp:

08/11/06 16:12:18 (2 years ago)

Author:

krobillard

Message:

Thune - Added 'random.

Files:

• trunk/thune/doc/UserManual (modified) (5 diffs)

trunk/thune/doc/UserManual

@@ -75 +75 @@
 block!       []  [a b c]
 paren!       ()  (a b c)
+array!       #[1 2 3]
 function!    [2 add] proc :inc2
 call!       
@@ -80 +81 @@
 decimal!     3.05  -4.
 coord!       0,255,100  -1, 0, 0 
+vec3!        0.0,255.0,100.0  -1.0, 0, 0 
 char!        'a' '^-'
 string!      "hello"  {hello}
@@ -120 +122 @@
 
 
+Array
+-----
+
+Arrays hold a series of 32-bit numbers using less memory than a block!.
+
+All numbers in an array are either integers or floating point values.  If
+any number is specified as a decimal!, all numbers will be floating point.
+
+
 Coord
 -----
@@ -133 +144 @@
    255,10,0      ; rgb triplet
    192,168,0,1   ; IP-4 network address
+
+
+Vec3
+----
+
+Vec3 stores 3 floating point values.
 
 
@@ -388 +405 @@
 arctan       (n -- r)           Arctangent
 sqrt         (n -- r)           Square root
+random       (max -- n)         Generate random number.
+random       (n 'seed -- )      Seed random number generator.
 ===========  =================  =================
+
+
+Vector Math
+~~~~~~~~~~~
+
+These functions operate on vec3!/coord!.
+
+===========  ======================  ======================
+Word         Stack Usage             Function
+===========  ======================  ======================
+dot          (v1 v2 -- dot)          Vector dot product.
+cross        (v1 v2 -- cross)        Vector cross product.
+normalize    (vec -- vec)            Make vec3 unit length.
+===========  ======================  ======================