diff options
Diffstat (limited to 'doc/sims/geometry')
-rw-r--r-- | doc/sims/geometry/ConvexPolygon.html | 228 | ||||
-rw-r--r-- | doc/sims/geometry/Projection.html | 263 | ||||
-rw-r--r-- | doc/sims/geometry/Ray.html | 253 | ||||
-rw-r--r-- | doc/sims/geometry/Segment.html | 317 | ||||
-rw-r--r-- | doc/sims/geometry/Vector2D$.html | 190 | ||||
-rw-r--r-- | doc/sims/geometry/Vector2D.html | 435 | ||||
-rw-r--r-- | doc/sims/geometry/package.html | 105 |
7 files changed, 0 insertions, 1791 deletions
diff --git a/doc/sims/geometry/ConvexPolygon.html b/doc/sims/geometry/ConvexPolygon.html deleted file mode 100644 index e3cdc96..0000000 --- a/doc/sims/geometry/ConvexPolygon.html +++ /dev/null @@ -1,228 +0,0 @@ -<?xml version='1.0' encoding='UTF-8'?> -<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.1//EN" "http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd"> -<html> - <head> - <title>Scaladoc for sims.geometry.ConvexPolygon</title> - <meta http-equiv="content-type" content="text/html; charset=UTF-8" /> - <script type="text/javascript" src="../../lib/jquery.js"></script> - - <style type="text/css"> - @import url(../../lib/template.css) screen; - </style> - <script type="text/javascript" src="../../lib/template.js"></script> - - </head> - <body class="type"> - - <p id="owner"><a href="../package.html">sims</a>.<a href="package.html">geometry</a></p> - - <div id="definition"> - <img src="../../lib/trait_big.png" /> - <h1>ConvexPolygon</h1> - </div> - - <h4 class="signature"> - <span class="kind">trait</span> - <span class="symbol"> - <span class="name">ConvexPolygon</span><span class="result"> extends AnyRef</span> - </span> - </h4> - <div class="fullcomment" id="comment"> - <div class="comment cmt"><p>Common properties of all convex polygons.</p></div> - - - - <div class="block"> - known subclasses: <a href="../dynamics/RegularPolygon.html">RegularPolygon</a>, <a href="../dynamics/Rectangle.html">Rectangle</a> - </div> - </div> - - <div id="template"> - - <div id="mbrsel"> - <div id="ancestors"> - <h3>Inherits</h3> - <ol><li class="in" name="scala.AnyRef">AnyRef</li><li class="in" name="scala.Any">Any</li></ol> - </div> - </div> - - - - <div class="members" id="values"> - <h3>Value Members</h3> - <ol><li name="sims.geometry.ConvexPolygon#AABB"> - <h4 class="signature"> - <span class="kind">def</span> - <span class="symbol"> - <span class="name">AABB</span><span class="result">: <a href="../collision/AABB.html" class="extype" name="sims.collision.AABB">AABB</a></span> - </span> - </h4> - <p class="shortcomment cmt">Returns this polygon's axis aligned bounding box</p><div class="fullcomment"> - <div class="comment cmt"><p>Returns this polygon's axis aligned bounding box.</p></div> - - - - - </div> - </li><li name="sims.geometry.ConvexPolygon#contains"> - <h4 class="signature"> - <span class="kind">def</span> - <span class="symbol"> - <span class="name">contains</span><span class="params">(<span name="point">point: <a href="Vector2D.html" class="extype" name="sims.geometry.Vector2D">Vector2D</a></span>)</span><span class="result">: <span class="extype" name="scala.Boolean">Boolean</span></span> - </span> - </h4> - <p class="shortcomment cmt">Checks if the point <code>point</code> is contained in this polygon</p><div class="fullcomment"> - <div class="comment cmt"><p>Checks if the point <code>point</code> is contained in this polygon. -<p> -A ray is created, originating from the point and following an arbitrary direction (X-Axis was chosen). -The number of intersections between the ray and this polygon's sides (including vertices) is counted. -The amount of intersections with vertices is substracted form the previuos number. -If the latter number is odd, the point is contained in the polygon.</p></div> - - - - - </div> - </li><li name="scala.AnyRef#equals"> - <h4 class="signature"> - <span class="kind">def</span> - <span class="symbol"> - <span class="name">equals</span><span class="params">(<span name="arg0">arg0: <span class="extype" name="scala.Any">Any</span></span>)</span><span class="result">: <span class="extype" name="scala.Boolean">Boolean</span></span> - </span> - </h4> - <p class="shortcomment cmt">This method is used to compare the receiver object (<code>this</code>) -with the argument object (<code>arg0</code>) for equivalence</p><div class="fullcomment"> - <div class="comment cmt"><p>This method is used to compare the receiver object (<code>this</code>) -with the argument object (<code>arg0</code>) for equivalence.</p><p><p> -The default implementations of this method is an <a -href="http://en.wikipedia.org/wiki/Equivalence_relation">equivalence -relation</a>: - <ul> - <li>It is reflexive: for any instance <code>x</code> of type <code>Any</code>, - <code>x.equals(x)</code> should return <code>true</code>.</li> - <li>It is symmetric: for any instances <code>x</code> and <code>y</code> of type - <code>Any</code>, <code>x.equals(y)</code> should return <code>true</code> if and only - if <code>y.equals(x)</code> returns <code>true</code>.</li> - <li>It is transitive: for any instances - <code>x</code>, <code>y</code>, and <code>z</code> of type <code>AnyRef</code> - if <code>x.equals(y)</code> returns <code>true</code> and - <code>y.equals(z)</code> returns - <code>true</code>, then <code>x.equals(z)</code> should return <code>true</code>.</li> -</ul> -</p></p><p><p> -If you override this method, you should verify that -your implementation remains an equivalence relation. -Additionally, when overriding this method it is often necessary to -override <code>hashCode</code> to ensure that objects that are -"equal" (<code>o1.equals(o2)</code> returns <code>true</code>) -hash to the same <a href="Int.html"><code>Int</code></a> -(<code>o1.hashCode.equals(o2.hashCode)</code>). -</p></div> - <dl class="paramcmts block"><dt class="param">arg0</dt><dd class="cmt"><p>the object to compare against this object for equality.</p></dd><dt>returns</dt><dd class="cmt"><p><code>true</code> if the receiver object is equivalent to the argument; <code>false</code> otherwise. -</p></p></dd></dl> - - <div class="block"> - definition classes: AnyRef ⇐ Any - </div> - - </div> - </li><li name="scala.AnyRef#hashCode"> - <h4 class="signature"> - <span class="kind">def</span> - <span class="symbol"> - <span class="name">hashCode</span><span class="params">()</span><span class="result">: <span class="extype" name="scala.Int">Int</span></span> - </span> - </h4> - <p class="shortcomment cmt">Returns a hash code value for the object</p><div class="fullcomment"> - <div class="comment cmt"><p>Returns a hash code value for the object.</p><p><p> -The default hashing algorithm is platform dependent.</p><p>Note that it is allowed for two objects to have identical hash -codes (<code>o1.hashCode.equals(o2.hashCode)</code>) yet not be -equal (<code>o1.equals(o2)</code> returns <code>false</code>). A -degenerate implementation could always return <code>0</code>. -However, it is required that if two objects are equal -(<code>o1.equals(o2)</code> returns <code>true</code>) that they -have identical hash codes -(<code>o1.hashCode.equals(o2.hashCode)</code>). Therefore, when -overriding this method, be sure to verify that the behavior is -consistent with the <code>equals</code> method. -</p></p><p><p></p></div> - - - <div class="block"> - definition classes: AnyRef ⇐ Any - </div> - - </div> - </li><li name="sims.geometry.ConvexPolygon#project"> - <h4 class="signature"> - <span class="kind">def</span> - <span class="symbol"> - <span class="name">project</span><span class="params">(<span name="axis">axis: <a href="Vector2D.html" class="extype" name="sims.geometry.Vector2D">Vector2D</a></span>)</span><span class="result">: <a href="Projection.html" class="extype" name="sims.geometry.Projection">Projection</a></span> - </span> - </h4> - <p class="shortcomment cmt">Returns the projection of this polygon onto the line given by the directional vector <code>axis</code></p><div class="fullcomment"> - <div class="comment cmt"><p>Returns the projection of this polygon onto the line given by the directional vector <code>axis</code>.</p></div> - <dl class="paramcmts block"><dt class="param">axis</dt><dd class="cmt"><p>directional vector of the line</p></dd><dt>returns</dt><dd class="cmt"><p>projection of this polygon</p></dd></dl> - - - - </div> - </li><li name="sims.geometry.ConvexPolygon#sides"> - <h4 class="signature"> - <span class="kind">def</span> - <span class="symbol"> - <span class="name">sides</span><span class="result">: <span class="extype" name="scala.Array">Array</span>[<a href="Segment.html" class="extype" name="sims.geometry.Segment">Segment</a>]</span> - </span> - </h4> - <p class="shortcomment cmt">Returns all sides of this polygon</p><div class="fullcomment"> - <div class="comment cmt"><p>Returns all sides of this polygon. The sides are ordered counter-clockwise, the first vertex of the side -giving the side index.</p></div> - - - - - </div> - </li><li name="scala.AnyRef#toString"> - <h4 class="signature"> - <span class="kind">def</span> - <span class="symbol"> - <span class="name">toString</span><span class="params">()</span><span class="result">: <span class="extype" name="java.lang.String">String</span></span> - </span> - </h4> - <p class="shortcomment cmt">Returns a string representation of the object</p><div class="fullcomment"> - <div class="comment cmt"><p>Returns a string representation of the object. -<p> -The default representation is platform dependent. -</p></div> - - - <div class="block"> - definition classes: AnyRef ⇐ Any - </div> - - </div> - </li><li name="sims.geometry.ConvexPolygon#vertices"> - <h4 class="signature"> - <span class="kind">def</span> - <span class="symbol"> - <span class="name">vertices</span><span class="result">: <span class="extype" name="scala.collection.Seq">Seq</span>[<a href="Vector2D.html" class="extype" name="sims.geometry.Vector2D">Vector2D</a>]</span> - </span> - </h4> - <p class="shortcomment cmt">Returns positions of all vertices of this Polygon</p><div class="fullcomment"> - <div class="comment cmt"><p>Returns positions of all vertices of this Polygon. Vertices are ordered counter-clockwise.</p></div> - - <div class="block"> - attributes: abstract - </div> - - - </div> - </li></ol> - </div> - - - - </div> - - </body> - </html>
\ No newline at end of file diff --git a/doc/sims/geometry/Projection.html b/doc/sims/geometry/Projection.html deleted file mode 100644 index 7c180ac..0000000 --- a/doc/sims/geometry/Projection.html +++ /dev/null @@ -1,263 +0,0 @@ -<?xml version='1.0' encoding='UTF-8'?> -<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.1//EN" "http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd"> -<html> - <head> - <title>Scaladoc for sims.geometry.Projection</title> - <meta http-equiv="content-type" content="text/html; charset=UTF-8" /> - <script type="text/javascript" src="../../lib/jquery.js"></script> - - <style type="text/css"> - @import url(../../lib/template.css) screen; - </style> - <script type="text/javascript" src="../../lib/template.js"></script> - - </head> - <body class="type"> - - <p id="owner"><a href="../package.html">sims</a>.<a href="package.html">geometry</a></p> - - <div id="definition"> - <img src="../../lib/class_big.png" /> - <h1>Projection</h1> - </div> - - <h4 class="signature"> - <span class="kind">class</span> - <span class="symbol"> - <span class="name">Projection</span><span class="params">(<span name="axis">axis: <a href="Vector2D.html" class="extype" name="sims.geometry.Vector2D">Vector2D</a></span>, <span name="lower">lower: <span class="extype" name="scala.Double">Double</span></span>, <span name="upper">upper: <span class="extype" name="scala.Double">Double</span></span>)</span><span class="result"> extends <span class="extype" name="scala.Product">Product</span></span> - </span> - </h4> - <div class="fullcomment" id="comment"> - <div class="comment cmt"><p>Projection on an axis. -<p> -Projections are commonly used in SiMS for collision detection.</p></div> - <dl class="paramcmts block"><dt class="param">axis</dt><dd class="cmt"><p>directional vector of the axis of the projection</p></dd><dt class="param">lower</dt><dd class="cmt"><p>lower value of the projection</p></dd><dt class="param">upper</dt><dd class="cmt"><p>upper value of the projection</p></dd></dl> - - - - </div> - - <div id="template"> - - <div id="mbrsel"> - <div id="ancestors"> - <h3>Inherits</h3> - <ol><li class="in" name="scala.Product">Product</li><li class="in" name="scala.Equals">Equals</li><li class="in" name="scala.AnyRef">AnyRef</li><li class="in" name="scala.Any">Any</li></ol> - </div> - </div> - - - - <div class="members" id="values"> - <h3>Value Members</h3> - <ol><li name="sims.geometry.Projection#axis"> - <h4 class="signature"> - <span class="kind">val</span> - <span class="symbol"> - <span class="name">axis</span><span class="result">: <a href="Vector2D.html" class="extype" name="sims.geometry.Vector2D">Vector2D</a></span> - </span> - </h4> - - </li><li name="sims.geometry.Projection#canEqual"> - <h4 class="signature"> - <span class="kind">def</span> - <span class="symbol"> - <span class="name">canEqual</span><span class="params">(<span name="arg0">arg0: <span class="extype" name="scala.Any">Any</span></span>)</span><span class="result">: <span class="extype" name="scala.Boolean">Boolean</span></span> - </span> - </h4> - - </li><li name="sims.geometry.Projection#equals"> - <h4 class="signature"> - <span class="kind">def</span> - <span class="symbol"> - <span class="name">equals</span><span class="params">(<span name="arg0">arg0: <span class="extype" name="scala.Any">Any</span></span>)</span><span class="result">: <span class="extype" name="scala.Boolean">Boolean</span></span> - </span> - </h4> - <p class="shortcomment cmt">This method is used to compare the receiver object (<code>this</code>) -with the argument object (<code>arg0</code>) for equivalence</p><div class="fullcomment"> - <div class="comment cmt"><p>This method is used to compare the receiver object (<code>this</code>) -with the argument object (<code>arg0</code>) for equivalence.</p><p><p> -The default implementations of this method is an <a -href="http://en.wikipedia.org/wiki/Equivalence_relation">equivalence -relation</a>: - <ul> - <li>It is reflexive: for any instance <code>x</code> of type <code>Any</code>, - <code>x.equals(x)</code> should return <code>true</code>.</li> - <li>It is symmetric: for any instances <code>x</code> and <code>y</code> of type - <code>Any</code>, <code>x.equals(y)</code> should return <code>true</code> if and only - if <code>y.equals(x)</code> returns <code>true</code>.</li> - <li>It is transitive: for any instances - <code>x</code>, <code>y</code>, and <code>z</code> of type <code>AnyRef</code> - if <code>x.equals(y)</code> returns <code>true</code> and - <code>y.equals(z)</code> returns - <code>true</code>, then <code>x.equals(z)</code> should return <code>true</code>.</li> -</ul> -</p></p><p><p> -If you override this method, you should verify that -your implementation remains an equivalence relation. -Additionally, when overriding this method it is often necessary to -override <code>hashCode</code> to ensure that objects that are -"equal" (<code>o1.equals(o2)</code> returns <code>true</code>) -hash to the same <a href="Int.html"><code>Int</code></a> -(<code>o1.hashCode.equals(o2.hashCode)</code>). -</p></div> - <dl class="paramcmts block"><dt class="param">arg0</dt><dd class="cmt"><p>the object to compare against this object for equality.</p></dd><dt>returns</dt><dd class="cmt"><p><code>true</code> if the receiver object is equivalent to the argument; <code>false</code> otherwise. -</p></p></dd></dl> - - - - </div> - </li><li name="sims.geometry.Projection#hashCode"> - <h4 class="signature"> - <span class="kind">def</span> - <span class="symbol"> - <span class="name">hashCode</span><span class="params">()</span><span class="result">: <span class="extype" name="scala.Int">Int</span></span> - </span> - </h4> - <p class="shortcomment cmt">Returns a hash code value for the object</p><div class="fullcomment"> - <div class="comment cmt"><p>Returns a hash code value for the object.</p><p><p> -The default hashing algorithm is platform dependent.</p><p>Note that it is allowed for two objects to have identical hash -codes (<code>o1.hashCode.equals(o2.hashCode)</code>) yet not be -equal (<code>o1.equals(o2)</code> returns <code>false</code>). A -degenerate implementation could always return <code>0</code>. -However, it is required that if two objects are equal -(<code>o1.equals(o2)</code> returns <code>true</code>) that they -have identical hash codes -(<code>o1.hashCode.equals(o2.hashCode)</code>). Therefore, when -overriding this method, be sure to verify that the behavior is -consistent with the <code>equals</code> method. -</p></p><p><p></p></div> - - - - - </div> - </li><li name="sims.geometry.Projection#lower"> - <h4 class="signature"> - <span class="kind">val</span> - <span class="symbol"> - <span class="name">lower</span><span class="result">: <span class="extype" name="scala.Double">Double</span></span> - </span> - </h4> - - </li><li name="sims.geometry.Projection#overlap"> - <h4 class="signature"> - <span class="kind">def</span> - <span class="symbol"> - <span class="name">overlap</span><span class="params">(<span name="other">other: <a href="" class="extype" name="sims.geometry.Projection">Projection</a></span>)</span><span class="result">: <span class="extype" name="scala.Double">Double</span></span> - </span> - </h4> - <p class="shortcomment cmt">Returns the overlap between this projection and another projection <code>other</code></p><div class="fullcomment"> - <div class="comment cmt"><p>Returns the overlap between this projection and another projection <code>other</code>.</p></div> - - - - - </div> - </li><li name="sims.geometry.Projection#overlaps"> - <h4 class="signature"> - <span class="kind">def</span> - <span class="symbol"> - <span class="name">overlaps</span><span class="params">(<span name="other">other: <a href="" class="extype" name="sims.geometry.Projection">Projection</a></span>)</span><span class="result">: <span class="extype" name="scala.Boolean">Boolean</span></span> - </span> - </h4> - <p class="shortcomment cmt">Checks this projection for overlap with another projection <code>other</code></p><div class="fullcomment"> - <div class="comment cmt"><p>Checks this projection for overlap with another projection <code>other</code>.</p></div> - - - - - </div> - </li><li name="sims.geometry.Projection#productArity"> - <h4 class="signature"> - <span class="kind">def</span> - <span class="symbol"> - <span class="name">productArity</span><span class="result">: <span class="extype" name="scala.Int">Int</span></span> - </span> - </h4> - - </li><li name="sims.geometry.Projection#productElement"> - <h4 class="signature"> - <span class="kind">def</span> - <span class="symbol"> - <span class="name">productElement</span><span class="params">(<span name="arg0">arg0: <span class="extype" name="scala.Int">Int</span></span>)</span><span class="result">: <span class="extype" name="scala.Any">Any</span></span> - </span> - </h4> - - </li><li name="scala.Product#productElements"> - <h4 class="signature"> - <span class="kind">def</span> - <span class="symbol"> - <span class="name">productElements</span><span class="result">: <span class="extype" name="scala.collection.Iterator">Iterator</span>[<span class="extype" name="scala.Any">Any</span>]</span> - </span> - </h4> - - </li><li name="scala.Product#productIterator"> - <h4 class="signature"> - <span class="kind">def</span> - <span class="symbol"> - <span class="name">productIterator</span><span class="result">: <span class="extype" name="scala.collection.Iterator">Iterator</span>[<span class="extype" name="scala.Any">Any</span>]</span> - </span> - </h4> - - </li><li name="sims.geometry.Projection#productPrefix"> - <h4 class="signature"> - <span class="kind">def</span> - <span class="symbol"> - <span class="name">productPrefix</span><span class="result">: <span class="extype" name="java.lang.String">String</span></span> - </span> - </h4> - - </li><li name="sims.geometry.Projection#toString"> - <h4 class="signature"> - <span class="kind">def</span> - <span class="symbol"> - <span class="name">toString</span><span class="params">()</span><span class="result">: <span class="extype" name="java.lang.String">String</span></span> - </span> - </h4> - <p class="shortcomment cmt">Returns a string representation of the object</p><div class="fullcomment"> - <div class="comment cmt"><p>Returns a string representation of the object. -<p> -The default representation is platform dependent. -</p></div> - - - - - </div> - </li><li name="sims.geometry.Projection#upper"> - <h4 class="signature"> - <span class="kind">val</span> - <span class="symbol"> - <span class="name">upper</span><span class="result">: <span class="extype" name="scala.Double">Double</span></span> - </span> - </h4> - - </li></ol> - </div> - - <div class="members" id="constructors"> - <h3>Instance constructors</h3> - <ol><li name="sims.geometry.Projection#this"> - <h4 class="signature"> - <span class="kind">new</span> - <span class="symbol"> - <span class="name">Projection</span><span class="params">(<span name="axis">axis: <a href="Vector2D.html" class="extype" name="sims.geometry.Vector2D">Vector2D</a></span>, <span name="lower">lower: <span class="extype" name="scala.Double">Double</span></span>, <span name="upper">upper: <span class="extype" name="scala.Double">Double</span></span>)</span> - </span> - </h4> - - </li><li name="scala.AnyRef#this"> - <h4 class="signature"> - <span class="kind">new</span> - <span class="symbol"> - <span class="name">Projection</span><span class="params">()</span> - </span> - </h4> - - </li></ol> - </div> - - </div> - - </body> - </html>
\ No newline at end of file diff --git a/doc/sims/geometry/Ray.html b/doc/sims/geometry/Ray.html deleted file mode 100644 index d2a8ec8..0000000 --- a/doc/sims/geometry/Ray.html +++ /dev/null @@ -1,253 +0,0 @@ -<?xml version='1.0' encoding='UTF-8'?> -<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.1//EN" "http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd"> -<html> - <head> - <title>Scaladoc for sims.geometry.Ray</title> - <meta http-equiv="content-type" content="text/html; charset=UTF-8" /> - <script type="text/javascript" src="../../lib/jquery.js"></script> - - <style type="text/css"> - @import url(../../lib/template.css) screen; - </style> - <script type="text/javascript" src="../../lib/template.js"></script> - - </head> - <body class="type"> - - <p id="owner"><a href="../package.html">sims</a>.<a href="package.html">geometry</a></p> - - <div id="definition"> - <img src="../../lib/class_big.png" /> - <h1>Ray</h1> - </div> - - <h4 class="signature"> - <span class="kind">class</span> - <span class="symbol"> - <span class="name">Ray</span><span class="params">(<span name="point">point: <a href="Vector2D.html" class="extype" name="sims.geometry.Vector2D">Vector2D</a></span>, <span name="direction">direction: <a href="Vector2D.html" class="extype" name="sims.geometry.Vector2D">Vector2D</a></span>)</span><span class="result"> extends <span class="extype" name="scala.Product">Product</span></span> - </span> - </h4> - <div class="fullcomment" id="comment"> - <div class="comment cmt"><p>A ray.</p></div> - <dl class="paramcmts block"><dt class="param">point</dt><dd class="cmt"><p>a point on the ray</p></dd><dt class="param">direction</dt><dd class="cmt"><p>this ray's directional vector</p></dd></dl> - - - - </div> - - <div id="template"> - - <div id="mbrsel"> - <div id="ancestors"> - <h3>Inherits</h3> - <ol><li class="in" name="scala.Product">Product</li><li class="in" name="scala.Equals">Equals</li><li class="in" name="scala.AnyRef">AnyRef</li><li class="in" name="scala.Any">Any</li></ol> - </div> - </div> - - - - <div class="members" id="values"> - <h3>Value Members</h3> - <ol><li name="sims.geometry.Ray#canEqual"> - <h4 class="signature"> - <span class="kind">def</span> - <span class="symbol"> - <span class="name">canEqual</span><span class="params">(<span name="arg0">arg0: <span class="extype" name="scala.Any">Any</span></span>)</span><span class="result">: <span class="extype" name="scala.Boolean">Boolean</span></span> - </span> - </h4> - - </li><li name="sims.geometry.Ray#contains"> - <h4 class="signature"> - <span class="kind">def</span> - <span class="symbol"> - <span class="name">contains</span><span class="params">(<span name="p">p: <a href="Vector2D.html" class="extype" name="sims.geometry.Vector2D">Vector2D</a></span>)</span><span class="result">: <span class="extype" name="scala.Boolean">Boolean</span></span> - </span> - </h4> - <p class="shortcomment cmt">Checks if this ray contains the point <code>p</code></p><div class="fullcomment"> - <div class="comment cmt"><p>Checks if this ray contains the point <code>p</code>.</p></div> - - - - - </div> - </li><li name="sims.geometry.Ray#direction"> - <h4 class="signature"> - <span class="kind">val</span> - <span class="symbol"> - <span class="name">direction</span><span class="result">: <a href="Vector2D.html" class="extype" name="sims.geometry.Vector2D">Vector2D</a></span> - </span> - </h4> - - </li><li name="sims.geometry.Ray#equals"> - <h4 class="signature"> - <span class="kind">def</span> - <span class="symbol"> - <span class="name">equals</span><span class="params">(<span name="arg0">arg0: <span class="extype" name="scala.Any">Any</span></span>)</span><span class="result">: <span class="extype" name="scala.Boolean">Boolean</span></span> - </span> - </h4> - <p class="shortcomment cmt">This method is used to compare the receiver object (<code>this</code>) -with the argument object (<code>arg0</code>) for equivalence</p><div class="fullcomment"> - <div class="comment cmt"><p>This method is used to compare the receiver object (<code>this</code>) -with the argument object (<code>arg0</code>) for equivalence.</p><p><p> -The default implementations of this method is an <a -href="http://en.wikipedia.org/wiki/Equivalence_relation">equivalence -relation</a>: - <ul> - <li>It is reflexive: for any instance <code>x</code> of type <code>Any</code>, - <code>x.equals(x)</code> should return <code>true</code>.</li> - <li>It is symmetric: for any instances <code>x</code> and <code>y</code> of type - <code>Any</code>, <code>x.equals(y)</code> should return <code>true</code> if and only - if <code>y.equals(x)</code> returns <code>true</code>.</li> - <li>It is transitive: for any instances - <code>x</code>, <code>y</code>, and <code>z</code> of type <code>AnyRef</code> - if <code>x.equals(y)</code> returns <code>true</code> and - <code>y.equals(z)</code> returns - <code>true</code>, then <code>x.equals(z)</code> should return <code>true</code>.</li> -</ul> -</p></p><p><p> -If you override this method, you should verify that -your implementation remains an equivalence relation. -Additionally, when overriding this method it is often necessary to -override <code>hashCode</code> to ensure that objects that are -"equal" (<code>o1.equals(o2)</code> returns <code>true</code>) -hash to the same <a href="Int.html"><code>Int</code></a> -(<code>o1.hashCode.equals(o2.hashCode)</code>). -</p></div> - <dl class="paramcmts block"><dt class="param">arg0</dt><dd class="cmt"><p>the object to compare against this object for equality.</p></dd><dt>returns</dt><dd class="cmt"><p><code>true</code> if the receiver object is equivalent to the argument; <code>false</code> otherwise. -</p></p></dd></dl> - - - - </div> - </li><li name="sims.geometry.Ray#hashCode"> - <h4 class="signature"> - <span class="kind">def</span> - <span class="symbol"> - <span class="name">hashCode</span><span class="params">()</span><span class="result">: <span class="extype" name="scala.Int">Int</span></span> - </span> - </h4> - <p class="shortcomment cmt">Returns a hash code value for the object</p><div class="fullcomment"> - <div class="comment cmt"><p>Returns a hash code value for the object.</p><p><p> -The default hashing algorithm is platform dependent.</p><p>Note that it is allowed for two objects to have identical hash -codes (<code>o1.hashCode.equals(o2.hashCode)</code>) yet not be -equal (<code>o1.equals(o2)</code> returns <code>false</code>). A -degenerate implementation could always return <code>0</code>. -However, it is required that if two objects are equal -(<code>o1.equals(o2)</code> returns <code>true</code>) that they -have identical hash codes -(<code>o1.hashCode.equals(o2.hashCode)</code>). Therefore, when -overriding this method, be sure to verify that the behavior is -consistent with the <code>equals</code> method. -</p></p><p><p></p></div> - - - - - </div> - </li><li name="sims.geometry.Ray#intersects"> - <h4 class="signature"> - <span class="kind">def</span> - <span class="symbol"> - <span class="name">intersects</span><span class="params">(<span name="s">s: <a href="Segment.html" class="extype" name="sims.geometry.Segment">Segment</a></span>)</span><span class="result">: <span class="extype" name="scala.Boolean">Boolean</span></span> - </span> - </h4> - <p class="shortcomment cmt">Checks this ray and the given segment for intersection</p><div class="fullcomment"> - <div class="comment cmt"><p>Checks this ray and the given segment for intersection.</p></div> - <dl class="paramcmts block"><dt class="param">s</dt><dd class="cmt"><p>the segment to test for intersection</p></dd></dl> - - - - </div> - </li><li name="sims.geometry.Ray#point"> - <h4 class="signature"> - <span class="kind">val</span> - <span class="symbol"> - <span class="name">point</span><span class="result">: <a href="Vector2D.html" class="extype" name="sims.geometry.Vector2D">Vector2D</a></span> - </span> - </h4> - - </li><li name="sims.geometry.Ray#productArity"> - <h4 class="signature"> - <span class="kind">def</span> - <span class="symbol"> - <span class="name">productArity</span><span class="result">: <span class="extype" name="scala.Int">Int</span></span> - </span> - </h4> - - </li><li name="sims.geometry.Ray#productElement"> - <h4 class="signature"> - <span class="kind">def</span> - <span class="symbol"> - <span class="name">productElement</span><span class="params">(<span name="arg0">arg0: <span class="extype" name="scala.Int">Int</span></span>)</span><span class="result">: <span class="extype" name="scala.Any">Any</span></span> - </span> - </h4> - - </li><li name="scala.Product#productElements"> - <h4 class="signature"> - <span class="kind">def</span> - <span class="symbol"> - <span class="name">productElements</span><span class="result">: <span class="extype" name="scala.collection.Iterator">Iterator</span>[<span class="extype" name="scala.Any">Any</span>]</span> - </span> - </h4> - - </li><li name="scala.Product#productIterator"> - <h4 class="signature"> - <span class="kind">def</span> - <span class="symbol"> - <span class="name">productIterator</span><span class="result">: <span class="extype" name="scala.collection.Iterator">Iterator</span>[<span class="extype" name="scala.Any">Any</span>]</span> - </span> - </h4> - - </li><li name="sims.geometry.Ray#productPrefix"> - <h4 class="signature"> - <span class="kind">def</span> - <span class="symbol"> - <span class="name">productPrefix</span><span class="result">: <span class="extype" name="java.lang.String">String</span></span> - </span> - </h4> - - </li><li name="sims.geometry.Ray#toString"> - <h4 class="signature"> - <span class="kind">def</span> - <span class="symbol"> - <span class="name">toString</span><span class="params">()</span><span class="result">: <span class="extype" name="java.lang.String">String</span></span> - </span> - </h4> - <p class="shortcomment cmt">Returns a string representation of the object</p><div class="fullcomment"> - <div class="comment cmt"><p>Returns a string representation of the object. -<p> -The default representation is platform dependent. -</p></div> - - - - - </div> - </li></ol> - </div> - - <div class="members" id="constructors"> - <h3>Instance constructors</h3> - <ol><li name="sims.geometry.Ray#this"> - <h4 class="signature"> - <span class="kind">new</span> - <span class="symbol"> - <span class="name">Ray</span><span class="params">(<span name="point">point: <a href="Vector2D.html" class="extype" name="sims.geometry.Vector2D">Vector2D</a></span>, <span name="direction">direction: <a href="Vector2D.html" class="extype" name="sims.geometry.Vector2D">Vector2D</a></span>)</span> - </span> - </h4> - - </li><li name="scala.AnyRef#this"> - <h4 class="signature"> - <span class="kind">new</span> - <span class="symbol"> - <span class="name">Ray</span><span class="params">()</span> - </span> - </h4> - - </li></ol> - </div> - - </div> - - </body> - </html>
\ No newline at end of file diff --git a/doc/sims/geometry/Segment.html b/doc/sims/geometry/Segment.html deleted file mode 100644 index 2d79999..0000000 --- a/doc/sims/geometry/Segment.html +++ /dev/null @@ -1,317 +0,0 @@ -<?xml version='1.0' encoding='UTF-8'?> -<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.1//EN" "http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd"> -<html> - <head> - <title>Scaladoc for sims.geometry.Segment</title> - <meta http-equiv="content-type" content="text/html; charset=UTF-8" /> - <script type="text/javascript" src="../../lib/jquery.js"></script> - - <style type="text/css"> - @import url(../../lib/template.css) screen; - </style> - <script type="text/javascript" src="../../lib/template.js"></script> - - </head> - <body class="type"> - - <p id="owner"><a href="../package.html">sims</a>.<a href="package.html">geometry</a></p> - - <div id="definition"> - <img src="../../lib/class_big.png" /> - <h1>Segment</h1> - </div> - - <h4 class="signature"> - <span class="kind">class</span> - <span class="symbol"> - <span class="name">Segment</span><span class="params">(<span name="vertex1">vertex1: <a href="Vector2D.html" class="extype" name="sims.geometry.Vector2D">Vector2D</a></span>, <span name="vertex2">vertex2: <a href="Vector2D.html" class="extype" name="sims.geometry.Vector2D">Vector2D</a></span>)</span><span class="result"> extends <span class="extype" name="scala.Product">Product</span></span> - </span> - </h4> - <div class="fullcomment" id="comment"> - <div class="comment cmt"><p>A segment is given by its vertices.</p></div> - <dl class="paramcmts block"><dt class="param">vertex1</dt><dd class="cmt"><p>position vector of the first vertex</p></dd><dt class="param">vertex2</dt><dd class="cmt"><p>position vector of the second vertex</p></dd></dl> - - - - </div> - - <div id="template"> - - <div id="mbrsel"> - <div id="ancestors"> - <h3>Inherits</h3> - <ol><li class="in" name="scala.Product">Product</li><li class="in" name="scala.Equals">Equals</li><li class="in" name="scala.AnyRef">AnyRef</li><li class="in" name="scala.Any">Any</li></ol> - </div> - </div> - - - - <div class="members" id="values"> - <h3>Value Members</h3> - <ol><li name="sims.geometry.Segment#canEqual"> - <h4 class="signature"> - <span class="kind">def</span> - <span class="symbol"> - <span class="name">canEqual</span><span class="params">(<span name="arg0">arg0: <span class="extype" name="scala.Any">Any</span></span>)</span><span class="result">: <span class="extype" name="scala.Boolean">Boolean</span></span> - </span> - </h4> - - </li><li name="sims.geometry.Segment#clipToSegment"> - <h4 class="signature"> - <span class="kind">def</span> - <span class="symbol"> - <span class="name">clipToSegment</span><span class="params">(<span name="s">s: <a href="" class="extype" name="sims.geometry.Segment">Segment</a></span>)</span><span class="result">: <span class="extype" name="scala.Option">Option</span>[<a href="Vector2D.html" class="extype" name="sims.geometry.Vector2D">Vector2D</a>]</span> - </span> - </h4> - - </li><li name="sims.geometry.Segment#d"> - <h4 class="signature"> - <span class="kind">val</span> - <span class="symbol"> - <span class="name">d</span><span class="result">: <a href="Vector2D.html" class="extype" name="sims.geometry.Vector2D">Vector2D</a></span> - </span> - </h4> - <p class="shortcomment cmt">Vector from <code>vertex1</code> to <code>vertex2</code></p><div class="fullcomment"> - <div class="comment cmt"><p>Vector from <code>vertex1</code> to <code>vertex2</code>.</p></div> - - - - - </div> - </li><li name="sims.geometry.Segment#d0"> - <h4 class="signature"> - <span class="kind">val</span> - <span class="symbol"> - <span class="name">d0</span><span class="result">: <a href="Vector2D.html" class="extype" name="sims.geometry.Vector2D">Vector2D</a></span> - </span> - </h4> - <p class="shortcomment cmt">Unit directional vector</p><div class="fullcomment"> - <div class="comment cmt"><p>Unit directional vector.</p></div> - - - - - </div> - </li><li name="sims.geometry.Segment#distance"> - <h4 class="signature"> - <span class="kind">def</span> - <span class="symbol"> - <span class="name">distance</span><span class="params">(<span name="point">point: <a href="Vector2D.html" class="extype" name="sims.geometry.Vector2D">Vector2D</a></span>)</span><span class="result">: <span class="extype" name="scala.Double">Double</span></span> - </span> - </h4> - <p class="shortcomment cmt">Smallest distance between this segment and the point <code>point</code></p><div class="fullcomment"> - <div class="comment cmt"><p>Smallest distance between this segment and the point <code>point</code>.</p></div> - - - - - </div> - </li><li name="sims.geometry.Segment#equals"> - <h4 class="signature"> - <span class="kind">def</span> - <span class="symbol"> - <span class="name">equals</span><span class="params">(<span name="arg0">arg0: <span class="extype" name="scala.Any">Any</span></span>)</span><span class="result">: <span class="extype" name="scala.Boolean">Boolean</span></span> - </span> - </h4> - <p class="shortcomment cmt">This method is used to compare the receiver object (<code>this</code>) -with the argument object (<code>arg0</code>) for equivalence</p><div class="fullcomment"> - <div class="comment cmt"><p>This method is used to compare the receiver object (<code>this</code>) -with the argument object (<code>arg0</code>) for equivalence.</p><p><p> -The default implementations of this method is an <a -href="http://en.wikipedia.org/wiki/Equivalence_relation">equivalence -relation</a>: - <ul> - <li>It is reflexive: for any instance <code>x</code> of type <code>Any</code>, - <code>x.equals(x)</code> should return <code>true</code>.</li> - <li>It is symmetric: for any instances <code>x</code> and <code>y</code> of type - <code>Any</code>, <code>x.equals(y)</code> should return <code>true</code> if and only - if <code>y.equals(x)</code> returns <code>true</code>.</li> - <li>It is transitive: for any instances - <code>x</code>, <code>y</code>, and <code>z</code> of type <code>AnyRef</code> - if <code>x.equals(y)</code> returns <code>true</code> and - <code>y.equals(z)</code> returns - <code>true</code>, then <code>x.equals(z)</code> should return <code>true</code>.</li> -</ul> -</p></p><p><p> -If you override this method, you should verify that -your implementation remains an equivalence relation. -Additionally, when overriding this method it is often necessary to -override <code>hashCode</code> to ensure that objects that are -"equal" (<code>o1.equals(o2)</code> returns <code>true</code>) -hash to the same <a href="Int.html"><code>Int</code></a> -(<code>o1.hashCode.equals(o2.hashCode)</code>). -</p></div> - <dl class="paramcmts block"><dt class="param">arg0</dt><dd class="cmt"><p>the object to compare against this object for equality.</p></dd><dt>returns</dt><dd class="cmt"><p><code>true</code> if the receiver object is equivalent to the argument; <code>false</code> otherwise. -</p></p></dd></dl> - - - - </div> - </li><li name="sims.geometry.Segment#hashCode"> - <h4 class="signature"> - <span class="kind">def</span> - <span class="symbol"> - <span class="name">hashCode</span><span class="params">()</span><span class="result">: <span class="extype" name="scala.Int">Int</span></span> - </span> - </h4> - <p class="shortcomment cmt">Returns a hash code value for the object</p><div class="fullcomment"> - <div class="comment cmt"><p>Returns a hash code value for the object.</p><p><p> -The default hashing algorithm is platform dependent.</p><p>Note that it is allowed for two objects to have identical hash -codes (<code>o1.hashCode.equals(o2.hashCode)</code>) yet not be -equal (<code>o1.equals(o2)</code> returns <code>false</code>). A -degenerate implementation could always return <code>0</code>. -However, it is required that if two objects are equal -(<code>o1.equals(o2)</code> returns <code>true</code>) that they -have identical hash codes -(<code>o1.hashCode.equals(o2.hashCode)</code>). Therefore, when -overriding this method, be sure to verify that the behavior is -consistent with the <code>equals</code> method. -</p></p><p><p></p></div> - - - - - </div> - </li><li name="sims.geometry.Segment#length"> - <h4 class="signature"> - <span class="kind">val</span> - <span class="symbol"> - <span class="name">length</span><span class="result">: <span class="extype" name="scala.Double">Double</span></span> - </span> - </h4> - <p class="shortcomment cmt">Length of this segment</p><div class="fullcomment"> - <div class="comment cmt"><p>Length of this segment.</p></div> - - - - - </div> - </li><li name="sims.geometry.Segment#n"> - <h4 class="signature"> - <span class="kind">val</span> - <span class="symbol"> - <span class="name">n</span><span class="result">: <a href="Vector2D.html" class="extype" name="sims.geometry.Vector2D">Vector2D</a></span> - </span> - </h4> - <p class="shortcomment cmt">Right normal vector</p><div class="fullcomment"> - <div class="comment cmt"><p>Right normal vector.</p></div> - - - - - </div> - </li><li name="sims.geometry.Segment#n0"> - <h4 class="signature"> - <span class="kind">val</span> - <span class="symbol"> - <span class="name">n0</span><span class="result">: <a href="Vector2D.html" class="extype" name="sims.geometry.Vector2D">Vector2D</a></span> - </span> - </h4> - <p class="shortcomment cmt">Right normal unit vector</p><div class="fullcomment"> - <div class="comment cmt"><p>Right normal unit vector.</p></div> - - - - - </div> - </li><li name="sims.geometry.Segment#productArity"> - <h4 class="signature"> - <span class="kind">def</span> - <span class="symbol"> - <span class="name">productArity</span><span class="result">: <span class="extype" name="scala.Int">Int</span></span> - </span> - </h4> - - </li><li name="sims.geometry.Segment#productElement"> - <h4 class="signature"> - <span class="kind">def</span> - <span class="symbol"> - <span class="name">productElement</span><span class="params">(<span name="arg0">arg0: <span class="extype" name="scala.Int">Int</span></span>)</span><span class="result">: <span class="extype" name="scala.Any">Any</span></span> - </span> - </h4> - - </li><li name="scala.Product#productElements"> - <h4 class="signature"> - <span class="kind">def</span> - <span class="symbol"> - <span class="name">productElements</span><span class="result">: <span class="extype" name="scala.collection.Iterator">Iterator</span>[<span class="extype" name="scala.Any">Any</span>]</span> - </span> - </h4> - - </li><li name="scala.Product#productIterator"> - <h4 class="signature"> - <span class="kind">def</span> - <span class="symbol"> - <span class="name">productIterator</span><span class="result">: <span class="extype" name="scala.collection.Iterator">Iterator</span>[<span class="extype" name="scala.Any">Any</span>]</span> - </span> - </h4> - - </li><li name="sims.geometry.Segment#productPrefix"> - <h4 class="signature"> - <span class="kind">def</span> - <span class="symbol"> - <span class="name">productPrefix</span><span class="result">: <span class="extype" name="java.lang.String">String</span></span> - </span> - </h4> - - </li><li name="sims.geometry.Segment#toString"> - <h4 class="signature"> - <span class="kind">def</span> - <span class="symbol"> - <span class="name">toString</span><span class="params">()</span><span class="result">: <span class="extype" name="java.lang.String">String</span></span> - </span> - </h4> - <p class="shortcomment cmt">Returns a string representation of the object</p><div class="fullcomment"> - <div class="comment cmt"><p>Returns a string representation of the object. -<p> -The default representation is platform dependent. -</p></div> - - - - - </div> - </li><li name="sims.geometry.Segment#vertex1"> - <h4 class="signature"> - <span class="kind">val</span> - <span class="symbol"> - <span class="name">vertex1</span><span class="result">: <a href="Vector2D.html" class="extype" name="sims.geometry.Vector2D">Vector2D</a></span> - </span> - </h4> - - </li><li name="sims.geometry.Segment#vertex2"> - <h4 class="signature"> - <span class="kind">val</span> - <span class="symbol"> - <span class="name">vertex2</span><span class="result">: <a href="Vector2D.html" class="extype" name="sims.geometry.Vector2D">Vector2D</a></span> - </span> - </h4> - - </li></ol> - </div> - - <div class="members" id="constructors"> - <h3>Instance constructors</h3> - <ol><li name="sims.geometry.Segment#this"> - <h4 class="signature"> - <span class="kind">new</span> - <span class="symbol"> - <span class="name">Segment</span><span class="params">(<span name="vertex1">vertex1: <a href="Vector2D.html" class="extype" name="sims.geometry.Vector2D">Vector2D</a></span>, <span name="vertex2">vertex2: <a href="Vector2D.html" class="extype" name="sims.geometry.Vector2D">Vector2D</a></span>)</span> - </span> - </h4> - - </li><li name="scala.AnyRef#this"> - <h4 class="signature"> - <span class="kind">new</span> - <span class="symbol"> - <span class="name">Segment</span><span class="params">()</span> - </span> - </h4> - - </li></ol> - </div> - - </div> - - </body> - </html>
\ No newline at end of file diff --git a/doc/sims/geometry/Vector2D$.html b/doc/sims/geometry/Vector2D$.html deleted file mode 100644 index 52ef68b..0000000 --- a/doc/sims/geometry/Vector2D$.html +++ /dev/null @@ -1,190 +0,0 @@ -<?xml version='1.0' encoding='UTF-8'?> -<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.1//EN" "http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd"> -<html> - <head> - <title>Scaladoc for sims.geometry.Vector2D</title> - <meta http-equiv="content-type" content="text/html; charset=UTF-8" /> - <script type="text/javascript" src="../../lib/jquery.js"></script> - - <style type="text/css"> - @import url(../../lib/template.css) screen; - </style> - <script type="text/javascript" src="../../lib/template.js"></script> - - </head> - <body class="value"> - - <p id="owner"><a href="../package.html">sims</a>.<a href="package.html">geometry</a></p> - - <div id="definition"> - <img src="../../lib/object_big.png" /> - <h1>Vector2D</h1> - </div> - - <h4 class="signature"> - <span class="kind">object</span> - <span class="symbol"> - <span class="name">Vector2D</span><span class="result"> extends AnyRef</span> - </span> - </h4> - <div class="fullcomment" id="comment"> - <div class="comment cmt"><p>Contains special vectors.</p></div> - - - - - </div> - - <div id="template"> - - <div id="mbrsel"> - <div id="ancestors"> - <h3>Inherits</h3> - <ol><li class="in" name="scala.AnyRef">AnyRef</li><li class="in" name="scala.Any">Any</li></ol> - </div> - </div> - - - - <div class="members" id="values"> - <h3>Value Members</h3> - <ol><li name="sims.geometry.Vector2D#Null"> - <h4 class="signature"> - <span class="kind">val</span> - <span class="symbol"> - <span class="name">Null</span><span class="result">: <a href="Vector2D.html" class="extype" name="sims.geometry.Vector2D">Vector2D</a></span> - </span> - </h4> - <p class="shortcomment cmt">Null vector</p><div class="fullcomment"> - <div class="comment cmt"><p>Null vector.</p></div> - - - - - </div> - </li><li name="scala.AnyRef#equals"> - <h4 class="signature"> - <span class="kind">def</span> - <span class="symbol"> - <span class="name">equals</span><span class="params">(<span name="arg0">arg0: <span class="extype" name="scala.Any">Any</span></span>)</span><span class="result">: <span class="extype" name="scala.Boolean">Boolean</span></span> - </span> - </h4> - <p class="shortcomment cmt">This method is used to compare the receiver object (<code>this</code>) -with the argument object (<code>arg0</code>) for equivalence</p><div class="fullcomment"> - <div class="comment cmt"><p>This method is used to compare the receiver object (<code>this</code>) -with the argument object (<code>arg0</code>) for equivalence.</p><p><p> -The default implementations of this method is an <a -href="http://en.wikipedia.org/wiki/Equivalence_relation">equivalence -relation</a>: - <ul> - <li>It is reflexive: for any instance <code>x</code> of type <code>Any</code>, - <code>x.equals(x)</code> should return <code>true</code>.</li> - <li>It is symmetric: for any instances <code>x</code> and <code>y</code> of type - <code>Any</code>, <code>x.equals(y)</code> should return <code>true</code> if and only - if <code>y.equals(x)</code> returns <code>true</code>.</li> - <li>It is transitive: for any instances - <code>x</code>, <code>y</code>, and <code>z</code> of type <code>AnyRef</code> - if <code>x.equals(y)</code> returns <code>true</code> and - <code>y.equals(z)</code> returns - <code>true</code>, then <code>x.equals(z)</code> should return <code>true</code>.</li> -</ul> -</p></p><p><p> -If you override this method, you should verify that -your implementation remains an equivalence relation. -Additionally, when overriding this method it is often necessary to -override <code>hashCode</code> to ensure that objects that are -"equal" (<code>o1.equals(o2)</code> returns <code>true</code>) -hash to the same <a href="Int.html"><code>Int</code></a> -(<code>o1.hashCode.equals(o2.hashCode)</code>). -</p></div> - <dl class="paramcmts block"><dt class="param">arg0</dt><dd class="cmt"><p>the object to compare against this object for equality.</p></dd><dt>returns</dt><dd class="cmt"><p><code>true</code> if the receiver object is equivalent to the argument; <code>false</code> otherwise. -</p></p></dd></dl> - - <div class="block"> - definition classes: AnyRef ⇐ Any - </div> - - </div> - </li><li name="scala.AnyRef#hashCode"> - <h4 class="signature"> - <span class="kind">def</span> - <span class="symbol"> - <span class="name">hashCode</span><span class="params">()</span><span class="result">: <span class="extype" name="scala.Int">Int</span></span> - </span> - </h4> - <p class="shortcomment cmt">Returns a hash code value for the object</p><div class="fullcomment"> - <div class="comment cmt"><p>Returns a hash code value for the object.</p><p><p> -The default hashing algorithm is platform dependent.</p><p>Note that it is allowed for two objects to have identical hash -codes (<code>o1.hashCode.equals(o2.hashCode)</code>) yet not be -equal (<code>o1.equals(o2)</code> returns <code>false</code>). A -degenerate implementation could always return <code>0</code>. -However, it is required that if two objects are equal -(<code>o1.equals(o2)</code> returns <code>true</code>) that they -have identical hash codes -(<code>o1.hashCode.equals(o2.hashCode)</code>). Therefore, when -overriding this method, be sure to verify that the behavior is -consistent with the <code>equals</code> method. -</p></p><p><p></p></div> - - - <div class="block"> - definition classes: AnyRef ⇐ Any - </div> - - </div> - </li><li name="sims.geometry.Vector2D#i"> - <h4 class="signature"> - <span class="kind">val</span> - <span class="symbol"> - <span class="name">i</span><span class="result">: <a href="Vector2D.html" class="extype" name="sims.geometry.Vector2D">Vector2D</a></span> - </span> - </h4> - <p class="shortcomment cmt">Horizontal unit vector</p><div class="fullcomment"> - <div class="comment cmt"><p>Horizontal unit vector. (1,0)</p></div> - - - - - </div> - </li><li name="sims.geometry.Vector2D#j"> - <h4 class="signature"> - <span class="kind">val</span> - <span class="symbol"> - <span class="name">j</span><span class="result">: <a href="Vector2D.html" class="extype" name="sims.geometry.Vector2D">Vector2D</a></span> - </span> - </h4> - <p class="shortcomment cmt">Vertical unit vector</p><div class="fullcomment"> - <div class="comment cmt"><p>Vertical unit vector. (0,1)</p></div> - - - - - </div> - </li><li name="scala.AnyRef#toString"> - <h4 class="signature"> - <span class="kind">def</span> - <span class="symbol"> - <span class="name">toString</span><span class="params">()</span><span class="result">: <span class="extype" name="java.lang.String">String</span></span> - </span> - </h4> - <p class="shortcomment cmt">Returns a string representation of the object</p><div class="fullcomment"> - <div class="comment cmt"><p>Returns a string representation of the object. -<p> -The default representation is platform dependent. -</p></div> - - - <div class="block"> - definition classes: AnyRef ⇐ Any - </div> - - </div> - </li></ol> - </div> - - - - </div> - - </body> - </html>
\ No newline at end of file diff --git a/doc/sims/geometry/Vector2D.html b/doc/sims/geometry/Vector2D.html deleted file mode 100644 index 990b144..0000000 --- a/doc/sims/geometry/Vector2D.html +++ /dev/null @@ -1,435 +0,0 @@ -<?xml version='1.0' encoding='UTF-8'?> -<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.1//EN" "http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd"> -<html> - <head> - <title>Scaladoc for sims.geometry.Vector2D</title> - <meta http-equiv="content-type" content="text/html; charset=UTF-8" /> - <script type="text/javascript" src="../../lib/jquery.js"></script> - - <style type="text/css"> - @import url(../../lib/template.css) screen; - </style> - <script type="text/javascript" src="../../lib/template.js"></script> - - </head> - <body class="type"> - - <p id="owner"><a href="../package.html">sims</a>.<a href="package.html">geometry</a></p> - - <div id="definition"> - <img src="../../lib/class_big.png" /> - <h1>Vector2D</h1> - </div> - - <h4 class="signature"> - <span class="kind">class</span> - <span class="symbol"> - <span class="name">Vector2D</span><span class="params">(<span name="x">x: <span class="extype" name="scala.Double">Double</span></span>, <span name="y">y: <span class="extype" name="scala.Double">Double</span></span>)</span><span class="result"> extends <span class="extype" name="scala.Product">Product</span></span> - </span> - </h4> - <div class="fullcomment" id="comment"> - <div class="comment cmt"><p>A 2D vector.</p></div> - <dl class="paramcmts block"><dt class="param">x</dt><dd class="cmt"><p>1st component</p></dd><dt class="param">y</dt><dd class="cmt"><p>2nd component</p></dd></dl> - - - - </div> - - <div id="template"> - - <div id="mbrsel"> - <div id="ancestors"> - <h3>Inherits</h3> - <ol><li class="in" name="scala.Product">Product</li><li class="in" name="scala.Equals">Equals</li><li class="in" name="scala.AnyRef">AnyRef</li><li class="in" name="scala.Any">Any</li></ol> - </div> - </div> - - - - <div class="members" id="values"> - <h3>Value Members</h3> - <ol><li name="sims.geometry.Vector2D#*"> - <h4 class="signature"> - <span class="kind">def</span> - <span class="symbol"> - <span class="name">*</span><span class="params">(<span name="n">n: <span class="extype" name="scala.Double">Double</span></span>)</span><span class="result">: <a href="" class="extype" name="sims.geometry.Vector2D">Vector2D</a></span> - </span> - </h4> - <p class="shortcomment cmt">Scalar multiplication</p><div class="fullcomment"> - <div class="comment cmt"><p>Scalar multiplication.</p></div> - - - - - </div> - </li><li name="sims.geometry.Vector2D#+"> - <h4 class="signature"> - <span class="kind">def</span> - <span class="symbol"> - <span class="name">+</span><span class="params">(<span name="v">v: <a href="" class="extype" name="sims.geometry.Vector2D">Vector2D</a></span>)</span><span class="result">: <a href="" class="extype" name="sims.geometry.Vector2D">Vector2D</a></span> - </span> - </h4> - <p class="shortcomment cmt">Vector addition</p><div class="fullcomment"> - <div class="comment cmt"><p>Vector addition.</p></div> - - - - - </div> - </li><li name="sims.geometry.Vector2D#-"> - <h4 class="signature"> - <span class="kind">def</span> - <span class="symbol"> - <span class="name">-</span><span class="params">(<span name="v">v: <a href="" class="extype" name="sims.geometry.Vector2D">Vector2D</a></span>)</span><span class="result">: <a href="" class="extype" name="sims.geometry.Vector2D">Vector2D</a></span> - </span> - </h4> - <p class="shortcomment cmt">Vector substraction</p><div class="fullcomment"> - <div class="comment cmt"><p>Vector substraction.</p></div> - - - - - </div> - </li><li name="sims.geometry.Vector2D#/"> - <h4 class="signature"> - <span class="kind">def</span> - <span class="symbol"> - <span class="name">/</span><span class="params">(<span name="n">n: <span class="extype" name="scala.Double">Double</span></span>)</span><span class="result">: <a href="" class="extype" name="sims.geometry.Vector2D">Vector2D</a></span> - </span> - </h4> - <p class="shortcomment cmt">Scalar division</p><div class="fullcomment"> - <div class="comment cmt"><p>Scalar division.</p></div> - - - - - </div> - </li><li name="sims.geometry.Vector2D#canEqual"> - <h4 class="signature"> - <span class="kind">def</span> - <span class="symbol"> - <span class="name">canEqual</span><span class="params">(<span name="arg0">arg0: <span class="extype" name="scala.Any">Any</span></span>)</span><span class="result">: <span class="extype" name="scala.Boolean">Boolean</span></span> - </span> - </h4> - - </li><li name="sims.geometry.Vector2D#components"> - <h4 class="signature"> - <span class="kind">def</span> - <span class="symbol"> - <span class="name">components</span><span class="result">: <span class="extype" name="scala.collection.immutable.List">List</span>[<span class="extype" name="scala.Double">Double</span>]</span> - </span> - </h4> - <p class="shortcomment cmt">Returns a list of this vector's components</p><div class="fullcomment"> - <div class="comment cmt"><p>Returns a list of this vector's components.</p></div> - - - - - </div> - </li><li name="sims.geometry.Vector2D#cross"> - <h4 class="signature"> - <span class="kind">def</span> - <span class="symbol"> - <span class="name">cross</span><span class="params">(<span name="v">v: <a href="" class="extype" name="sims.geometry.Vector2D">Vector2D</a></span>)</span><span class="result">: <span class="extype" name="scala.Double">Double</span></span> - </span> - </h4> - <p class="shortcomment cmt">Cross product</p><div class="fullcomment"> - <div class="comment cmt"><p>Cross product. Length only because in 2D. The direction would be given by the x3-axis.</p></div> - - - - - </div> - </li><li name="sims.geometry.Vector2D#dot"> - <h4 class="signature"> - <span class="kind">def</span> - <span class="symbol"> - <span class="name">dot</span><span class="params">(<span name="v">v: <a href="" class="extype" name="sims.geometry.Vector2D">Vector2D</a></span>)</span><span class="result">: <span class="extype" name="scala.Double">Double</span></span> - </span> - </h4> - <p class="shortcomment cmt">Dot product</p><div class="fullcomment"> - <div class="comment cmt"><p>Dot product.</p></div> - - - - - </div> - </li><li name="sims.geometry.Vector2D#equals"> - <h4 class="signature"> - <span class="kind">def</span> - <span class="symbol"> - <span class="name">equals</span><span class="params">(<span name="arg0">arg0: <span class="extype" name="scala.Any">Any</span></span>)</span><span class="result">: <span class="extype" name="scala.Boolean">Boolean</span></span> - </span> - </h4> - <p class="shortcomment cmt">This method is used to compare the receiver object (<code>this</code>) -with the argument object (<code>arg0</code>) for equivalence</p><div class="fullcomment"> - <div class="comment cmt"><p>This method is used to compare the receiver object (<code>this</code>) -with the argument object (<code>arg0</code>) for equivalence.</p><p><p> -The default implementations of this method is an <a -href="http://en.wikipedia.org/wiki/Equivalence_relation">equivalence -relation</a>: - <ul> - <li>It is reflexive: for any instance <code>x</code> of type <code>Any</code>, - <code>x.equals(x)</code> should return <code>true</code>.</li> - <li>It is symmetric: for any instances <code>x</code> and <code>y</code> of type - <code>Any</code>, <code>x.equals(y)</code> should return <code>true</code> if and only - if <code>y.equals(x)</code> returns <code>true</code>.</li> - <li>It is transitive: for any instances - <code>x</code>, <code>y</code>, and <code>z</code> of type <code>AnyRef</code> - if <code>x.equals(y)</code> returns <code>true</code> and - <code>y.equals(z)</code> returns - <code>true</code>, then <code>x.equals(z)</code> should return <code>true</code>.</li> -</ul> -</p></p><p><p> -If you override this method, you should verify that -your implementation remains an equivalence relation. -Additionally, when overriding this method it is often necessary to -override <code>hashCode</code> to ensure that objects that are -"equal" (<code>o1.equals(o2)</code> returns <code>true</code>) -hash to the same <a href="Int.html"><code>Int</code></a> -(<code>o1.hashCode.equals(o2.hashCode)</code>). -</p></div> - <dl class="paramcmts block"><dt class="param">arg0</dt><dd class="cmt"><p>the object to compare against this object for equality.</p></dd><dt>returns</dt><dd class="cmt"><p><code>true</code> if the receiver object is equivalent to the argument; <code>false</code> otherwise. -</p></p></dd></dl> - - - - </div> - </li><li name="sims.geometry.Vector2D#hashCode"> - <h4 class="signature"> - <span class="kind">def</span> - <span class="symbol"> - <span class="name">hashCode</span><span class="params">()</span><span class="result">: <span class="extype" name="scala.Int">Int</span></span> - </span> - </h4> - <p class="shortcomment cmt">Returns a hash code value for the object</p><div class="fullcomment"> - <div class="comment cmt"><p>Returns a hash code value for the object.</p><p><p> -The default hashing algorithm is platform dependent.</p><p>Note that it is allowed for two objects to have identical hash -codes (<code>o1.hashCode.equals(o2.hashCode)</code>) yet not be -equal (<code>o1.equals(o2)</code> returns <code>false</code>). A -degenerate implementation could always return <code>0</code>. -However, it is required that if two objects are equal -(<code>o1.equals(o2)</code> returns <code>true</code>) that they -have identical hash codes -(<code>o1.hashCode.equals(o2.hashCode)</code>). Therefore, when -overriding this method, be sure to verify that the behavior is -consistent with the <code>equals</code> method. -</p></p><p><p></p></div> - - - - - </div> - </li><li name="sims.geometry.Vector2D#isNull"> - <h4 class="signature"> - <span class="kind">def</span> - <span class="symbol"> - <span class="name">isNull</span><span class="result">: <span class="extype" name="scala.Boolean">Boolean</span></span> - </span> - </h4> - <p class="shortcomment cmt">Checks if this vector is the null vector</p><div class="fullcomment"> - <div class="comment cmt"><p>Checks if this vector is the null vector.</p></div> - - - - - </div> - </li><li name="sims.geometry.Vector2D#leftNormal"> - <h4 class="signature"> - <span class="kind">def</span> - <span class="symbol"> - <span class="name">leftNormal</span><span class="result">: <a href="" class="extype" name="sims.geometry.Vector2D">Vector2D</a></span> - </span> - </h4> - <p class="shortcomment cmt">Left normal vector</p><div class="fullcomment"> - <div class="comment cmt"><p>Left normal vector. (-y, x)</p></div> - - - - - </div> - </li><li name="sims.geometry.Vector2D#length"> - <h4 class="signature"> - <span class="kind">val</span> - <span class="symbol"> - <span class="name">length</span><span class="result">: <span class="extype" name="scala.Double">Double</span></span> - </span> - </h4> - <p class="shortcomment cmt">Norm or length of this vector</p><div class="fullcomment"> - <div class="comment cmt"><p>Norm or length of this vector.</p></div> - - - - - </div> - </li><li name="sims.geometry.Vector2D#productArity"> - <h4 class="signature"> - <span class="kind">def</span> - <span class="symbol"> - <span class="name">productArity</span><span class="result">: <span class="extype" name="scala.Int">Int</span></span> - </span> - </h4> - - </li><li name="sims.geometry.Vector2D#productElement"> - <h4 class="signature"> - <span class="kind">def</span> - <span class="symbol"> - <span class="name">productElement</span><span class="params">(<span name="arg0">arg0: <span class="extype" name="scala.Int">Int</span></span>)</span><span class="result">: <span class="extype" name="scala.Any">Any</span></span> - </span> - </h4> - - </li><li name="scala.Product#productElements"> - <h4 class="signature"> - <span class="kind">def</span> - <span class="symbol"> - <span class="name">productElements</span><span class="result">: <span class="extype" name="scala.collection.Iterator">Iterator</span>[<span class="extype" name="scala.Any">Any</span>]</span> - </span> - </h4> - - </li><li name="scala.Product#productIterator"> - <h4 class="signature"> - <span class="kind">def</span> - <span class="symbol"> - <span class="name">productIterator</span><span class="result">: <span class="extype" name="scala.collection.Iterator">Iterator</span>[<span class="extype" name="scala.Any">Any</span>]</span> - </span> - </h4> - - </li><li name="sims.geometry.Vector2D#productPrefix"> - <h4 class="signature"> - <span class="kind">def</span> - <span class="symbol"> - <span class="name">productPrefix</span><span class="result">: <span class="extype" name="java.lang.String">String</span></span> - </span> - </h4> - - </li><li name="sims.geometry.Vector2D#project"> - <h4 class="signature"> - <span class="kind">def</span> - <span class="symbol"> - <span class="name">project</span><span class="params">(<span name="v">v: <a href="" class="extype" name="sims.geometry.Vector2D">Vector2D</a></span>)</span><span class="result">: <a href="" class="extype" name="sims.geometry.Vector2D">Vector2D</a></span> - </span> - </h4> - <p class="shortcomment cmt">Returns the projection of this vector onto the vector <code>v</code></p><div class="fullcomment"> - <div class="comment cmt"><p>Returns the projection of this vector onto the vector <code>v</code>.</p></div> - - - - - </div> - </li><li name="sims.geometry.Vector2D#rightNormal"> - <h4 class="signature"> - <span class="kind">def</span> - <span class="symbol"> - <span class="name">rightNormal</span><span class="result">: <a href="" class="extype" name="sims.geometry.Vector2D">Vector2D</a></span> - </span> - </h4> - <p class="shortcomment cmt">Right normal vector</p><div class="fullcomment"> - <div class="comment cmt"><p>Right normal vector. (y, -x)</p></div> - - - - - </div> - </li><li name="sims.geometry.Vector2D#rotate"> - <h4 class="signature"> - <span class="kind">def</span> - <span class="symbol"> - <span class="name">rotate</span><span class="params">(<span name="angle">angle: <span class="extype" name="scala.Double">Double</span></span>)</span><span class="result">: <a href="" class="extype" name="sims.geometry.Vector2D">Vector2D</a></span> - </span> - </h4> - <p class="shortcomment cmt">Returns a rotation of this vector by <code>angle</code> radian</p><div class="fullcomment"> - <div class="comment cmt"><p>Returns a rotation of this vector by <code>angle</code> radian.</p></div> - - - - - </div> - </li><li name="sims.geometry.Vector2D#toString"> - <h4 class="signature"> - <span class="kind">def</span> - <span class="symbol"> - <span class="name">toString</span><span class="params">()</span><span class="result">: <span class="extype" name="java.lang.String">String</span></span> - </span> - </h4> - <p class="shortcomment cmt">Returns a string representation of the object</p><div class="fullcomment"> - <div class="comment cmt"><p>Returns a string representation of the object. -<p> -The default representation is platform dependent. -</p></div> - - - - - </div> - </li><li name="sims.geometry.Vector2D#unary_-"> - <h4 class="signature"> - <span class="kind">def</span> - <span class="symbol"> - <span class="name">unary_-</span><span class="result">: <a href="" class="extype" name="sims.geometry.Vector2D">Vector2D</a></span> - </span> - </h4> - <p class="shortcomment cmt">Unary minus</p><div class="fullcomment"> - <div class="comment cmt"><p>Unary minus.</p></div> - - - - - </div> - </li><li name="sims.geometry.Vector2D#unit"> - <h4 class="signature"> - <span class="kind">def</span> - <span class="symbol"> - <span class="name">unit</span><span class="result">: <a href="" class="extype" name="sims.geometry.Vector2D">Vector2D</a></span> - </span> - </h4> - <p class="shortcomment cmt">Unit vector</p><div class="fullcomment"> - <div class="comment cmt"><p>Unit vector.</p></div> - - - - - </div> - </li><li name="sims.geometry.Vector2D#x"> - <h4 class="signature"> - <span class="kind">val</span> - <span class="symbol"> - <span class="name">x</span><span class="result">: <span class="extype" name="scala.Double">Double</span></span> - </span> - </h4> - - </li><li name="sims.geometry.Vector2D#y"> - <h4 class="signature"> - <span class="kind">val</span> - <span class="symbol"> - <span class="name">y</span><span class="result">: <span class="extype" name="scala.Double">Double</span></span> - </span> - </h4> - - </li></ol> - </div> - - <div class="members" id="constructors"> - <h3>Instance constructors</h3> - <ol><li name="sims.geometry.Vector2D#this"> - <h4 class="signature"> - <span class="kind">new</span> - <span class="symbol"> - <span class="name">Vector2D</span><span class="params">(<span name="x">x: <span class="extype" name="scala.Double">Double</span></span>, <span name="y">y: <span class="extype" name="scala.Double">Double</span></span>)</span> - </span> - </h4> - - </li><li name="scala.AnyRef#this"> - <h4 class="signature"> - <span class="kind">new</span> - <span class="symbol"> - <span class="name">Vector2D</span><span class="params">()</span> - </span> - </h4> - - </li></ol> - </div> - - </div> - - </body> - </html>
\ No newline at end of file diff --git a/doc/sims/geometry/package.html b/doc/sims/geometry/package.html deleted file mode 100644 index 7ae3ade..0000000 --- a/doc/sims/geometry/package.html +++ /dev/null @@ -1,105 +0,0 @@ -<?xml version='1.0' encoding='UTF-8'?> -<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.1//EN" "http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd"> -<html> - <head> - <title>Scaladoc for sims.geometry</title> - <meta http-equiv="content-type" content="text/html; charset=UTF-8" /> - <script type="text/javascript" src="../../lib/jquery.js"></script> - - <style type="text/css"> - @import url(../../lib/template.css) screen; - </style> - <script type="text/javascript" src="../../lib/template.js"></script> - - </head> - <body class="value"> - - <p id="owner"><a href="../package.html">sims</a></p> - - <div id="definition"> - <img src="../../lib/package_big.png" /> - <h1>geometry</h1> - </div> - - <h4 class="signature"> - <span class="kind">package</span> - <span class="symbol"> - <span class="name">geometry</span> - </span> - </h4> - <div class="fullcomment" id="comment"> - - - - - - </div> - - <div id="template"> - - - - <div class="members" id="types"> - <h3>Type Members</h3> - <ol><li name="sims.geometry.ConvexPolygon"> - <h4 class="signature"><a href="ConvexPolygon.html"> - <span class="kind">trait</span> - <span class="symbol"> - <span class="name">ConvexPolygon</span><span class="result"> extends AnyRef</span> - </span> - </a></h4> - <p class="comment cmt">Common properties of all convex polygons</p> - </li><li name="sims.geometry.Projection"> - <h4 class="signature"><a href="Projection.html"> - <span class="kind">class</span> - <span class="symbol"> - <span class="name">Projection</span><span class="params">(<span name="axis">axis: Vector2D</span>, <span name="lower">lower: Double</span>, <span name="upper">upper: Double</span>)</span><span class="result"> extends Product</span> - </span> - </a></h4> - <p class="comment cmt">Projection on an axis</p> - </li><li name="sims.geometry.Ray"> - <h4 class="signature"><a href="Ray.html"> - <span class="kind">class</span> - <span class="symbol"> - <span class="name">Ray</span><span class="params">(<span name="point">point: Vector2D</span>, <span name="direction">direction: Vector2D</span>)</span><span class="result"> extends Product</span> - </span> - </a></h4> - <p class="comment cmt">A ray</p> - </li><li name="sims.geometry.Segment"> - <h4 class="signature"><a href="Segment.html"> - <span class="kind">class</span> - <span class="symbol"> - <span class="name">Segment</span><span class="params">(<span name="vertex1">vertex1: Vector2D</span>, <span name="vertex2">vertex2: Vector2D</span>)</span><span class="result"> extends Product</span> - </span> - </a></h4> - <p class="comment cmt">A segment is given by its vertices</p> - </li><li name="sims.geometry.Vector2D"> - <h4 class="signature"><a href="Vector2D.html"> - <span class="kind">class</span> - <span class="symbol"> - <span class="name">Vector2D</span><span class="params">(<span name="x">x: Double</span>, <span name="y">y: Double</span>)</span><span class="result"> extends Product</span> - </span> - </a></h4> - <p class="comment cmt">A 2D vector</p> - </li></ol> - </div> - - <div class="members" id="values"> - <h3>Value Members</h3> - <ol><li name="sims.geometry.Vector2D"> - <h4 class="signature"><a href="Vector2D$.html"> - <span class="kind">object</span> - <span class="symbol"> - <span class="name">Vector2D</span><span class="result"> extends AnyRef</span> - </span> - </a></h4> - <p class="comment cmt">Contains special vectors</p> - </li></ol> - </div> - - - - </div> - - </body> - </html>
\ No newline at end of file |