diff options
Diffstat (limited to 'vector.mod/doc')
| -rw-r--r-- | vector.mod/doc/commands.html | 56 | 
1 files changed, 56 insertions, 0 deletions
| diff --git a/vector.mod/doc/commands.html b/vector.mod/doc/commands.html new file mode 100644 index 0000000..4cb9c08 --- /dev/null +++ b/vector.mod/doc/commands.html @@ -0,0 +1,56 @@ +<html>
 +<head>
 +<title>BlitzMax Module Reference</title>
 +<link rel="stylesheet" type="text/css" href="../../../../doc/bmxstyle.css">
 +</head>
 +<body>
 +<h1>Type Reference</h1>
 +<p><div id=TVector class=ref>
 +<div class=rootdoc><font class=token>Type TVector</font> Implements a 3D vector.  Can be used as a 2D vector by ignoring Z.</div><div class=indent></div><br><p><div id=x>
 +<div class=rootdoc><font class=token>Field x:Float</font> The X component of the vector.</div><div class=indent></div><br></div><br>
 +<p><div id=y>
 +<div class=rootdoc><font class=token>Field y:Float</font> The Y component of the vector.</div><div class=indent></div><br></div><br>
 +<p><div id=z>
 +<div class=rootdoc><font class=token>Field z:Float</font> The Z component of the vector.</div><div class=indent></div><br></div><br>
 +<p><div id=IsNull>
 +<div class=rootdoc><font class=token>Method IsNull:Int()</font> Is the vector null.</div><div class=indent><p><b>Returns:</b> True if the vector is null (all components zero), False otherwise.</div><br></div><br>
 +<p><div id=Length>
 +<div class=rootdoc><font class=token>Method Length:Float()</font> The length of the vector.</div><div class=indent><p><b>Returns:</b> The length of the vector.</div><br></div><br>
 +<p><div id=Normalise>
 +<div class=rootdoc><font class=token>Method Normalise()</font> Normalise the vector so its length is 1.</div><div class=indent></div><br></div><br>
 +<p><div id=SetLength>
 +<div class=rootdoc><font class=token>Method SetLength( sc:Float )</font> Set the vector so its length is <b>sc</b>.</div><div class=indent></div><br></div><br>
 +<p><div id=AddScalar>
 +<div class=rootdoc><font class=token>Method AddScalar( sc:Float )</font> Adds <b>sc</b> to all components.</div><div class=indent></div><br></div><br>
 +<p><div id=Minus>
 +<div class=rootdoc><font class=token>Method Minus()</font> Reverse the direction of the vector.</div><div class=indent></div><br></div><br>
 +<p><div id=Scale>
 +<div class=rootdoc><font class=token>Method Scale( sc:Float )</font> Scale all components by <b>sc</b>.</div><div class=indent></div><br></div><br>
 +<p><div id=Add>
 +<div class=rootdoc><font class=token>Method Add( v:TVector )</font> Add another vector to this vector.</div><div class=indent></div><br></div><br>
 +<p><div id=Subtract>
 +<div class=rootdoc><font class=token>Method Subtract( v:TVector )</font> Subtract another vector from this vector.</div><div class=indent></div><br></div><br>
 +<p><div id=ScaleVector>
 +<div class=rootdoc><font class=token>Method ScaleVector( v:TVector )</font> Scale this vector by another vector.</div><div class=indent></div><br></div><br>
 +<p><div id=InverseScaleVector>
 +<div class=rootdoc><font class=token>Method InverseScaleVector( v:TVector )</font> Inverse scale this vector by another vector.</div><div class=indent></div><br></div><br>
 +<p><div id=Cross>
 +<div class=rootdoc><font class=token>Method Cross:TVector( v:TVector )</font> Calculate the cross product of this vector with another.</div><div class=indent><p><b>Returns:</b> A new <b>TVector</b> holding the cross product.</div><br></div><br>
 +<p><div id=Dot>
 +<div class=rootdoc><font class=token>Method Dot:Float( v:TVector )</font> Calculate the dot product of this vector with another.</div><div class=indent><p><b>Returns:</b> The dot product.</div><br></div><br>
 +<p><div id=Create>
 +<div class=rootdoc><font class=token>Function Create:TVector( dx:Float=0.0, dy:Float=0.0, dz:Float=0.0 )</font> Create a vector.</div><div class=indent><p><b>Returns:</b> The created vector.<p><b>dx</b>, <b>dy</b> and <b>dz</b> are the initial component values.</div><br></div><br>
 +</div><br>
 +<h1>Module Information</h1>
 +<table>
 +<tr><td><b>Framework</b></td>
 +<td> Simple Vector class</td></tr>
 +<tr><td><b>Copyright</b></td>
 +<td> Public Domain</td></tr>
 +<tr><td><b>Author</b></td>
 +<td> Ian Cowburn</td></tr>
 +<tr><td><b>Version</b></td>
 +<td> $Revision$</td></tr>
 +</table>
 +</body>
 +</html>
 | 
