Added algorithm module. Removed docs from control (leave to generate)

author: Ian C <ianc@noddybox.co.uk> 2005-09-21 00:51:00 +0000
committer: Ian C <ianc@noddybox.co.uk> 2005-09-21 00:51:00 +0000
commit: 14586e310f25600c1e7517f58212a008bd9ceea4 (patch)
tree: fe1d91b71302f93f1577102fa7b9c36b6e852c65
parent: 63b854c91ab0caeb5794388e04a0598e39723365 (diff)
6 files changed, 123 insertions, 256 deletions
diff --git a/algorithm.mod/.cvsignore b/algorithm.mod/.cvsignore
new file mode 100644
index 0000000..72fba4e
--- /dev/null
+++ b/algorithm.mod/.cvsignore
@@ -0,0 +1,5 @@
+.bmx
+algorithm.debug.win32.a
+algorithm.debug.win32.i
+algorithm.release.win32.a
+algorithm.release.win32.i
+\ No newline at end of file
diff --git a/algorithm.mod/algorithm.bmx b/algorithm.mod/algorithm.bmx
new file mode 100644
index 0000000..db68305
--- /dev/null
+++ b/algorithm.mod/algorithm.bmx
@@ -0,0 +1,118 @@
+Rem
+bbdoc: noddybox.algorithm
+EndRem
+Module noddybox.algorithm
+
+ModuleInfo "Framework: Various algorithm routines"
+ModuleInfo "Copyright: Public Domain"
+ModuleInfo "Author: Ian Cowburn"
+ModuleInfo "Version: $Revision$"
+
+' $Id$
+
+Strict
+Import brl.math
+Import brl.linkedlist
+
+Rem
+bbdoc: Used to return points from algorithms.
+EndRem
+Type TAlgoPoint
+	Rem
+	bbdoc: The X co-ordinate of the point
+	EndRem
+	Field	x:Int
+	Rem
+	bbdoc: The Y co-ordinate of the point
+	EndRem
+	Field	y:Int
+	
+	Rem
+	bbdoc: Create a point.
+	returns: Newly created point.
+	about: @x and @y are initialised with the passed parameters.
+	EndRem
+	Function Create:TAlgoPoint(x:Int, y:Int)
+		Local o:TAlgoPoint=New TAlgoPoint
+		o.x=x
+		o.y=y
+		Return o
+	End Function
+	
+End Type
+
+Rem
+bbdoc: Implements a Bresenham style line.
+returns: A list of points making up the line.
+about: @px1, @py1, @px2 and @py2 are the end points of the line.
+EndRem
+Function DoLine:TList(p1x:Int, p1y:Int, p2x:Int, p2y:Int)
+	Local list:TList=CreateList()
+	Local f:Int
+	Local dx:Int
+	Local dy:Int
+	Local ix:Int
+	Local iy:Int
+	Local incrE:Int
+	Local incrNE:Int
+	Local d:Int
+	Local x:Int
+	Local y:Int
+	Local ymode:Int
+
+	dx=p2x-p1x
+	dy=p2y-p1y
+	
+	ix=Sgn(dx)
+	iy=Sgn(dy)
+	
+	dx=Abs(dx)
+	dy=Abs(dy)
+
+	If dy>dx
+		ymode=True
+		d=dx*2-dy
+		incrE=dx*2
+		incrNE=(dx-dy)*2
+	Else
+		ymode=False
+		d=dy*2-dx
+		incrE=dy*2
+		incrNE=(dy-dx)*2
+	EndIf
+
+	x=p1x
+	y=p1y
+
+	list.AddLast(TAlgoPoint.Create(x,y))
+
+	If ymode
+		While y<>p2y
+			If d<=0
+				d:+incrE
+				y:+iy
+			Else
+				d:+incrNE
+				y:+iy
+				x:+ix
+			EndIf
+			
+			list.AddLast(TAlgoPoint.Create(x,y))
+		Wend
+    Else
+		While x<>p2x
+			If d<=0
+				d:+incrE
+				x:+ix
+			Else
+				d:+incrNE
+				y:+iy
+				x:+ix
+			EndIf
+			
+			list.AddLast(TAlgoPoint.Create(x,y))
+		Wend
+	EndIf
+	
+	Return list
+End Function
diff --git a/bitmapfont.mod/doc/commands.html b/bitmapfont.mod/doc/commands.html
deleted file mode 100644
index d196db5..0000000
--- a/bitmapfont.mod/doc/commands.html
+++ /dev/null
@@ -1,43 +0,0 @@
-<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=TBitmapFont class=ref>
-<div class=rootdoc><font class=token>Type TBitmapFont</font> Defines a bitmap font</div><div class=indent><p>The <b>TBitmapFont</b> object works from BMF Files, which are created using a tool called BitmapFontEd available at
-<a href="http://www.noddybox.demon.co.uk/free/index-csharp.html">http://www.noddybox.demon.co.uk/free/index-csharp.html</a><br>
-Note that when colours are referenced they simply modify the colours in the font images as <b>SetColor</b>() would do on a norml image.<br>
-When drawing characters the current scale, alpha and rotation settings are applied.</div><br><p><div id=DrawColoured>
-<div class=rootdoc><font class=token>Method DrawColoured( txt:String, x:Int, y:Int, red:Int, green:Int, blue:Int )</font> Draws coloured text.</div><div class=indent><p>Draws <b>txt</b> at the supplied <b>x</b>,<b>y</b> co-ordinates.  <b>red</b>,<b>green</b> and <b>blue</b> control the colour.</div><br></div><br>
-<p><div id=Draw>
-<div class=rootdoc><font class=token>Method Draw( txt:String, x:Int, y:Int )</font> Draws white text.</div><div class=indent><p>Draws <b>txt</b> at the supplied <b>x</b>,<b>y</b> co-ordinates in white.</div><br></div><br>
-<p><div id=CentreColoured>
-<div class=rootdoc><font class=token>Method CentreColoured( txt:String, y:Int, red:Int, green:Int, blue:Int )</font> Draws centred, coloured text.</div><div class=indent><p>Draws <b>txt</b> centred at the supplied <b>y</b> co-ordinate.  <b>red</b>,<b>green</b> and <b>blue</b> control the colour.</div><br></div><br>
-<p><div id=Centre>
-<div class=rootdoc><font class=token>Method Centre( txt:String, y:Int )</font> Draws centred, white text.</div><div class=indent><p>Draws <b>txt</b> centred at the supplied <b>y</b> co-ordinate in white.</div><br></div><br>
-<p><div id=TextWidth>
-<div class=rootdoc><font class=token>Method TextWidth:Int( txt:String )</font> Width of the supplied string.</div><div class=indent><p><b>Returns:</b> The length of the string <b>txt</b> in pixels.<p>The current scale settings are taken into account.</div><br></div><br>
-<p><div id=TextHeight>
-<div class=rootdoc><font class=token>Method TextHeight:Int( txt:String )</font> Height of the supplied string.</div><div class=indent><p><b>Returns:</b> The height of the string <b>txt</b> in pixels.<p>The current scale settings are taken into account.</div><br></div><br>
-<p><div id=MaxWidth>
-<div class=rootdoc><font class=token>Method MaxWidth:Int()</font> Width of the largest character.</div><div class=indent><p><b>Returns:</b> The width in pixels of the largest character in the font.</div><br></div><br>
-<p><div id=MaxHeight>
-<div class=rootdoc><font class=token>Method MaxHeight:Int()</font> Height of the largest character.</div><div class=indent><p><b>Returns:</b> The height in pixels of the largest character in the font.</div><br></div><br>
-<p><div id=Load>
-<div class=rootdoc><font class=token>Function Load:TBitmapFont( path:String, image_flags:Int )</font> Loads a font from the supplied BMF file.</div><div class=indent><p><b>Returns:</b> The created font, or null if the BMF file couldn't be loaded.<p>The <b>image_flags</b> are passed onto <b>CreateImage</b>() when the images for the font are being created.</div><br></div><br>
-</div><br>
-<h1>Module Information</h1>
-<table>
-<tr><td><b>Framework</b></td>
-<td> Simple Bitmap Font Routines</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>
diff --git a/glflag.mod/doc/commands.html b/glflag.mod/doc/commands.html
deleted file mode 100644
index e59624f..0000000
--- a/glflag.mod/doc/commands.html
+++ /dev/null
@@ -1,19 +0,0 @@
-<html>
-<head>
-<title>BlitzMax Module Reference</title>
-<link rel="stylesheet" type="text/css" href="../../../../doc/bmxstyle.css">
-</head>
-<body>
-<h1>Module Information</h1>
-<table>
-<tr><td><b>Framework</b></td>
-<td> Simple Open GL Backdrop flag</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>
diff --git a/simplegui.mod/doc/commands.html b/simplegui.mod/doc/commands.html
deleted file mode 100644
index b857360..0000000
--- a/simplegui.mod/doc/commands.html
+++ /dev/null
@@ -1,138 +0,0 @@
-<html>
-<head>
-<title>BlitzMax Module Reference</title>
-<link rel="stylesheet" type="text/css" href="../../../../doc/bmxstyle.css">
-</head>
-<body>
-<h1>Function Reference</h1>
-<p><div id=GUINotify class=ref>
-<div class=rootdoc><font class=token>Function GUINotify( s:String, i:TImage=Null )</font> Displays a notification alert with the supplied string.</div><div class=indent><p>The string <b>s</b> can be split into multiple lines using the '|' character.  If <b>i</b> is not null then this image is drawn as a mouse cursor.</div><br></div><br>
-<p><div id=GUIYesNo class=ref>
-<div class=rootdoc><font class=token>Function GUIYesNo:Int( s:String, i:TImage=Null )</font> Displays a yes/no alert with the supplied string.</div><div class=indent><p><b>Returns:</b> True if Yes selected, otherwise False.<p>The string <b>s</b> can be split into multiple lines using the '|' character.  If <b>i</b> is not null then this image is drawn as a mouse cursor.</div><br></div><br>
-<p><div id=GUIMenu class=ref>
-<div class=rootdoc><font class=token>Function GUIMenu( title:String, options:String[], x:Int, y:Int, i:TImage=Null )</font> Displays a pop-up menu.</div><div class=indent><p><b>Returns:</b> The index of the selected option, -1 for none.<p><b>title</b> is the menu title, <b>options</b> the options to display and <b>x</b> and <b>y</b> specify its position.
-If <b>i</b> is not null then this image is drawn as a mouse cursor.</div><br></div><br>
-<h1>Type Reference</h1>
-<p><div id=TGUIFont class=ref>
-<div class=rootdoc><font class=token>Type TGUIFont</font> Defines the <b>TBitmapFont</b> to be used by the GUI.</div><div class=indent></div><br><p><div id=font>
-<div class=rootdoc><font class=token>Global font:TBitmapFont</font> The font to use.</div><div class=indent></div><br></div><br>
-</div><br>
-<p><div id=TWidget class=ref>
-<div class=rootdoc><font class=token>Type TWidget Abstract</font> The base widget type.</div><div class=indent></div><br><p><div id=enabled>
-<div class=rootdoc><font class=token>Field enabled:Int</font> If true the widget is displayed and can be used.</div><div class=indent></div><br></div><br>
-<p><div id=text>
-<div class=rootdoc><font class=token>Field text:String</font> The text displayed in the widget.</div><div class=indent></div><br></div><br>
-<p><div id=x>
-<div class=rootdoc><font class=token>Field x:Int</font> The X co-ordinate of the widget.</div><div class=indent></div><br></div><br>
-<p><div id=y>
-<div class=rootdoc><font class=token>Field y:Int</font> The Y co-ordinate of the widget.</div><div class=indent></div><br></div><br>
-<p><div id=w>
-<div class=rootdoc><font class=token>Field w:Int</font> The width of the widget.</div><div class=indent></div><br></div><br>
-<p><div id=h>
-<div class=rootdoc><font class=token>Field h:Int</font> The height of the widget.</div><div class=indent></div><br></div><br>
-<p><div id=callback>
-<div class=rootdoc><font class=token>Field callback(w:TWidget)</font> Callback to call when clicked.</div><div class=indent></div><br></div><br>
-<p><div id=mouse_over>
-<div class=rootdoc><font class=token>Field mouse_over:Int</font> True if the mouse is over this widget, False otherwise.</div><div class=indent></div><br></div><br>
-<p><div id=owner>
-<div class=rootdoc><font class=token>Field owner:TGUIHandler</font> The <b>TGUIHandler</b> that owns this widget.</div><div class=indent></div><br></div><br>
-<p><div id=HandleKey>
-<div class=rootdoc><font class=token>Method HandleKey( k:Int )</font> Override this accept keypresses</div><div class=indent></div><br></div><br>
-<p><div id=MouseEnter>
-<div class=rootdoc><font class=token>Method MouseEnter()</font> Override this for when the mouse enters.  Call this parent version to handle <b>mouse_over</b> too.</div><div class=indent></div><br></div><br>
-<p><div id=MouseLeave>
-<div class=rootdoc><font class=token>Method MouseLeave()</font> Override this for when the mouse leaves.  Call this parent version to handle <b>mouse_over</b> too.</div><div class=indent></div><br></div><br>
-<p><div id=HandleClick>
-<div class=rootdoc><font class=token>Method HandleClick()</font> Override to handle a mouse button press.</div><div class=indent></div><br></div><br>
-<p><div id=Draw>
-<div class=rootdoc><font class=token>Method Draw()</font> Must be provided by a widget to draw itself.</div><div class=indent></div><br></div><br>
-<p><div id=DrawBox>
-<div class=rootdoc><font class=token>Function DrawBox( x:Int, y:Int, w:Int, h:Int )</font> Helper to draw a wireframe rectangle.</div><div class=indent></div><br></div><br>
-<p><div id=Draw3DBox>
-<div class=rootdoc><font class=token>Function Draw3DBox( x:Int, y:Int, w:Int, h:Int, invert:Int, size:Int=2 )</font> Helper to draw a 3D rectangle.</div><div class=indent></div><br></div><br>
-</div><br>
-<p><div id=TLabel class=ref>
-<div class=rootdoc><font class=token>Type TLabel Extends TWidget</font> The label widget (simply displays the supplied string)</div><div class=indent></div><br><p><div id=Create>
-<div class=rootdoc><font class=token>Function Create:TLabel( gui:TGUIHandler,x:Int, y:Int, text:String )</font> Create a TLabel widget.</div><div class=indent><p><b>Returns:</b> The created widget.<p><b>gui</b> is the <b>TGUIHandler</b> object managing this wiget. <b>x</b> and <b>y</b> are its position and <b>text</b> is the text to display in the label.</div><br></div><br>
-</div><br>
-<p><div id=TText class=ref>
-<div class=rootdoc><font class=token>Type TText Extends TWidget</font> The text entry widget</div><div class=indent></div><br><p><div id=Create>
-<div class=rootdoc><font class=token>Function Create:TText( gui:TGUIHandler,x:Int, y:Int, text:String, maxlen:Int, callback(w:TWidget)=Null )</font> Create a TText widget.</div><div class=indent><p><b>Returns:</b> The created widget.<p><b>gui</b> is the <b>TGUIHandler</b> object managing this wiget. <b>x</b> and <b>y</b> are its position and <b>text</b> is the initial text in the widget.
-<b>maxlen</b> is the maximum number of characters allowed.  <b>callback</b> is called when RETURN is pressed in the text field.</div><br></div><br>
-</div><br>
-<p><div id=TCheckbox class=ref>
-<div class=rootdoc><font class=token>Type TCheckbox Extends TWidget</font> The checkbox widget</div><div class=indent></div><br><p><div id=checked>
-<div class=rootdoc><font class=token>Field checked:Int</font> True if the box is checked, False otherwise.</div><div class=indent></div><br></div><br>
-<p><div id=Create>
-<div class=rootdoc><font class=token>Function Create:TCheckbox( gui:TGUIHandler, x:Int, y:Int, text:String, callback(w:TWidget)=Null )</font> Create a TCheckox widget.</div><div class=indent><p><b>Returns:</b> The created widget.<p><b>gui</b> is the <b>TGUIHandler</b> object managing this wiget. <b>x</b> and <b>y</b> are its position and <b>text</b> is the text to display by the checkbox.
-<b>callback</b> is called when the checkbox is toggled.</div><br></div><br>
-</div><br>
-<p><div id=TButton class=ref>
-<div class=rootdoc><font class=token>Type TButton Extends TWidget</font> The button widget</div><div class=indent></div><br><p><div id=Create>
-<div class=rootdoc><font class=token>Function Create:TButton( gui:TGUIHandler, x:Int, y:Int, w:Int, h:Int, text:String, callback(w:TWidget) )</font> Create a TButton widget.</div><div class=indent><p><b>Returns:</b> The created widget.<p><b>gui</b> is the <b>TGUIHandler</b> object managing this wiget. <b>x</b>, <b>y</b>, <b>w</b> and <b>h</b> are its position and size, and <b>text</b> is the text to display in the button.
-<b>callback</b> is called when the button is pressed.</div><br></div><br>
-</div><br>
-<p><div id=TButtonList class=ref>
-<div class=rootdoc><font class=token>Type TButtonList Extends TWidget</font> A drop down list type widget</div><div class=indent></div><br><p><div id=selected>
-<div class=rootdoc><font class=token>Field selected:Int</font> The selected item.</div><div class=indent></div><br></div><br>
-<p><div id=Create>
-<div class=rootdoc><font class=token>Function Create:TButtonList( gui:TGUIHandler, x:Int, y:Int, options:String[], selected:Int, callback(w:TWidget) )</font> Create a TButtonList widget.</div><div class=indent><p><b>Returns:</b> The created widget.<p><b>gui</b> is the <b>TGUIHandler</b> object managing this wiget. <b>x</b> and <b>y</b> are its position. <b>options</b> are the options for the list and
-<b>selected</b> is the currently selected item. <b>callback</b> is called when the selection changes.</div><br></div><br>
-</div><br>
-<p><div id=TNumberFloat class=ref>
-<div class=rootdoc><font class=token>Type TNumberFloat Extends TWidget</font> A number up/down widget for floats</div><div class=indent></div><br><p><div id=value>
-<div class=rootdoc><font class=token>Field value:Float</font> The value</div><div class=indent></div><br></div><br>
-<p><div id=change>
-<div class=rootdoc><font class=token>Field change:Float</font> The increment/decrement</div><div class=indent></div><br></div><br>
-<p><div id=maxval>
-<div class=rootdoc><font class=token>Field maxval:Float</font> The maximum value</div><div class=indent></div><br></div><br>
-<p><div id=minval>
-<div class=rootdoc><font class=token>Field minval:Float</font> The minimum value</div><div class=indent></div><br></div><br>
-<p><div id=Create>
-<div class=rootdoc><font class=token>Function Create:TNumberFloat( gui:TGUIHandler, x:Int, y:Int, callback(w:TWidget)=Null )</font> Create a TNumber widget.</div><div class=indent><p><b>Returns:</b> The created widget.<p><b>gui</b> is the <b>TGUIHandler</b> object managing this wiget. <b>x</b> and <b>y</b> are its position.
-<b>callback</b> is called when the value changes.</div><br></div><br>
-</div><br>
-<p><div id=TNumberInt class=ref>
-<div class=rootdoc><font class=token>Type TNumberInt Extends TWidget</font> A number up/down widget for ints</div><div class=indent></div><br><p><div id=value>
-<div class=rootdoc><font class=token>Field value:Int</font> The value</div><div class=indent></div><br></div><br>
-<p><div id=change>
-<div class=rootdoc><font class=token>Field change:Int</font> The increment/decrement</div><div class=indent></div><br></div><br>
-<p><div id=maxval>
-<div class=rootdoc><font class=token>Field maxval:Int</font> The maximum value</div><div class=indent></div><br></div><br>
-<p><div id=minval>
-<div class=rootdoc><font class=token>Field minval:Int</font> The minimum value</div><div class=indent></div><br></div><br>
-<p><div id=Create>
-<div class=rootdoc><font class=token>Function Create:TNumberInt( gui:TGUIHandler, x:Int, y:Int, callback(w:TWidget)=Null )</font> Create a TNumber widget.</div><div class=indent><p><b>Returns:</b> The created widget.<p><b>gui</b> is the <b>TGUIHandler</b> object managing this wiget. <b>x</b> and <b>y</b> are its position.
-<b>callback</b> is called when the value changes.</div><br></div><br>
-</div><br>
-<p><div id=TGUIHandler class=ref>
-<div class=rootdoc><font class=token>Type TGUIHandler</font> Handles the GUI.</div><div class=indent></div><br><p><div id=Register>
-<div class=rootdoc><font class=token>Method Register( w:TWidget )</font> Register a widget.</div><div class=indent><p>Widgets call this themselves.</div><br></div><br>
-<p><div id=Clear>
-<div class=rootdoc><font class=token>Method Clear()</font> Remove all widgets.</div><div class=indent></div><br></div><br>
-<p><div id=SetEnable>
-<div class=rootdoc><font class=token>Method SetEnable( state:Int )</font> Sets the enable state of all widgets.</div><div class=indent><p>If <b>state</b> is true then all widgets are enabled, otherwise all widgets are disabled</div><br></div><br>
-<p><div id=SetFocus>
-<div class=rootdoc><font class=token>Method SetFocus( w:TWidget )</font> Sets the keyboard focus to the supplied widget.  Pass null for no focus.</div><div class=indent></div><br></div><br>
-<p><div id=GetFocus>
-<div class=rootdoc><font class=token>Method GetFocus:TWidget()</font> Gets the keyboard focus.</div><div class=indent><p><b>Returns:</b> The currently focused TWidget, or null for no focus.</div><br></div><br>
-<p><div id=Clicked>
-<div class=rootdoc><font class=token>Method Clicked:TWidget()</font> Gets the last clicked widget.</div><div class=indent><p><b>Returns:</b> The last clicked TWidget.  Null is returned if this is called again before another widget is clicked.</div><br></div><br>
-<p><div id=EventLoop>
-<div class=rootdoc><font class=token>Method EventLoop()</font> Perform the event loop and pass any necessary events.</div><div class=indent><p>KeyHit(KEY_MOUSELEFT) and GetChar() are used to consume events for the interface.</div><br></div><br>
-<p><div id=Create>
-<div class=rootdoc><font class=token>Function Create:TGUIHandler()</font> Create a GUI Handler.</div><div class=indent><p><b>Returns:</b> The GUI Hanbler.</div><br></div><br>
-</div><br>
-<h1>Module Information</h1>
-<table>
-<tr><td><b>Framework</b></td>
-<td> (Very) Simple GUI</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>
diff --git a/vector.mod/doc/commands.html b/vector.mod/doc/commands.html
deleted file mode 100644
index 4cb9c08..0000000
--- a/vector.mod/doc/commands.html
+++ /dev/null
@@ -1,56 +0,0 @@
-<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>
author	Ian C <ianc@noddybox.co.uk>	2005-09-21 00:51:00 +0000
committer	Ian C <ianc@noddybox.co.uk>	2005-09-21 00:51:00 +0000
commit	14586e310f25600c1e7517f58212a008bd9ceea4 (patch)
tree	fe1d91b71302f93f1577102fa7b9c36b6e852c65
parent	63b854c91ab0caeb5794388e04a0598e39723365 (diff)