diff options
author | Jakob Odersky <jodersky@gmail.com> | 2009-12-13 16:06:50 +0000 |
---|---|---|
committer | Jakob Odersky <jodersky@gmail.com> | 2009-12-13 16:06:50 +0000 |
commit | 66d338aec5d632927fa561a68310c8931938e9e0 (patch) | |
tree | 1e200fd94bb903772b007690da4e5d13fc46fb5b /doc/sims/geometry | |
parent | be2ee4dea92c5a4fc2329959d6e7272c50b221a6 (diff) | |
download | sims-66d338aec5d632927fa561a68310c8931938e9e0.tar.gz sims-66d338aec5d632927fa561a68310c8931938e9e0.tar.bz2 sims-66d338aec5d632927fa561a68310c8931938e9e0.zip |
Ported to scala 2.8.
Diffstat (limited to 'doc/sims/geometry')
-rw-r--r-- | doc/sims/geometry/ConvexPolygon.html | 412 | ||||
-rw-r--r-- | doc/sims/geometry/Projection$object.html | 82 | ||||
-rw-r--r-- | doc/sims/geometry/Projection.html | 569 | ||||
-rw-r--r-- | doc/sims/geometry/Ray$object.html | 82 | ||||
-rw-r--r-- | doc/sims/geometry/Ray.html | 565 | ||||
-rw-r--r-- | doc/sims/geometry/Segment$object.html | 82 | ||||
-rw-r--r-- | doc/sims/geometry/Segment.html | 743 | ||||
-rw-r--r-- | doc/sims/geometry/Vector2D$.html | 190 | ||||
-rw-r--r-- | doc/sims/geometry/Vector2D$object.html | 150 | ||||
-rw-r--r-- | doc/sims/geometry/Vector2D.html | 1047 | ||||
-rw-r--r-- | doc/sims/geometry/package.html | 105 |
11 files changed, 1742 insertions, 2285 deletions
diff --git a/doc/sims/geometry/ConvexPolygon.html b/doc/sims/geometry/ConvexPolygon.html index 5db8789..e3cdc96 100644 --- a/doc/sims/geometry/ConvexPolygon.html +++ b/doc/sims/geometry/ConvexPolygon.html @@ -1,210 +1,228 @@ -<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
+<?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>trait ConvexPolygon in sims.geometry</title> - <meta http-equiv="content-type" content="text/html; charset=UTF8"></meta><meta content="scaladoc (version 2.7.5.final)" name="generator"></meta><link href="../../style.css" type="text/css" rel="stylesheet"></link><script type="text/javascript" src="../../script.js"></script> + <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 onload="init()"> - <table summary="" class="navigation"> - <tr> - <td class="navigation-links" valign="top"> - <!-- <table><tr></tr></table> --> - </td> - <td align="right" valign="top" style="white-space:nowrap;" rowspan="2"> - <div class="doctitle-larger">SiMS</div> - </td> - </tr> - <tr><td></td></tr> - </table> - - <div class="entity"> - <a href="../../sims/geometry$package.html" target="_self">sims.geometry</a> - <br></br> - <span class="entity">trait ConvexPolygon</span> - </div><hr></hr> - <div class="source"> - [source: <a href="" class="sims/geometry/ConvexPolygon"><code>sims/geometry/ConvexPolygon.scala</code></a>] - </div><hr></hr> - <a name="ConvexPolygon"></a><dl> - <dt> - - <code></code> - <code>trait</code> - <em>ConvexPolygon</em> - </dt> - <dd><code> extends </code><a href="http://www.scala-lang.org/docu/files/api/scala/AnyRef.html" target="_self">AnyRef</a></dd> - </dl> - <dl><dd>Common properties of all convex polygons.</dd></dl> - <dl></dl> - <dl> - <dt style="margin:10px 0 0 20px;"><b>Direct Known Subclasses:</b></dt> - <dd><a href="../../sims/dynamics/Rectangle.html" target="_self">Rectangle</a>, <a href="../../sims/dynamics/RegularPolygon.html" target="_self">RegularPolygon</a></dd> - </dl><hr></hr> + <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> -<table summary="" cellpadding="3" class="member"> - <tr><td class="title" colspan="2">Method Summary</td></tr> - <tr> - <td class="modifiers" valign="top"> - <code> def</code> - </td> - <td class="signature"> - <em><a href="../../sims/geometry/ConvexPolygon.html#AABB" target="_self">AABB</a></em> - : <a href="../../sims/collision/AABB.html" target="_self">AABB</a> - - <div>Returns this polygon's axis aligned bounding box.</div> - </td> - </tr> -<tr> - <td class="modifiers" valign="top"> - <code> def</code> - </td> - <td class="signature"> - <em><a href="../../sims/geometry/ConvexPolygon.html#contains%28sims.geometry.Vector2D%29" target="_self">contains</a></em> - (<em>point</em> : <a href="../../sims/geometry/Vector2D.html" target="_self">Vector2D</a>) : <a href="http://www.scala-lang.org/docu/files/api/scala/Boolean.html" target="_self">Boolean</a> - - <div>Checks if the point <code>point</code> is contained in this polygon.</div> - </td> - </tr> -<tr> - <td class="modifiers" valign="top"> - <code> def</code> - </td> - <td class="signature"> - <em><a href="../../sims/geometry/ConvexPolygon.html#project%28sims.geometry.Vector2D%29" target="_self">project</a></em> - (<em>axis</em> : <a href="../../sims/geometry/Vector2D.html" target="_self">Vector2D</a>) : <a href="../../sims/geometry/Projection.html" target="_self">Projection</a> + <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>Returns the projection of this polygon onto the line given by the directional vector <code>axis</code>.</div> - </td> - </tr> -<tr> - <td class="modifiers" valign="top"> - <code> def</code> - </td> - <td class="signature"> - <em><a href="../../sims/geometry/ConvexPolygon.html#sides" target="_self">sides</a></em> - : <a href="" target="contentFrame" class="scala/Array">scala.Array</a>[<a href="../../sims/geometry/Segment.html" target="_self">Segment</a>] - <div>Returns all sides of this polygon. The sides are ordered counter-clockwise, the first vertex of the side
- giving the side index.</div> - </td> - </tr> -<tr> - <td class="modifiers" valign="top"> - <code>abstract def</code> - </td> - <td class="signature"> - <em><a href="../../sims/geometry/ConvexPolygon.html#vertices" target="_self">vertices</a></em> - : <a href="" target="contentFrame" class="scala/Seq">scala.Seq</a>[<a href="../../sims/geometry/Vector2D.html" target="_self">Vector2D</a>] - <div>Returns positions of all vertices of this Polygon. Vertices are ordered counter-clockwise.</div> - </td> - </tr> - </table><table summary="" cellpadding="3" class="inherited"> - <tr><td class="title" colspan="2"> - Methods inherited from <a href="http://www.scala-lang.org/docu/files/api/scala/AnyRef.html" target="_self">AnyRef</a> - </td></tr> - <tr><td class="signature" colspan="2"> - <a href="http://www.scala-lang.org/docu/files/api/scala/AnyRef.html#getClass%28%29" target="_self">getClass</a>, <a href="http://www.scala-lang.org/docu/files/api/scala/AnyRef.html#hashCode%28%29" target="_self">hashCode</a>, <a href="http://www.scala-lang.org/docu/files/api/scala/AnyRef.html#equals%28Any%29" target="_self">equals</a>, <a href="http://www.scala-lang.org/docu/files/api/scala/AnyRef.html#clone%28%29" target="_self">clone</a>, <a href="http://www.scala-lang.org/docu/files/api/scala/AnyRef.html#toString%28%29" target="_self">toString</a>, <a href="http://www.scala-lang.org/docu/files/api/scala/AnyRef.html#notify%28%29" target="_self">notify</a>, <a href="http://www.scala-lang.org/docu/files/api/scala/AnyRef.html#notifyAll%28%29" target="_self">notifyAll</a>, <a href="http://www.scala-lang.org/docu/files/api/scala/AnyRef.html#wait%28Long%29" target="_self">wait</a>, <a href="http://www.scala-lang.org/docu/files/api/scala/AnyRef.html#wait%28Long%2CInt%29" target="_self">wait</a>, <a href="http://www.scala-lang.org/docu/files/api/scala/AnyRef.html#wait%28%29" target="_self">wait</a>, <a href="http://www.scala-lang.org/docu/files/api/scala/AnyRef.html#finalize%28%29" target="_self">finalize</a>, <a href="http://www.scala-lang.org/docu/files/api/scala/AnyRef.html#%3D%3D%28AnyRef%29" target="_self">==</a>, <a href="http://www.scala-lang.org/docu/files/api/scala/AnyRef.html#%21%3D%28AnyRef%29" target="_self">!=</a>, <a href="http://www.scala-lang.org/docu/files/api/scala/AnyRef.html#eq%28AnyRef%29" target="_self">eq</a>, <a href="http://www.scala-lang.org/docu/files/api/scala/AnyRef.html#ne%28AnyRef%29" target="_self">ne</a>, <a href="http://www.scala-lang.org/docu/files/api/scala/AnyRef.html#synchronized%28T0%29" target="_self">synchronized</a> - </td></tr> - </table><table summary="" cellpadding="3" class="inherited"> - <tr><td class="title" colspan="2"> - Methods inherited from <a href="http://www.scala-lang.org/docu/files/api/scala/Any.html" target="_self">Any</a> - </td></tr> - <tr><td class="signature" colspan="2"> - <a href="http://www.scala-lang.org/docu/files/api/scala/Any.html#%3D%3D%28Any%29" target="_self">==</a>, <a href="http://www.scala-lang.org/docu/files/api/scala/Any.html#%21%3D%28Any%29" target="_self">!=</a>, <a href="http://www.scala-lang.org/docu/files/api/scala/Any.html#isInstanceOf" target="_self">isInstanceOf</a>, <a href="http://www.scala-lang.org/docu/files/api/scala/Any.html#asInstanceOf" target="_self">asInstanceOf</a> - </td></tr> - </table> - - + <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> - - -<table summary="" cellpadding="3" class="member-detail"> - <tr><td class="title">Method Details</td></tr> - </table><div><a name="vertices"></a><dl> - <dt> - - <code>abstract</code> - <code>def</code> - <em>vertices</em> : <a href="" target="contentFrame" class="scala/Seq">scala.Seq</a>[<a href="../../sims/geometry/Vector2D.html" target="_self">Vector2D</a>] - </dt> - <dd></dd> - </dl> - <dl><dd>Returns positions of all vertices of this Polygon. Vertices are ordered counter-clockwise.</dd></dl> - <dl><dt style="margin:10px 0 0 20px;"> - <b>Returns</b></dt><dd>position vectors of the vertices</dd></dl> - <hr></hr> -<a name="sides"></a><dl> - <dt> - - <code></code> - <code>def</code> - <em>sides</em> : <a href="" target="contentFrame" class="scala/Array">scala.Array</a>[<a href="../../sims/geometry/Segment.html" target="_self">Segment</a>] - </dt> - <dd></dd> - </dl> - <dl><dd>Returns all sides of this polygon. The sides are ordered counter-clockwise, the first vertex of the side
- giving the side index.</dd></dl> - <dl></dl> - <hr></hr> -<a name="project%28sims.geometry.Vector2D%29"></a><dl> - <dt> + + + + </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> - <code></code> - <code>def</code> - <em>project</em>(<em>axis</em> : <a href="../../sims/geometry/Vector2D.html" target="_self">Vector2D</a>) : <a href="../../sims/geometry/Projection.html" target="_self">Projection</a> - </dt> - <dd></dd> - </dl> - <dl><dd>Returns the projection of this polygon onto the line given by the directional vector <code>axis</code>.</dd></dl> - <dl><dt style="margin:10px 0 0 20px;"> - <b>Parameters</b></dt><dd><code>axis - </code>directional vector of the line</dd><dt style="margin:10px 0 0 20px;"> - <b>Returns</b></dt><dd>projection of this polygon</dd></dl> - <hr></hr> -<a name="AABB"></a><dl> - <dt> - <code></code> - <code>def</code> - <em>AABB</em> : <a href="../../sims/collision/AABB.html" target="_self">AABB</a> - </dt> - <dd></dd> - </dl> - <dl><dd>Returns this polygon's axis aligned bounding box.</dd></dl> - <dl><dt style="margin:10px 0 0 20px;"> - <b>See Also</b></dt><dd>collision.AABB</dd></dl> - <hr></hr> -<a name="contains%28sims.geometry.Vector2D%29"></a><dl> - <dt> - <code></code> - <code>def</code> - <em>contains</em>(<em>point</em> : <a href="../../sims/geometry/Vector2D.html" target="_self">Vector2D</a>) : <a href="http://www.scala-lang.org/docu/files/api/scala/Boolean.html" target="_self">Boolean</a> - </dt> - <dd></dd> - </dl> - <dl><dd>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.</dd></dl> - <dl></dl> - <hr></hr></div> - - - <hr></hr> - <table summary="" class="navigation"> - <tr> - <td class="navigation-links" valign="top"> - <!-- <table><tr></tr></table> --> - </td> - <td align="right" valign="top" style="white-space:nowrap;" rowspan="2"> - <div class="doctitle-larger">SiMS</div> - </td> - </tr> - <tr><td></td></tr> - </table> - </body> + </div> + + </body> </html>
\ No newline at end of file diff --git a/doc/sims/geometry/Projection$object.html b/doc/sims/geometry/Projection$object.html deleted file mode 100644 index 4b01917..0000000 --- a/doc/sims/geometry/Projection$object.html +++ /dev/null @@ -1,82 +0,0 @@ -<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
-<html> - <head><title>object Projection in sims.geometry</title> - <meta http-equiv="content-type" content="text/html; charset=UTF8"></meta><meta content="scaladoc (version 2.7.5.final)" name="generator"></meta><link href="../../style.css" type="text/css" rel="stylesheet"></link><script type="text/javascript" src="../../script.js"></script> - </head> - <body onload="init()"> - <table summary="" class="navigation"> - <tr> - <td class="navigation-links" valign="top"> - <!-- <table><tr></tr></table> --> - </td> - <td align="right" valign="top" style="white-space:nowrap;" rowspan="2"> - <div class="doctitle-larger">SiMS</div> - </td> - </tr> - <tr><td></td></tr> - </table> - - <div class="entity"> - <a href="../../sims/geometry$package.html" target="_self">sims.geometry</a> - <br></br> - <span class="entity">object Projection</span> - </div><hr></hr> - <div class="source"> - [source: <a href="" class="sims/geometry/Projection"><code>sims/geometry/Projection.scala</code></a>] - </div><hr></hr> - <a name="Projection"></a><dl> - <dt> - - <code></code> - <code>object</code> - <em>Projection</em> - </dt> - <dd><code> extends </code>(<a href="../../sims/geometry/Vector2D.html" target="_self">Vector2D</a>, <a href="http://www.scala-lang.org/docu/files/api/scala/Double.html" target="_self">Double</a>, <a href="http://www.scala-lang.org/docu/files/api/scala/Double.html" target="_self">Double</a>) => <a href="../../sims/geometry/Projection.html" target="_self">Projection</a></dd> - </dl> - - - -<table summary="" cellpadding="3" class="inherited"> - <tr><td class="title" colspan="2"> - Methods inherited from <a href="" target="contentFrame" class="scala/Function3">scala.Function3</a> - </td></tr> - <tr><td class="signature" colspan="2"> - <a href="#toString" target="contentFrame" class="scala/Function3">scala.Function3.toString</a>, <a href="#curry" target="contentFrame" class="scala/Function3">scala.Function3.curry</a> - </td></tr> - </table><table summary="" cellpadding="3" class="inherited"> - <tr><td class="title" colspan="2"> - Methods inherited from <a href="http://www.scala-lang.org/docu/files/api/scala/AnyRef.html" target="_self">AnyRef</a> - </td></tr> - <tr><td class="signature" colspan="2"> - <a href="http://www.scala-lang.org/docu/files/api/scala/AnyRef.html#getClass%28%29" target="_self">getClass</a>, <a href="http://www.scala-lang.org/docu/files/api/scala/AnyRef.html#hashCode%28%29" target="_self">hashCode</a>, <a href="http://www.scala-lang.org/docu/files/api/scala/AnyRef.html#equals%28Any%29" target="_self">equals</a>, <a href="http://www.scala-lang.org/docu/files/api/scala/AnyRef.html#clone%28%29" target="_self">clone</a>, <a href="http://www.scala-lang.org/docu/files/api/scala/AnyRef.html#notify%28%29" target="_self">notify</a>, <a href="http://www.scala-lang.org/docu/files/api/scala/AnyRef.html#notifyAll%28%29" target="_self">notifyAll</a>, <a href="http://www.scala-lang.org/docu/files/api/scala/AnyRef.html#wait%28Long%29" target="_self">wait</a>, <a href="http://www.scala-lang.org/docu/files/api/scala/AnyRef.html#wait%28Long%2CInt%29" target="_self">wait</a>, <a href="http://www.scala-lang.org/docu/files/api/scala/AnyRef.html#wait%28%29" target="_self">wait</a>, <a href="http://www.scala-lang.org/docu/files/api/scala/AnyRef.html#finalize%28%29" target="_self">finalize</a>, <a href="http://www.scala-lang.org/docu/files/api/scala/AnyRef.html#%3D%3D%28AnyRef%29" target="_self">==</a>, <a href="http://www.scala-lang.org/docu/files/api/scala/AnyRef.html#%21%3D%28AnyRef%29" target="_self">!=</a>, <a href="http://www.scala-lang.org/docu/files/api/scala/AnyRef.html#eq%28AnyRef%29" target="_self">eq</a>, <a href="http://www.scala-lang.org/docu/files/api/scala/AnyRef.html#ne%28AnyRef%29" target="_self">ne</a>, <a href="http://www.scala-lang.org/docu/files/api/scala/AnyRef.html#synchronized%28T0%29" target="_self">synchronized</a> - </td></tr> - </table><table summary="" cellpadding="3" class="inherited"> - <tr><td class="title" colspan="2"> - Methods inherited from <a href="http://www.scala-lang.org/docu/files/api/scala/Any.html" target="_self">Any</a> - </td></tr> - <tr><td class="signature" colspan="2"> - <a href="http://www.scala-lang.org/docu/files/api/scala/Any.html#%3D%3D%28Any%29" target="_self">==</a>, <a href="http://www.scala-lang.org/docu/files/api/scala/Any.html#%21%3D%28Any%29" target="_self">!=</a>, <a href="http://www.scala-lang.org/docu/files/api/scala/Any.html#isInstanceOf" target="_self">isInstanceOf</a>, <a href="http://www.scala-lang.org/docu/files/api/scala/Any.html#asInstanceOf" target="_self">asInstanceOf</a> - </td></tr> - </table> - - - - - - - - - <hr></hr> - <table summary="" class="navigation"> - <tr> - <td class="navigation-links" valign="top"> - <!-- <table><tr></tr></table> --> - </td> - <td align="right" valign="top" style="white-space:nowrap;" rowspan="2"> - <div class="doctitle-larger">SiMS</div> - </td> - </tr> - <tr><td></td></tr> - </table> - </body> - </html>
\ No newline at end of file diff --git a/doc/sims/geometry/Projection.html b/doc/sims/geometry/Projection.html index ad69275..7c180ac 100644 --- a/doc/sims/geometry/Projection.html +++ b/doc/sims/geometry/Projection.html @@ -1,330 +1,263 @@ -<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
+<?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>class Projection in sims.geometry</title> - <meta http-equiv="content-type" content="text/html; charset=UTF8"></meta><meta content="scaladoc (version 2.7.5.final)" name="generator"></meta><link href="../../style.css" type="text/css" rel="stylesheet"></link><script type="text/javascript" src="../../script.js"></script> - </head> - <body onload="init()"> - <table summary="" class="navigation"> - <tr> - <td class="navigation-links" valign="top"> - <!-- <table><tr></tr></table> --> - </td> - <td align="right" valign="top" style="white-space:nowrap;" rowspan="2"> - <div class="doctitle-larger">SiMS</div> - </td> - </tr> - <tr><td></td></tr> - </table> - - <div class="entity"> - <a href="../../sims/geometry$package.html" target="_self">sims.geometry</a> - <br></br> - <span class="entity">class Projection</span> - </div><hr></hr> - <div class="source"> - [source: <a href="" class="sims/geometry/Projection"><code>sims/geometry/Projection.scala</code></a>] - </div><hr></hr> - <a name="Projection"></a><dl> - <dt> - - <code>case</code> - <code>class</code> - <em>Projection</em>(<code>val </code><em>axis</em> : <a href="../../sims/geometry/Vector2D.html" target="_self">Vector2D</a>, <code>val </code><em>lower</em> : <a href="http://www.scala-lang.org/docu/files/api/scala/Double.html" target="_self">Double</a>, <code>val </code><em>upper</em> : <a href="http://www.scala-lang.org/docu/files/api/scala/Double.html" target="_self">Double</a>) - </dt> - <dd><code> extends </code><a href="" target="contentFrame" class="scala/Product">scala.Product</a></dd> - </dl> - <dl><dd>Projection on an axis.
- <p>
- Projections are commonly used in SiMS for collision detection.</dd></dl> - <dl><dt style="margin:10px 0 0 20px;"> - <b>Parameters</b></dt><dd><code>axis - </code>directional vector of the axis of the projection</dd><dd><code>lower - </code>lower value of the projection</dd><dd><code>upper - </code>upper value of the projection</dd></dl> + <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> -<table summary="" cellpadding="3" class="member"> - <tr><td class="title" colspan="2">Method Summary</td></tr> - <tr> - <td class="modifiers" valign="top"> - <code>override def</code> - </td> - <td class="signature"> - <em><a href="../../sims/geometry/Projection.html#equals%28Any%29" target="_self">equals</a></em> - (<em>arg0</em> : <a href="http://www.scala-lang.org/docu/files/api/scala/Any.html" target="_self">Any</a>) : <a href="http://www.scala-lang.org/docu/files/api/scala/Boolean.html" target="_self">Boolean</a> - - <div>This method is used to compare the receiver object (<code>this</code>)
- with the argument object (<code>arg0</code>) for equivalence.</div> - </td> - </tr> -<tr> - <td class="modifiers" valign="top"> - <code>override def</code> - </td> - <td class="signature"> - <em><a href="../../sims/geometry/Projection.html#hashCode%28%29" target="_self">hashCode</a></em> - : <a href="http://www.scala-lang.org/docu/files/api/scala/Int.html" target="_self">Int</a> - - <div>Returns a hash code value for the object.</div> - </td> - </tr> -<tr> - <td class="modifiers" valign="top"> - <code> def</code> - </td> - <td class="signature"> - <em><a href="../../sims/geometry/Projection.html#overlap%28sims.geometry.Projection%29" target="_self">overlap</a></em> - (<em>other</em> : <a href="../../sims/geometry/Projection.html" target="_self">Projection</a>) : <a href="http://www.scala-lang.org/docu/files/api/scala/Double.html" target="_self">Double</a> - - <div>Returns the overlap between this projection and another projection <code>other</code>.</div> - </td> - </tr> -<tr> - <td class="modifiers" valign="top"> - <code> def</code> - </td> - <td class="signature"> - <em><a href="../../sims/geometry/Projection.html#overlaps%28sims.geometry.Projection%29" target="_self">overlaps</a></em> - (<em>other</em> : <a href="../../sims/geometry/Projection.html" target="_self">Projection</a>) : <a href="http://www.scala-lang.org/docu/files/api/scala/Boolean.html" target="_self">Boolean</a> - - <div>Checks this projection for overlap with another projection <code>other</code>.</div> - </td> - </tr> -<tr> - <td class="modifiers" valign="top"> - <code>override def</code> - </td> - <td class="signature"> - <em><a href="../../sims/geometry/Projection.html#productArity" target="_self">productArity</a></em> - : <a href="http://www.scala-lang.org/docu/files/api/scala/Int.html" target="_self">Int</a> - - - </td> - </tr> -<tr> - <td class="modifiers" valign="top"> - <code>override def</code> - </td> - <td class="signature"> - <em><a href="../../sims/geometry/Projection.html#productElement%28Int%29" target="_self">productElement</a></em> - (<em>arg0</em> : <a href="http://www.scala-lang.org/docu/files/api/scala/Int.html" target="_self">Int</a>) : <a href="http://www.scala-lang.org/docu/files/api/scala/Any.html" target="_self">Any</a> - - - </td> - </tr> -<tr> - <td class="modifiers" valign="top"> - <code>override def</code> - </td> - <td class="signature"> - <em><a href="../../sims/geometry/Projection.html#productPrefix" target="_self">productPrefix</a></em> - : <a href="" target="contentFrame" class="java/lang/String">java.lang.String</a> - - - </td> - </tr> -<tr> - <td class="modifiers" valign="top"> - <code>override def</code> - </td> - <td class="signature"> - <em><a href="../../sims/geometry/Projection.html#toString%28%29" target="_self">toString</a></em> - : <a href="" target="contentFrame" class="java/lang/String">java.lang.String</a> - - <div>Returns a string representation of the object.</div> - </td> - </tr> - </table><table summary="" cellpadding="3" class="inherited"> - <tr><td class="title" colspan="2"> - Methods inherited from <a href="http://www.scala-lang.org/docu/files/api/scala/AnyRef.html" target="_self">AnyRef</a> - </td></tr> - <tr><td class="signature" colspan="2"> - <a href="http://www.scala-lang.org/docu/files/api/scala/AnyRef.html#getClass%28%29" target="_self">getClass</a>, <a href="http://www.scala-lang.org/docu/files/api/scala/AnyRef.html#clone%28%29" target="_self">clone</a>, <a href="http://www.scala-lang.org/docu/files/api/scala/AnyRef.html#notify%28%29" target="_self">notify</a>, <a href="http://www.scala-lang.org/docu/files/api/scala/AnyRef.html#notifyAll%28%29" target="_self">notifyAll</a>, <a href="http://www.scala-lang.org/docu/files/api/scala/AnyRef.html#wait%28Long%29" target="_self">wait</a>, <a href="http://www.scala-lang.org/docu/files/api/scala/AnyRef.html#wait%28Long%2CInt%29" target="_self">wait</a>, <a href="http://www.scala-lang.org/docu/files/api/scala/AnyRef.html#wait%28%29" target="_self">wait</a>, <a href="http://www.scala-lang.org/docu/files/api/scala/AnyRef.html#finalize%28%29" target="_self">finalize</a>, <a href="http://www.scala-lang.org/docu/files/api/scala/AnyRef.html#%3D%3D%28AnyRef%29" target="_self">==</a>, <a href="http://www.scala-lang.org/docu/files/api/scala/AnyRef.html#%21%3D%28AnyRef%29" target="_self">!=</a>, <a href="http://www.scala-lang.org/docu/files/api/scala/AnyRef.html#eq%28AnyRef%29" target="_self">eq</a>, <a href="http://www.scala-lang.org/docu/files/api/scala/AnyRef.html#ne%28AnyRef%29" target="_self">ne</a>, <a href="http://www.scala-lang.org/docu/files/api/scala/AnyRef.html#synchronized%28T0%29" target="_self">synchronized</a> - </td></tr> - </table><table summary="" cellpadding="3" class="inherited"> - <tr><td class="title" colspan="2"> - Methods inherited from <a href="http://www.scala-lang.org/docu/files/api/scala/Any.html" target="_self">Any</a> - </td></tr> - <tr><td class="signature" colspan="2"> - <a href="http://www.scala-lang.org/docu/files/api/scala/Any.html#%3D%3D%28Any%29" target="_self">==</a>, <a href="http://www.scala-lang.org/docu/files/api/scala/Any.html#%21%3D%28Any%29" target="_self">!=</a>, <a href="http://www.scala-lang.org/docu/files/api/scala/Any.html#isInstanceOf" target="_self">isInstanceOf</a>, <a href="http://www.scala-lang.org/docu/files/api/scala/Any.html#asInstanceOf" target="_self">asInstanceOf</a> - </td></tr> - </table> - - + <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> - - -<table summary="" cellpadding="3" class="member-detail"> - <tr><td class="title">Method Details</td></tr> - </table><div><a name="overlaps%28sims.geometry.Projection%29"></a><dl> - <dt> - - <code></code> - <code>def</code> - <em>overlaps</em>(<em>other</em> : <a href="../../sims/geometry/Projection.html" target="_self">Projection</a>) : <a href="http://www.scala-lang.org/docu/files/api/scala/Boolean.html" target="_self">Boolean</a> - </dt> - <dd></dd> - </dl> - <dl><dd>Checks this projection for overlap with another projection <code>other</code>.</dd></dl> - <dl><dt style="margin:10px 0 0 20px;"> - <b>Throws</b></dt><dd><code>IllegalArgumentExcepion - </code>if both projections axes aren't the same</dd></dl> - <hr></hr> -<a name="overlap%28sims.geometry.Projection%29"></a><dl> - <dt> - - <code></code> - <code>def</code> - <em>overlap</em>(<em>other</em> : <a href="../../sims/geometry/Projection.html" target="_self">Projection</a>) : <a href="http://www.scala-lang.org/docu/files/api/scala/Double.html" target="_self">Double</a> - </dt> - <dd></dd> - </dl> - <dl><dd>Returns the overlap between this projection and another projection <code>other</code>.</dd></dl> - <dl><dt style="margin:10px 0 0 20px;"> - <b>Throws</b></dt><dd><code>IllegalArgumentExcepion - </code>if both projections axes aren't the same</dd></dl> - <hr></hr> -<a name="hashCode%28%29"></a><dl> - <dt> - - <code>override</code> - <code>def</code> - <em>hashCode</em> : <a href="http://www.scala-lang.org/docu/files/api/scala/Int.html" target="_self">Int</a> - </dt> - <dd></dd> - </dl> - <dl><dd>Returns a hash code value for the object.
- <p>
- The default hashing algorithm is platform dependent.
- 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></dd></dl> - <dl><dt style="margin:10px 0 0 20px;"> - <b>Returns</b></dt><dd>the hash code value for the object. </p></dd></dl> - <hr></hr> -<a name="toString%28%29"></a><dl> - <dt> + + + </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> - <code>override</code> - <code>def</code> - <em>toString</em> : <a href="" target="contentFrame" class="java/lang/String">java.lang.String</a> - </dt> - <dd></dd> - </dl> - <dl><dd>Returns a string representation of the object.
- <p>
- The default representation is platform dependent.</dd></dl> - <dl><dt style="margin:10px 0 0 20px;"> - <b>Returns</b></dt><dd>a string representation of the object. </p></dd></dl> - <hr></hr> -<a name="equals%28Any%29"></a><dl> - <dt> - <code>override</code> - <code>def</code> - <em>equals</em>(<em>arg0</em> : <a href="http://www.scala-lang.org/docu/files/api/scala/Any.html" target="_self">Any</a>) : <a href="http://www.scala-lang.org/docu/files/api/scala/Boolean.html" target="_self">Boolean</a> - </dt> - <dd></dd> - </dl> - <dl><dd>This method is used to compare the receiver object (<code>this</code>)
- with the argument object (<code>arg0</code>) for equivalence.
-
- <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>
- 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>).</dd></dl> - <dl><dt style="margin:10px 0 0 20px;"> - <b>Parameters</b></dt><dd><code>arg0 - </code>the object to compare against this object for equality.</dd><dt style="margin:10px 0 0 20px;"> - <b>Returns</b></dt><dd><code>true</code> if the receiver object is equivalent to the argument; <code>false</code> otherwise. </p></dd></dl> - <hr></hr> -<a name="productPrefix"></a><dl> - <dt> - <code>override</code> - <code>def</code> - <em>productPrefix</em> : <a href="" target="contentFrame" class="java/lang/String">java.lang.String</a> - </dt> - <dd></dd> - </dl><dl> - <dt style="margin:10px 0 0 20px;"> - <b>Overrides</b> - </dt> - <dd> - <a href="" target="contentFrame" class="scala/Product">scala.Product</a>.<a href="#productPrefix" target="contentFrame" class="scala/Product">scala.Product.productPrefix</a> - </dd> - </dl><hr></hr> -<a name="productArity"></a><dl> - <dt> + <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> - <code>override</code> - <code>def</code> - <em>productArity</em> : <a href="http://www.scala-lang.org/docu/files/api/scala/Int.html" target="_self">Int</a> - </dt> - <dd></dd> - </dl><dl> - <dt style="margin:10px 0 0 20px;"> - <b>Overrides</b> - </dt> - <dd> - <a href="" target="contentFrame" class="scala/Product">scala.Product</a>.<a href="#productArity" target="contentFrame" class="scala/Product">scala.Product.productArity</a> - </dd> - </dl><hr></hr> -<a name="productElement%28Int%29"></a><dl> - <dt> + <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> - <code>override</code> - <code>def</code> - <em>productElement</em>(<em>arg0</em> : <a href="http://www.scala-lang.org/docu/files/api/scala/Int.html" target="_self">Int</a>) : <a href="http://www.scala-lang.org/docu/files/api/scala/Any.html" target="_self">Any</a> - </dt> - <dd></dd> - </dl><dl> - <dt style="margin:10px 0 0 20px;"> - <b>Overrides</b> - </dt> - <dd> - <a href="" target="contentFrame" class="scala/Product">scala.Product</a>.<a href="#productElement" target="contentFrame" class="scala/Product">scala.Product.productElement</a> - </dd> - </dl><hr></hr></div> - - - <hr></hr> - <table summary="" class="navigation"> - <tr> - <td class="navigation-links" valign="top"> - <!-- <table><tr></tr></table> --> - </td> - <td align="right" valign="top" style="white-space:nowrap;" rowspan="2"> - <div class="doctitle-larger">SiMS</div> - </td> - </tr> - <tr><td></td></tr> - </table> - </body> + </div> + + </body> </html>
\ No newline at end of file diff --git a/doc/sims/geometry/Ray$object.html b/doc/sims/geometry/Ray$object.html deleted file mode 100644 index 199fc55..0000000 --- a/doc/sims/geometry/Ray$object.html +++ /dev/null @@ -1,82 +0,0 @@ -<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
-<html> - <head><title>object Ray in sims.geometry</title> - <meta http-equiv="content-type" content="text/html; charset=UTF8"></meta><meta content="scaladoc (version 2.7.5.final)" name="generator"></meta><link href="../../style.css" type="text/css" rel="stylesheet"></link><script type="text/javascript" src="../../script.js"></script> - </head> - <body onload="init()"> - <table summary="" class="navigation"> - <tr> - <td class="navigation-links" valign="top"> - <!-- <table><tr></tr></table> --> - </td> - <td align="right" valign="top" style="white-space:nowrap;" rowspan="2"> - <div class="doctitle-larger">SiMS</div> - </td> - </tr> - <tr><td></td></tr> - </table> - - <div class="entity"> - <a href="../../sims/geometry$package.html" target="_self">sims.geometry</a> - <br></br> - <span class="entity">object Ray</span> - </div><hr></hr> - <div class="source"> - [source: <a href="" class="sims/geometry/Ray"><code>sims/geometry/Ray.scala</code></a>] - </div><hr></hr> - <a name="Ray"></a><dl> - <dt> - - <code></code> - <code>object</code> - <em>Ray</em> - </dt> - <dd><code> extends </code>(<a href="../../sims/geometry/Vector2D.html" target="_self">Vector2D</a>, <a href="../../sims/geometry/Vector2D.html" target="_self">Vector2D</a>) => <a href="../../sims/geometry/Ray.html" target="_self">Ray</a></dd> - </dl> - - - -<table summary="" cellpadding="3" class="inherited"> - <tr><td class="title" colspan="2"> - Methods inherited from <a href="" target="contentFrame" class="scala/Function2">scala.Function2</a> - </td></tr> - <tr><td class="signature" colspan="2"> - <a href="#toString" target="contentFrame" class="scala/Function2">scala.Function2.toString</a>, <a href="#curry" target="contentFrame" class="scala/Function2">scala.Function2.curry</a> - </td></tr> - </table><table summary="" cellpadding="3" class="inherited"> - <tr><td class="title" colspan="2"> - Methods inherited from <a href="http://www.scala-lang.org/docu/files/api/scala/AnyRef.html" target="_self">AnyRef</a> - </td></tr> - <tr><td class="signature" colspan="2"> - <a href="http://www.scala-lang.org/docu/files/api/scala/AnyRef.html#getClass%28%29" target="_self">getClass</a>, <a href="http://www.scala-lang.org/docu/files/api/scala/AnyRef.html#hashCode%28%29" target="_self">hashCode</a>, <a href="http://www.scala-lang.org/docu/files/api/scala/AnyRef.html#equals%28Any%29" target="_self">equals</a>, <a href="http://www.scala-lang.org/docu/files/api/scala/AnyRef.html#clone%28%29" target="_self">clone</a>, <a href="http://www.scala-lang.org/docu/files/api/scala/AnyRef.html#notify%28%29" target="_self">notify</a>, <a href="http://www.scala-lang.org/docu/files/api/scala/AnyRef.html#notifyAll%28%29" target="_self">notifyAll</a>, <a href="http://www.scala-lang.org/docu/files/api/scala/AnyRef.html#wait%28Long%29" target="_self">wait</a>, <a href="http://www.scala-lang.org/docu/files/api/scala/AnyRef.html#wait%28Long%2CInt%29" target="_self">wait</a>, <a href="http://www.scala-lang.org/docu/files/api/scala/AnyRef.html#wait%28%29" target="_self">wait</a>, <a href="http://www.scala-lang.org/docu/files/api/scala/AnyRef.html#finalize%28%29" target="_self">finalize</a>, <a href="http://www.scala-lang.org/docu/files/api/scala/AnyRef.html#%3D%3D%28AnyRef%29" target="_self">==</a>, <a href="http://www.scala-lang.org/docu/files/api/scala/AnyRef.html#%21%3D%28AnyRef%29" target="_self">!=</a>, <a href="http://www.scala-lang.org/docu/files/api/scala/AnyRef.html#eq%28AnyRef%29" target="_self">eq</a>, <a href="http://www.scala-lang.org/docu/files/api/scala/AnyRef.html#ne%28AnyRef%29" target="_self">ne</a>, <a href="http://www.scala-lang.org/docu/files/api/scala/AnyRef.html#synchronized%28T0%29" target="_self">synchronized</a> - </td></tr> - </table><table summary="" cellpadding="3" class="inherited"> - <tr><td class="title" colspan="2"> - Methods inherited from <a href="http://www.scala-lang.org/docu/files/api/scala/Any.html" target="_self">Any</a> - </td></tr> - <tr><td class="signature" colspan="2"> - <a href="http://www.scala-lang.org/docu/files/api/scala/Any.html#%3D%3D%28Any%29" target="_self">==</a>, <a href="http://www.scala-lang.org/docu/files/api/scala/Any.html#%21%3D%28Any%29" target="_self">!=</a>, <a href="http://www.scala-lang.org/docu/files/api/scala/Any.html#isInstanceOf" target="_self">isInstanceOf</a>, <a href="http://www.scala-lang.org/docu/files/api/scala/Any.html#asInstanceOf" target="_self">asInstanceOf</a> - </td></tr> - </table> - - - - - - - - - <hr></hr> - <table summary="" class="navigation"> - <tr> - <td class="navigation-links" valign="top"> - <!-- <table><tr></tr></table> --> - </td> - <td align="right" valign="top" style="white-space:nowrap;" rowspan="2"> - <div class="doctitle-larger">SiMS</div> - </td> - </tr> - <tr><td></td></tr> - </table> - </body> - </html>
\ No newline at end of file diff --git a/doc/sims/geometry/Ray.html b/doc/sims/geometry/Ray.html index 79288ce..d2a8ec8 100644 --- a/doc/sims/geometry/Ray.html +++ b/doc/sims/geometry/Ray.html @@ -1,328 +1,253 @@ -<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
+<?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>class Ray in sims.geometry</title> - <meta http-equiv="content-type" content="text/html; charset=UTF8"></meta><meta content="scaladoc (version 2.7.5.final)" name="generator"></meta><link href="../../style.css" type="text/css" rel="stylesheet"></link><script type="text/javascript" src="../../script.js"></script> - </head> - <body onload="init()"> - <table summary="" class="navigation"> - <tr> - <td class="navigation-links" valign="top"> - <!-- <table><tr></tr></table> --> - </td> - <td align="right" valign="top" style="white-space:nowrap;" rowspan="2"> - <div class="doctitle-larger">SiMS</div> - </td> - </tr> - <tr><td></td></tr> - </table> - - <div class="entity"> - <a href="../../sims/geometry$package.html" target="_self">sims.geometry</a> - <br></br> - <span class="entity">class Ray</span> - </div><hr></hr> - <div class="source"> - [source: <a href="" class="sims/geometry/Ray"><code>sims/geometry/Ray.scala</code></a>] - </div><hr></hr> - <a name="Ray"></a><dl> - <dt> - - <code>case</code> - <code>class</code> - <em>Ray</em>(<code>val </code><em>point</em> : <a href="../../sims/geometry/Vector2D.html" target="_self">Vector2D</a>, <code>val </code><em>direction</em> : <a href="../../sims/geometry/Vector2D.html" target="_self">Vector2D</a>) - </dt> - <dd><code> extends </code><a href="" target="contentFrame" class="scala/Product">scala.Product</a></dd> - </dl> - <dl><dd>A ray.</dd></dl> - <dl><dt style="margin:10px 0 0 20px;"> - <b>Parameters</b></dt><dd><code>point - </code>a point on the ray</dd><dd><code>direction - </code>this ray's directional vector</dd><dt style="margin:10px 0 0 20px;"> - <b>Throws</b></dt><dd><code>IllegalArgumentException - </code>if the directional vector is the null vector</dd></dl> + <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> -<table summary="" cellpadding="3" class="member"> - <tr><td class="title" colspan="2">Method Summary</td></tr> - <tr> - <td class="modifiers" valign="top"> - <code> def</code> - </td> - <td class="signature"> - <em><a href="../../sims/geometry/Ray.html#contains%28sims.geometry.Vector2D%29" target="_self">contains</a></em> - (<em>p</em> : <a href="../../sims/geometry/Vector2D.html" target="_self">Vector2D</a>) : <a href="http://www.scala-lang.org/docu/files/api/scala/Boolean.html" target="_self">Boolean</a> - - <div>Checks if this ray contains the point <code>p</code>.</div> - </td> - </tr> -<tr> - <td class="modifiers" valign="top"> - <code>override def</code> - </td> - <td class="signature"> - <em><a href="../../sims/geometry/Ray.html#equals%28Any%29" target="_self">equals</a></em> - (<em>arg0</em> : <a href="http://www.scala-lang.org/docu/files/api/scala/Any.html" target="_self">Any</a>) : <a href="http://www.scala-lang.org/docu/files/api/scala/Boolean.html" target="_self">Boolean</a> - - <div>This method is used to compare the receiver object (<code>this</code>)
- with the argument object (<code>arg0</code>) for equivalence.</div> - </td> - </tr> -<tr> - <td class="modifiers" valign="top"> - <code>override def</code> - </td> - <td class="signature"> - <em><a href="../../sims/geometry/Ray.html#hashCode%28%29" target="_self">hashCode</a></em> - : <a href="http://www.scala-lang.org/docu/files/api/scala/Int.html" target="_self">Int</a> - - <div>Returns a hash code value for the object.</div> - </td> - </tr> -<tr> - <td class="modifiers" valign="top"> - <code> def</code> - </td> - <td class="signature"> - <em><a href="../../sims/geometry/Ray.html#intersects%28sims.geometry.Segment%29" target="_self">intersects</a></em> - (<em>s</em> : <a href="../../sims/geometry/Segment.html" target="_self">Segment</a>) : <a href="http://www.scala-lang.org/docu/files/api/scala/Boolean.html" target="_self">Boolean</a> - - <div>Checks this ray and the given segment for intersection.</div> - </td> - </tr> -<tr> - <td class="modifiers" valign="top"> - <code>override def</code> - </td> - <td class="signature"> - <em><a href="../../sims/geometry/Ray.html#productArity" target="_self">productArity</a></em> - : <a href="http://www.scala-lang.org/docu/files/api/scala/Int.html" target="_self">Int</a> - - - </td> - </tr> -<tr> - <td class="modifiers" valign="top"> - <code>override def</code> - </td> - <td class="signature"> - <em><a href="../../sims/geometry/Ray.html#productElement%28Int%29" target="_self">productElement</a></em> - (<em>arg0</em> : <a href="http://www.scala-lang.org/docu/files/api/scala/Int.html" target="_self">Int</a>) : <a href="http://www.scala-lang.org/docu/files/api/scala/Any.html" target="_self">Any</a> - - - </td> - </tr> -<tr> - <td class="modifiers" valign="top"> - <code>override def</code> - </td> - <td class="signature"> - <em><a href="../../sims/geometry/Ray.html#productPrefix" target="_self">productPrefix</a></em> - : <a href="" target="contentFrame" class="java/lang/String">java.lang.String</a> - - - </td> - </tr> -<tr> - <td class="modifiers" valign="top"> - <code>override def</code> - </td> - <td class="signature"> - <em><a href="../../sims/geometry/Ray.html#toString%28%29" target="_self">toString</a></em> - : <a href="" target="contentFrame" class="java/lang/String">java.lang.String</a> - - <div>Returns a string representation of the object.</div> - </td> - </tr> - </table><table summary="" cellpadding="3" class="inherited"> - <tr><td class="title" colspan="2"> - Methods inherited from <a href="http://www.scala-lang.org/docu/files/api/scala/AnyRef.html" target="_self">AnyRef</a> - </td></tr> - <tr><td class="signature" colspan="2"> - <a href="http://www.scala-lang.org/docu/files/api/scala/AnyRef.html#getClass%28%29" target="_self">getClass</a>, <a href="http://www.scala-lang.org/docu/files/api/scala/AnyRef.html#clone%28%29" target="_self">clone</a>, <a href="http://www.scala-lang.org/docu/files/api/scala/AnyRef.html#notify%28%29" target="_self">notify</a>, <a href="http://www.scala-lang.org/docu/files/api/scala/AnyRef.html#notifyAll%28%29" target="_self">notifyAll</a>, <a href="http://www.scala-lang.org/docu/files/api/scala/AnyRef.html#wait%28Long%29" target="_self">wait</a>, <a href="http://www.scala-lang.org/docu/files/api/scala/AnyRef.html#wait%28Long%2CInt%29" target="_self">wait</a>, <a href="http://www.scala-lang.org/docu/files/api/scala/AnyRef.html#wait%28%29" target="_self">wait</a>, <a href="http://www.scala-lang.org/docu/files/api/scala/AnyRef.html#finalize%28%29" target="_self">finalize</a>, <a href="http://www.scala-lang.org/docu/files/api/scala/AnyRef.html#%3D%3D%28AnyRef%29" target="_self">==</a>, <a href="http://www.scala-lang.org/docu/files/api/scala/AnyRef.html#%21%3D%28AnyRef%29" target="_self">!=</a>, <a href="http://www.scala-lang.org/docu/files/api/scala/AnyRef.html#eq%28AnyRef%29" target="_self">eq</a>, <a href="http://www.scala-lang.org/docu/files/api/scala/AnyRef.html#ne%28AnyRef%29" target="_self">ne</a>, <a href="http://www.scala-lang.org/docu/files/api/scala/AnyRef.html#synchronized%28T0%29" target="_self">synchronized</a> - </td></tr> - </table><table summary="" cellpadding="3" class="inherited"> - <tr><td class="title" colspan="2"> - Methods inherited from <a href="http://www.scala-lang.org/docu/files/api/scala/Any.html" target="_self">Any</a> - </td></tr> - <tr><td class="signature" colspan="2"> - <a href="http://www.scala-lang.org/docu/files/api/scala/Any.html#%3D%3D%28Any%29" target="_self">==</a>, <a href="http://www.scala-lang.org/docu/files/api/scala/Any.html#%21%3D%28Any%29" target="_self">!=</a>, <a href="http://www.scala-lang.org/docu/files/api/scala/Any.html#isInstanceOf" target="_self">isInstanceOf</a>, <a href="http://www.scala-lang.org/docu/files/api/scala/Any.html#asInstanceOf" target="_self">asInstanceOf</a> - </td></tr> - </table> - - + <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> - - -<table summary="" cellpadding="3" class="member-detail"> - <tr><td class="title">Method Details</td></tr> - </table><div><a name="intersects%28sims.geometry.Segment%29"></a><dl> - <dt> - - <code></code> - <code>def</code> - <em>intersects</em>(<em>s</em> : <a href="../../sims/geometry/Segment.html" target="_self">Segment</a>) : <a href="http://www.scala-lang.org/docu/files/api/scala/Boolean.html" target="_self">Boolean</a> - </dt> - <dd></dd> - </dl> - <dl><dd>Checks this ray and the given segment for intersection.</dd></dl> - <dl><dt style="margin:10px 0 0 20px;"> - <b>Parameters</b></dt><dd><code>s - </code>the segment to test for intersection</dd></dl> - <hr></hr> -<a name="contains%28sims.geometry.Vector2D%29"></a><dl> - <dt> - - <code></code> - <code>def</code> - <em>contains</em>(<em>p</em> : <a href="../../sims/geometry/Vector2D.html" target="_self">Vector2D</a>) : <a href="http://www.scala-lang.org/docu/files/api/scala/Boolean.html" target="_self">Boolean</a> - </dt> - <dd></dd> - </dl> - <dl><dd>Checks if this ray contains the point <code>p</code>.</dd></dl> - <dl></dl> - <hr></hr> -<a name="hashCode%28%29"></a><dl> - <dt> - - <code>override</code> - <code>def</code> - <em>hashCode</em> : <a href="http://www.scala-lang.org/docu/files/api/scala/Int.html" target="_self">Int</a> - </dt> - <dd></dd> - </dl> - <dl><dd>Returns a hash code value for the object.
- <p>
- The default hashing algorithm is platform dependent.
- 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></dd></dl> - <dl><dt style="margin:10px 0 0 20px;"> - <b>Returns</b></dt><dd>the hash code value for the object. </p></dd></dl> - <hr></hr> -<a name="toString%28%29"></a><dl> - <dt> - - <code>override</code> - <code>def</code> - <em>toString</em> : <a href="" target="contentFrame" class="java/lang/String">java.lang.String</a> - </dt> - <dd></dd> - </dl> - <dl><dd>Returns a string representation of the object.
- <p>
- The default representation is platform dependent.</dd></dl> - <dl><dt style="margin:10px 0 0 20px;"> - <b>Returns</b></dt><dd>a string representation of the object. </p></dd></dl> - <hr></hr> -<a name="equals%28Any%29"></a><dl> - <dt> - - <code>override</code> - <code>def</code> - <em>equals</em>(<em>arg0</em> : <a href="http://www.scala-lang.org/docu/files/api/scala/Any.html" target="_self">Any</a>) : <a href="http://www.scala-lang.org/docu/files/api/scala/Boolean.html" target="_self">Boolean</a> - </dt> - <dd></dd> - </dl> - <dl><dd>This method is used to compare the receiver object (<code>this</code>)
- with the argument object (<code>arg0</code>) for equivalence.
-
- <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>
- 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>).</dd></dl> - <dl><dt style="margin:10px 0 0 20px;"> - <b>Parameters</b></dt><dd><code>arg0 - </code>the object to compare against this object for equality.</dd><dt style="margin:10px 0 0 20px;"> - <b>Returns</b></dt><dd><code>true</code> if the receiver object is equivalent to the argument; <code>false</code> otherwise. </p></dd></dl> - <hr></hr> -<a name="productPrefix"></a><dl> - <dt> - - <code>override</code> - <code>def</code> - <em>productPrefix</em> : <a href="" target="contentFrame" class="java/lang/String">java.lang.String</a> - </dt> - <dd></dd> - </dl><dl> - <dt style="margin:10px 0 0 20px;"> - <b>Overrides</b> - </dt> - <dd> - <a href="" target="contentFrame" class="scala/Product">scala.Product</a>.<a href="#productPrefix" target="contentFrame" class="scala/Product">scala.Product.productPrefix</a> - </dd> - </dl><hr></hr> -<a name="productArity"></a><dl> - <dt> - - <code>override</code> - <code>def</code> - <em>productArity</em> : <a href="http://www.scala-lang.org/docu/files/api/scala/Int.html" target="_self">Int</a> - </dt> - <dd></dd> - </dl><dl> - <dt style="margin:10px 0 0 20px;"> - <b>Overrides</b> - </dt> - <dd> - <a href="" target="contentFrame" class="scala/Product">scala.Product</a>.<a href="#productArity" target="contentFrame" class="scala/Product">scala.Product.productArity</a> - </dd> - </dl><hr></hr> -<a name="productElement%28Int%29"></a><dl> - <dt> + + + </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> - <code>override</code> - <code>def</code> - <em>productElement</em>(<em>arg0</em> : <a href="http://www.scala-lang.org/docu/files/api/scala/Int.html" target="_self">Int</a>) : <a href="http://www.scala-lang.org/docu/files/api/scala/Any.html" target="_self">Any</a> - </dt> - <dd></dd> - </dl><dl> - <dt style="margin:10px 0 0 20px;"> - <b>Overrides</b> - </dt> - <dd> - <a href="" target="contentFrame" class="scala/Product">scala.Product</a>.<a href="#productElement" target="contentFrame" class="scala/Product">scala.Product.productElement</a> - </dd> - </dl><hr></hr></div> - - - <hr></hr> - <table summary="" class="navigation"> - <tr> - <td class="navigation-links" valign="top"> - <!-- <table><tr></tr></table> --> - </td> - <td align="right" valign="top" style="white-space:nowrap;" rowspan="2"> - <div class="doctitle-larger">SiMS</div> - </td> - </tr> - <tr><td></td></tr> - </table> - </body> + </div> + + </body> </html>
\ No newline at end of file diff --git a/doc/sims/geometry/Segment$object.html b/doc/sims/geometry/Segment$object.html deleted file mode 100644 index fae9e31..0000000 --- a/doc/sims/geometry/Segment$object.html +++ /dev/null @@ -1,82 +0,0 @@ -<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
-<html> - <head><title>object Segment in sims.geometry</title> - <meta http-equiv="content-type" content="text/html; charset=UTF8"></meta><meta content="scaladoc (version 2.7.5.final)" name="generator"></meta><link href="../../style.css" type="text/css" rel="stylesheet"></link><script type="text/javascript" src="../../script.js"></script> - </head> - <body onload="init()"> - <table summary="" class="navigation"> - <tr> - <td class="navigation-links" valign="top"> - <!-- <table><tr></tr></table> --> - </td> - <td align="right" valign="top" style="white-space:nowrap;" rowspan="2"> - <div class="doctitle-larger">SiMS</div> - </td> - </tr> - <tr><td></td></tr> - </table> - - <div class="entity"> - <a href="../../sims/geometry$package.html" target="_self">sims.geometry</a> - <br></br> - <span class="entity">object Segment</span> - </div><hr></hr> - <div class="source"> - [source: <a href="" class="sims/geometry/Segment"><code>sims/geometry/Segment.scala</code></a>] - </div><hr></hr> - <a name="Segment"></a><dl> - <dt> - - <code></code> - <code>object</code> - <em>Segment</em> - </dt> - <dd><code> extends </code>(<a href="../../sims/geometry/Vector2D.html" target="_self">Vector2D</a>, <a href="../../sims/geometry/Vector2D.html" target="_self">Vector2D</a>) => <a href="../../sims/geometry/Segment.html" target="_self">Segment</a></dd> - </dl> - - - -<table summary="" cellpadding="3" class="inherited"> - <tr><td class="title" colspan="2"> - Methods inherited from <a href="" target="contentFrame" class="scala/Function2">scala.Function2</a> - </td></tr> - <tr><td class="signature" colspan="2"> - <a href="#toString" target="contentFrame" class="scala/Function2">scala.Function2.toString</a>, <a href="#curry" target="contentFrame" class="scala/Function2">scala.Function2.curry</a> - </td></tr> - </table><table summary="" cellpadding="3" class="inherited"> - <tr><td class="title" colspan="2"> - Methods inherited from <a href="http://www.scala-lang.org/docu/files/api/scala/AnyRef.html" target="_self">AnyRef</a> - </td></tr> - <tr><td class="signature" colspan="2"> - <a href="http://www.scala-lang.org/docu/files/api/scala/AnyRef.html#getClass%28%29" target="_self">getClass</a>, <a href="http://www.scala-lang.org/docu/files/api/scala/AnyRef.html#hashCode%28%29" target="_self">hashCode</a>, <a href="http://www.scala-lang.org/docu/files/api/scala/AnyRef.html#equals%28Any%29" target="_self">equals</a>, <a href="http://www.scala-lang.org/docu/files/api/scala/AnyRef.html#clone%28%29" target="_self">clone</a>, <a href="http://www.scala-lang.org/docu/files/api/scala/AnyRef.html#notify%28%29" target="_self">notify</a>, <a href="http://www.scala-lang.org/docu/files/api/scala/AnyRef.html#notifyAll%28%29" target="_self">notifyAll</a>, <a href="http://www.scala-lang.org/docu/files/api/scala/AnyRef.html#wait%28Long%29" target="_self">wait</a>, <a href="http://www.scala-lang.org/docu/files/api/scala/AnyRef.html#wait%28Long%2CInt%29" target="_self">wait</a>, <a href="http://www.scala-lang.org/docu/files/api/scala/AnyRef.html#wait%28%29" target="_self">wait</a>, <a href="http://www.scala-lang.org/docu/files/api/scala/AnyRef.html#finalize%28%29" target="_self">finalize</a>, <a href="http://www.scala-lang.org/docu/files/api/scala/AnyRef.html#%3D%3D%28AnyRef%29" target="_self">==</a>, <a href="http://www.scala-lang.org/docu/files/api/scala/AnyRef.html#%21%3D%28AnyRef%29" target="_self">!=</a>, <a href="http://www.scala-lang.org/docu/files/api/scala/AnyRef.html#eq%28AnyRef%29" target="_self">eq</a>, <a href="http://www.scala-lang.org/docu/files/api/scala/AnyRef.html#ne%28AnyRef%29" target="_self">ne</a>, <a href="http://www.scala-lang.org/docu/files/api/scala/AnyRef.html#synchronized%28T0%29" target="_self">synchronized</a> - </td></tr> - </table><table summary="" cellpadding="3" class="inherited"> - <tr><td class="title" colspan="2"> - Methods inherited from <a href="http://www.scala-lang.org/docu/files/api/scala/Any.html" target="_self">Any</a> - </td></tr> - <tr><td class="signature" colspan="2"> - <a href="http://www.scala-lang.org/docu/files/api/scala/Any.html#%3D%3D%28Any%29" target="_self">==</a>, <a href="http://www.scala-lang.org/docu/files/api/scala/Any.html#%21%3D%28Any%29" target="_self">!=</a>, <a href="http://www.scala-lang.org/docu/files/api/scala/Any.html#isInstanceOf" target="_self">isInstanceOf</a>, <a href="http://www.scala-lang.org/docu/files/api/scala/Any.html#asInstanceOf" target="_self">asInstanceOf</a> - </td></tr> - </table> - - - - - - - - - <hr></hr> - <table summary="" class="navigation"> - <tr> - <td class="navigation-links" valign="top"> - <!-- <table><tr></tr></table> --> - </td> - <td align="right" valign="top" style="white-space:nowrap;" rowspan="2"> - <div class="doctitle-larger">SiMS</div> - </td> - </tr> - <tr><td></td></tr> - </table> - </body> - </html>
\ No newline at end of file diff --git a/doc/sims/geometry/Segment.html b/doc/sims/geometry/Segment.html index 084cfb6..2d79999 100644 --- a/doc/sims/geometry/Segment.html +++ b/doc/sims/geometry/Segment.html @@ -1,442 +1,317 @@ -<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
+<?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>class Segment in sims.geometry</title> - <meta http-equiv="content-type" content="text/html; charset=UTF8"></meta><meta content="scaladoc (version 2.7.5.final)" name="generator"></meta><link href="../../style.css" type="text/css" rel="stylesheet"></link><script type="text/javascript" src="../../script.js"></script> - </head> - <body onload="init()"> - <table summary="" class="navigation"> - <tr> - <td class="navigation-links" valign="top"> - <!-- <table><tr></tr></table> --> - </td> - <td align="right" valign="top" style="white-space:nowrap;" rowspan="2"> - <div class="doctitle-larger">SiMS</div> - </td> - </tr> - <tr><td></td></tr> - </table> - - <div class="entity"> - <a href="../../sims/geometry$package.html" target="_self">sims.geometry</a> - <br></br> - <span class="entity">class Segment</span> - </div><hr></hr> - <div class="source"> - [source: <a href="" class="sims/geometry/Segment"><code>sims/geometry/Segment.scala</code></a>] - </div><hr></hr> - <a name="Segment"></a><dl> - <dt> - - <code>case</code> - <code>class</code> - <em>Segment</em>(<code>val </code><em>vertex1</em> : <a href="../../sims/geometry/Vector2D.html" target="_self">Vector2D</a>, <code>val </code><em>vertex2</em> : <a href="../../sims/geometry/Vector2D.html" target="_self">Vector2D</a>) - </dt> - <dd><code> extends </code><a href="" target="contentFrame" class="scala/Product">scala.Product</a></dd> - </dl> - <dl><dd>A segment is given by its vertices.</dd></dl> - <dl><dt style="margin:10px 0 0 20px;"> - <b>Parameters</b></dt><dd><code>vertex1 - </code>position vector of the first vertex</dd><dd><code>vertex2 - </code>position vector of the second vertex</dd><dt style="margin:10px 0 0 20px;"> - <b>Throws</b></dt><dd><code>IllegalArgumentException - </code>if both vertices are equal</dd></dl> + <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> -<table summary="" cellpadding="3" class="member"> - <tr><td class="title" colspan="2">Value Summary</td></tr> - <tr> - <td class="modifiers" valign="top"> - <code> val</code> - </td> - <td class="signature"> - <em><a href="../../sims/geometry/Segment.html#d" target="_self">d</a></em> - : <a href="../../sims/geometry/Vector2D.html" target="_self">Vector2D</a> - - <div>Vector from <code>vertex1</code> to <code>vertex2</code>.</div> - </td> - </tr> -<tr> - <td class="modifiers" valign="top"> - <code> val</code> - </td> - <td class="signature"> - <em><a href="../../sims/geometry/Segment.html#d0" target="_self">d0</a></em> - : <a href="../../sims/geometry/Vector2D.html" target="_self">Vector2D</a> - - <div>Unit directional vector.</div> - </td> - </tr> -<tr> - <td class="modifiers" valign="top"> - <code> val</code> - </td> - <td class="signature"> - <em><a href="../../sims/geometry/Segment.html#length" target="_self">length</a></em> - : <a href="http://www.scala-lang.org/docu/files/api/scala/Double.html" target="_self">Double</a> - - <div>Length of this segment.</div> - </td> - </tr> -<tr> - <td class="modifiers" valign="top"> - <code> val</code> - </td> - <td class="signature"> - <em><a href="../../sims/geometry/Segment.html#n" target="_self">n</a></em> - : <a href="../../sims/geometry/Vector2D.html" target="_self">Vector2D</a> - - <div>Right normal vector.</div> - </td> - </tr> -<tr> - <td class="modifiers" valign="top"> - <code> val</code> - </td> - <td class="signature"> - <em><a href="../../sims/geometry/Segment.html#n0" target="_self">n0</a></em> - : <a href="../../sims/geometry/Vector2D.html" target="_self">Vector2D</a> - - <div>Right normal unit vector.</div> - </td> - </tr> - </table> -<table summary="" cellpadding="3" class="member"> - <tr><td class="title" colspan="2">Method Summary</td></tr> - <tr> - <td class="modifiers" valign="top"> - <code> def</code> - </td> - <td class="signature"> - <em><a href="../../sims/geometry/Segment.html#clipToSegment%28sims.geometry.Segment%29" target="_self">clipToSegment</a></em> - (<em>s</em> : <a href="../../sims/geometry/Segment.html" target="_self">Segment</a>) : <a href="" target="contentFrame" class="scala/Option">scala.Option</a>[<a href="../../sims/geometry/Vector2D.html" target="_self">Vector2D</a>] - - - </td> - </tr> -<tr> - <td class="modifiers" valign="top"> - <code> def</code> - </td> - <td class="signature"> - <em><a href="../../sims/geometry/Segment.html#distance%28sims.geometry.Vector2D%29" target="_self">distance</a></em> - (<em>point</em> : <a href="../../sims/geometry/Vector2D.html" target="_self">Vector2D</a>) : <a href="http://www.scala-lang.org/docu/files/api/scala/Double.html" target="_self">Double</a> - - <div>Smallest distance between this segment and the point <code>point</code>.</div> - </td> - </tr> -<tr> - <td class="modifiers" valign="top"> - <code>override def</code> - </td> - <td class="signature"> - <em><a href="../../sims/geometry/Segment.html#equals%28Any%29" target="_self">equals</a></em> - (<em>arg0</em> : <a href="http://www.scala-lang.org/docu/files/api/scala/Any.html" target="_self">Any</a>) : <a href="http://www.scala-lang.org/docu/files/api/scala/Boolean.html" target="_self">Boolean</a> - - <div>This method is used to compare the receiver object (<code>this</code>)
- with the argument object (<code>arg0</code>) for equivalence.</div> - </td> - </tr> -<tr> - <td class="modifiers" valign="top"> - <code>override def</code> - </td> - <td class="signature"> - <em><a href="../../sims/geometry/Segment.html#hashCode%28%29" target="_self">hashCode</a></em> - : <a href="http://www.scala-lang.org/docu/files/api/scala/Int.html" target="_self">Int</a> - - <div>Returns a hash code value for the object.</div> - </td> - </tr> -<tr> - <td class="modifiers" valign="top"> - <code>override def</code> - </td> - <td class="signature"> - <em><a href="../../sims/geometry/Segment.html#productArity" target="_self">productArity</a></em> - : <a href="http://www.scala-lang.org/docu/files/api/scala/Int.html" target="_self">Int</a> - - - </td> - </tr> -<tr> - <td class="modifiers" valign="top"> - <code>override def</code> - </td> - <td class="signature"> - <em><a href="../../sims/geometry/Segment.html#productElement%28Int%29" target="_self">productElement</a></em> - (<em>arg0</em> : <a href="http://www.scala-lang.org/docu/files/api/scala/Int.html" target="_self">Int</a>) : <a href="http://www.scala-lang.org/docu/files/api/scala/Any.html" target="_self">Any</a> - - - </td> - </tr> -<tr> - <td class="modifiers" valign="top"> - <code>override def</code> - </td> - <td class="signature"> - <em><a href="../../sims/geometry/Segment.html#productPrefix" target="_self">productPrefix</a></em> - : <a href="" target="contentFrame" class="java/lang/String">java.lang.String</a> - - - </td> - </tr> -<tr> - <td class="modifiers" valign="top"> - <code>override def</code> - </td> - <td class="signature"> - <em><a href="../../sims/geometry/Segment.html#toString%28%29" target="_self">toString</a></em> - : <a href="" target="contentFrame" class="java/lang/String">java.lang.String</a> - - <div>Returns a string representation of the object.</div> - </td> - </tr> - </table><table summary="" cellpadding="3" class="inherited"> - <tr><td class="title" colspan="2"> - Methods inherited from <a href="http://www.scala-lang.org/docu/files/api/scala/AnyRef.html" target="_self">AnyRef</a> - </td></tr> - <tr><td class="signature" colspan="2"> - <a href="http://www.scala-lang.org/docu/files/api/scala/AnyRef.html#getClass%28%29" target="_self">getClass</a>, <a href="http://www.scala-lang.org/docu/files/api/scala/AnyRef.html#clone%28%29" target="_self">clone</a>, <a href="http://www.scala-lang.org/docu/files/api/scala/AnyRef.html#notify%28%29" target="_self">notify</a>, <a href="http://www.scala-lang.org/docu/files/api/scala/AnyRef.html#notifyAll%28%29" target="_self">notifyAll</a>, <a href="http://www.scala-lang.org/docu/files/api/scala/AnyRef.html#wait%28Long%29" target="_self">wait</a>, <a href="http://www.scala-lang.org/docu/files/api/scala/AnyRef.html#wait%28Long%2CInt%29" target="_self">wait</a>, <a href="http://www.scala-lang.org/docu/files/api/scala/AnyRef.html#wait%28%29" target="_self">wait</a>, <a href="http://www.scala-lang.org/docu/files/api/scala/AnyRef.html#finalize%28%29" target="_self">finalize</a>, <a href="http://www.scala-lang.org/docu/files/api/scala/AnyRef.html#%3D%3D%28AnyRef%29" target="_self">==</a>, <a href="http://www.scala-lang.org/docu/files/api/scala/AnyRef.html#%21%3D%28AnyRef%29" target="_self">!=</a>, <a href="http://www.scala-lang.org/docu/files/api/scala/AnyRef.html#eq%28AnyRef%29" target="_self">eq</a>, <a href="http://www.scala-lang.org/docu/files/api/scala/AnyRef.html#ne%28AnyRef%29" target="_self">ne</a>, <a href="http://www.scala-lang.org/docu/files/api/scala/AnyRef.html#synchronized%28T0%29" target="_self">synchronized</a> - </td></tr> - </table><table summary="" cellpadding="3" class="inherited"> - <tr><td class="title" colspan="2"> - Methods inherited from <a href="http://www.scala-lang.org/docu/files/api/scala/Any.html" target="_self">Any</a> - </td></tr> - <tr><td class="signature" colspan="2"> - <a href="http://www.scala-lang.org/docu/files/api/scala/Any.html#%3D%3D%28Any%29" target="_self">==</a>, <a href="http://www.scala-lang.org/docu/files/api/scala/Any.html#%21%3D%28Any%29" target="_self">!=</a>, <a href="http://www.scala-lang.org/docu/files/api/scala/Any.html#isInstanceOf" target="_self">isInstanceOf</a>, <a href="http://www.scala-lang.org/docu/files/api/scala/Any.html#asInstanceOf" target="_self">asInstanceOf</a> - </td></tr> - </table> - + <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> - -<table summary="" cellpadding="3" class="member-detail"> - <tr><td class="title">Value Details</td></tr> - </table><div><a name="length"></a><dl> - <dt> - - <code></code> - <code>val</code> - <em>length</em> : <a href="http://www.scala-lang.org/docu/files/api/scala/Double.html" target="_self">Double</a> - </dt> - <dd></dd> - </dl> - <dl><dd>Length of this segment.</dd></dl> - <dl></dl> - <hr></hr> -<a name="d"></a><dl> - <dt> - - <code></code> - <code>val</code> - <em>d</em> : <a href="../../sims/geometry/Vector2D.html" target="_self">Vector2D</a> - </dt> - <dd></dd> - </dl> - <dl><dd>Vector from <code>vertex1</code> to <code>vertex2</code>.</dd></dl> - <dl></dl> - <hr></hr> -<a name="d0"></a><dl> - <dt> - - <code></code> - <code>val</code> - <em>d0</em> : <a href="../../sims/geometry/Vector2D.html" target="_self">Vector2D</a> - </dt> - <dd></dd> - </dl> - <dl><dd>Unit directional vector.</dd></dl> - <dl></dl> - <hr></hr> -<a name="n"></a><dl> - <dt> - - <code></code> - <code>val</code> - <em>n</em> : <a href="../../sims/geometry/Vector2D.html" target="_self">Vector2D</a> - </dt> - <dd></dd> - </dl> - <dl><dd>Right normal vector.</dd></dl> - <dl></dl> - <hr></hr> -<a name="n0"></a><dl> - <dt> - - <code></code> - <code>val</code> - <em>n0</em> : <a href="../../sims/geometry/Vector2D.html" target="_self">Vector2D</a> - </dt> - <dd></dd> - </dl> - <dl><dd>Right normal unit vector.</dd></dl> - <dl></dl> - <hr></hr></div> -<table summary="" cellpadding="3" class="member-detail"> - <tr><td class="title">Method Details</td></tr> - </table><div><a name="distance%28sims.geometry.Vector2D%29"></a><dl> - <dt> - - <code></code> - <code>def</code> - <em>distance</em>(<em>point</em> : <a href="../../sims/geometry/Vector2D.html" target="_self">Vector2D</a>) : <a href="http://www.scala-lang.org/docu/files/api/scala/Double.html" target="_self">Double</a> - </dt> - <dd></dd> - </dl> - <dl><dd>Smallest distance between this segment and the point <code>point</code>.</dd></dl> - <dl></dl> - <hr></hr> -<a name="clipToSegment%28sims.geometry.Segment%29"></a><dl> - <dt> - - <code></code> - <code>def</code> - <em>clipToSegment</em>(<em>s</em> : <a href="../../sims/geometry/Segment.html" target="_self">Segment</a>) : <a href="" target="contentFrame" class="scala/Option">scala.Option</a>[<a href="../../sims/geometry/Vector2D.html" target="_self">Vector2D</a>] - </dt> - <dd></dd> - </dl><hr></hr> -<a name="hashCode%28%29"></a><dl> - <dt> - - <code>override</code> - <code>def</code> - <em>hashCode</em> : <a href="http://www.scala-lang.org/docu/files/api/scala/Int.html" target="_self">Int</a> - </dt> - <dd></dd> - </dl> - <dl><dd>Returns a hash code value for the object.
- <p>
- The default hashing algorithm is platform dependent.
- 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></dd></dl> - <dl><dt style="margin:10px 0 0 20px;"> - <b>Returns</b></dt><dd>the hash code value for the object. </p></dd></dl> - <hr></hr> -<a name="toString%28%29"></a><dl> - <dt> - - <code>override</code> - <code>def</code> - <em>toString</em> : <a href="" target="contentFrame" class="java/lang/String">java.lang.String</a> - </dt> - <dd></dd> - </dl> - <dl><dd>Returns a string representation of the object.
- <p>
- The default representation is platform dependent.</dd></dl> - <dl><dt style="margin:10px 0 0 20px;"> - <b>Returns</b></dt><dd>a string representation of the object. </p></dd></dl> - <hr></hr> -<a name="equals%28Any%29"></a><dl> - <dt> - - <code>override</code> - <code>def</code> - <em>equals</em>(<em>arg0</em> : <a href="http://www.scala-lang.org/docu/files/api/scala/Any.html" target="_self">Any</a>) : <a href="http://www.scala-lang.org/docu/files/api/scala/Boolean.html" target="_self">Boolean</a> - </dt> - <dd></dd> - </dl> - <dl><dd>This method is used to compare the receiver object (<code>this</code>)
- with the argument object (<code>arg0</code>) for equivalence.
-
- <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>
- 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>).</dd></dl> - <dl><dt style="margin:10px 0 0 20px;"> - <b>Parameters</b></dt><dd><code>arg0 - </code>the object to compare against this object for equality.</dd><dt style="margin:10px 0 0 20px;"> - <b>Returns</b></dt><dd><code>true</code> if the receiver object is equivalent to the argument; <code>false</code> otherwise. </p></dd></dl> - <hr></hr> -<a name="productPrefix"></a><dl> - <dt> - - <code>override</code> - <code>def</code> - <em>productPrefix</em> : <a href="" target="contentFrame" class="java/lang/String">java.lang.String</a> - </dt> - <dd></dd> - </dl><dl> - <dt style="margin:10px 0 0 20px;"> - <b>Overrides</b> - </dt> - <dd> - <a href="" target="contentFrame" class="scala/Product">scala.Product</a>.<a href="#productPrefix" target="contentFrame" class="scala/Product">scala.Product.productPrefix</a> - </dd> - </dl><hr></hr> -<a name="productArity"></a><dl> - <dt> - - <code>override</code> - <code>def</code> - <em>productArity</em> : <a href="http://www.scala-lang.org/docu/files/api/scala/Int.html" target="_self">Int</a> - </dt> - <dd></dd> - </dl><dl> - <dt style="margin:10px 0 0 20px;"> - <b>Overrides</b> - </dt> - <dd> - <a href="" target="contentFrame" class="scala/Product">scala.Product</a>.<a href="#productArity" target="contentFrame" class="scala/Product">scala.Product.productArity</a> - </dd> - </dl><hr></hr> -<a name="productElement%28Int%29"></a><dl> - <dt> + + + </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> - <code>override</code> - <code>def</code> - <em>productElement</em>(<em>arg0</em> : <a href="http://www.scala-lang.org/docu/files/api/scala/Int.html" target="_self">Int</a>) : <a href="http://www.scala-lang.org/docu/files/api/scala/Any.html" target="_self">Any</a> - </dt> - <dd></dd> - </dl><dl> - <dt style="margin:10px 0 0 20px;"> - <b>Overrides</b> - </dt> - <dd> - <a href="" target="contentFrame" class="scala/Product">scala.Product</a>.<a href="#productElement" target="contentFrame" class="scala/Product">scala.Product.productElement</a> - </dd> - </dl><hr></hr></div> - - - <hr></hr> - <table summary="" class="navigation"> - <tr> - <td class="navigation-links" valign="top"> - <!-- <table><tr></tr></table> --> - </td> - <td align="right" valign="top" style="white-space:nowrap;" rowspan="2"> - <div class="doctitle-larger">SiMS</div> - </td> - </tr> - <tr><td></td></tr> - </table> - </body> + </div> + + </body> </html>
\ No newline at end of file diff --git a/doc/sims/geometry/Vector2D$.html b/doc/sims/geometry/Vector2D$.html new file mode 100644 index 0000000..52ef68b --- /dev/null +++ b/doc/sims/geometry/Vector2D$.html @@ -0,0 +1,190 @@ +<?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$object.html b/doc/sims/geometry/Vector2D$object.html deleted file mode 100644 index ee73bb6..0000000 --- a/doc/sims/geometry/Vector2D$object.html +++ /dev/null @@ -1,150 +0,0 @@ -<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
-<html> - <head><title>object Vector2D in sims.geometry</title> - <meta http-equiv="content-type" content="text/html; charset=UTF8"></meta><meta content="scaladoc (version 2.7.5.final)" name="generator"></meta><link href="../../style.css" type="text/css" rel="stylesheet"></link><script type="text/javascript" src="../../script.js"></script> - </head> - <body onload="init()"> - <table summary="" class="navigation"> - <tr> - <td class="navigation-links" valign="top"> - <!-- <table><tr></tr></table> --> - </td> - <td align="right" valign="top" style="white-space:nowrap;" rowspan="2"> - <div class="doctitle-larger">SiMS</div> - </td> - </tr> - <tr><td></td></tr> - </table> - - <div class="entity"> - <a href="../../sims/geometry$package.html" target="_self">sims.geometry</a> - <br></br> - <span class="entity">object Vector2D</span> - </div><hr></hr> - <div class="source"> - [source: <a href="" class="sims/geometry/Vector2D"><code>sims/geometry/Vector2D.scala</code></a>] - </div><hr></hr> - <a name="Vector2D"></a><dl> - <dt> - - <code></code> - <code>object</code> - <em>Vector2D</em> - </dt> - <dd><code> extends </code><a href="http://www.scala-lang.org/docu/files/api/scala/AnyRef.html" target="_self">AnyRef</a></dd> - </dl> - <dl><dd>Contains special vectors.</dd></dl> - <dl></dl> - - - -<table summary="" cellpadding="3" class="member"> - <tr><td class="title" colspan="2">Value Summary</td></tr> - <tr> - <td class="modifiers" valign="top"> - <code> val</code> - </td> - <td class="signature"> - <em><a href="../../sims/geometry/Vector2D$object.html#Null" target="_self">Null</a></em> - : <a href="../../sims/geometry/Vector2D.html" target="_self">Vector2D</a> - - <div>Null vector.</div> - </td> - </tr> -<tr> - <td class="modifiers" valign="top"> - <code> val</code> - </td> - <td class="signature"> - <em><a href="../../sims/geometry/Vector2D$object.html#i" target="_self">i</a></em> - : <a href="../../sims/geometry/Vector2D.html" target="_self">Vector2D</a> - - <div>Horizontal unit vector. (1,0)</div> - </td> - </tr> -<tr> - <td class="modifiers" valign="top"> - <code> val</code> - </td> - <td class="signature"> - <em><a href="../../sims/geometry/Vector2D$object.html#j" target="_self">j</a></em> - : <a href="../../sims/geometry/Vector2D.html" target="_self">Vector2D</a> - - <div>Vertical unit vector. (0,1)</div> - </td> - </tr> - </table> -<table summary="" cellpadding="3" class="inherited"> - <tr><td class="title" colspan="2"> - Methods inherited from <a href="http://www.scala-lang.org/docu/files/api/scala/AnyRef.html" target="_self">AnyRef</a> - </td></tr> - <tr><td class="signature" colspan="2"> - <a href="http://www.scala-lang.org/docu/files/api/scala/AnyRef.html#getClass%28%29" target="_self">getClass</a>, <a href="http://www.scala-lang.org/docu/files/api/scala/AnyRef.html#hashCode%28%29" target="_self">hashCode</a>, <a href="http://www.scala-lang.org/docu/files/api/scala/AnyRef.html#equals%28Any%29" target="_self">equals</a>, <a href="http://www.scala-lang.org/docu/files/api/scala/AnyRef.html#clone%28%29" target="_self">clone</a>, <a href="http://www.scala-lang.org/docu/files/api/scala/AnyRef.html#toString%28%29" target="_self">toString</a>, <a href="http://www.scala-lang.org/docu/files/api/scala/AnyRef.html#notify%28%29" target="_self">notify</a>, <a href="http://www.scala-lang.org/docu/files/api/scala/AnyRef.html#notifyAll%28%29" target="_self">notifyAll</a>, <a href="http://www.scala-lang.org/docu/files/api/scala/AnyRef.html#wait%28Long%29" target="_self">wait</a>, <a href="http://www.scala-lang.org/docu/files/api/scala/AnyRef.html#wait%28Long%2CInt%29" target="_self">wait</a>, <a href="http://www.scala-lang.org/docu/files/api/scala/AnyRef.html#wait%28%29" target="_self">wait</a>, <a href="http://www.scala-lang.org/docu/files/api/scala/AnyRef.html#finalize%28%29" target="_self">finalize</a>, <a href="http://www.scala-lang.org/docu/files/api/scala/AnyRef.html#%3D%3D%28AnyRef%29" target="_self">==</a>, <a href="http://www.scala-lang.org/docu/files/api/scala/AnyRef.html#%21%3D%28AnyRef%29" target="_self">!=</a>, <a href="http://www.scala-lang.org/docu/files/api/scala/AnyRef.html#eq%28AnyRef%29" target="_self">eq</a>, <a href="http://www.scala-lang.org/docu/files/api/scala/AnyRef.html#ne%28AnyRef%29" target="_self">ne</a>, <a href="http://www.scala-lang.org/docu/files/api/scala/AnyRef.html#synchronized%28T0%29" target="_self">synchronized</a> - </td></tr> - </table><table summary="" cellpadding="3" class="inherited"> - <tr><td class="title" colspan="2"> - Methods inherited from <a href="http://www.scala-lang.org/docu/files/api/scala/Any.html" target="_self">Any</a> - </td></tr> - <tr><td class="signature" colspan="2"> - <a href="http://www.scala-lang.org/docu/files/api/scala/Any.html#%3D%3D%28Any%29" target="_self">==</a>, <a href="http://www.scala-lang.org/docu/files/api/scala/Any.html#%21%3D%28Any%29" target="_self">!=</a>, <a href="http://www.scala-lang.org/docu/files/api/scala/Any.html#isInstanceOf" target="_self">isInstanceOf</a>, <a href="http://www.scala-lang.org/docu/files/api/scala/Any.html#asInstanceOf" target="_self">asInstanceOf</a> - </td></tr> - </table> - - - - -<table summary="" cellpadding="3" class="member-detail"> - <tr><td class="title">Value Details</td></tr> - </table><div><a name="Null"></a><dl> - <dt> - - <code></code> - <code>val</code> - <em>Null</em> : <a href="../../sims/geometry/Vector2D.html" target="_self">Vector2D</a> - </dt> - <dd></dd> - </dl> - <dl><dd>Null vector.</dd></dl> - <dl></dl> - <hr></hr> -<a name="i"></a><dl> - <dt> - - <code></code> - <code>val</code> - <em>i</em> : <a href="../../sims/geometry/Vector2D.html" target="_self">Vector2D</a> - </dt> - <dd></dd> - </dl> - <dl><dd>Horizontal unit vector. (1,0)</dd></dl> - <dl></dl> - <hr></hr> -<a name="j"></a><dl> - <dt> - - <code></code> - <code>val</code> - <em>j</em> : <a href="../../sims/geometry/Vector2D.html" target="_self">Vector2D</a> - </dt> - <dd></dd> - </dl> - <dl><dd>Vertical unit vector. (0,1)</dd></dl> - <dl></dl> - <hr></hr></div> - - - - <hr></hr> - <table summary="" class="navigation"> - <tr> - <td class="navigation-links" valign="top"> - <!-- <table><tr></tr></table> --> - </td> - <td align="right" valign="top" style="white-space:nowrap;" rowspan="2"> - <div class="doctitle-larger">SiMS</div> - </td> - </tr> - <tr><td></td></tr> - </table> - </body> - </html>
\ No newline at end of file diff --git a/doc/sims/geometry/Vector2D.html b/doc/sims/geometry/Vector2D.html index 816428e..990b144 100644 --- a/doc/sims/geometry/Vector2D.html +++ b/doc/sims/geometry/Vector2D.html @@ -1,628 +1,435 @@ -<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
+<?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>class Vector2D in sims.geometry</title> - <meta http-equiv="content-type" content="text/html; charset=UTF8"></meta><meta content="scaladoc (version 2.7.5.final)" name="generator"></meta><link href="../../style.css" type="text/css" rel="stylesheet"></link><script type="text/javascript" src="../../script.js"></script> - </head> - <body onload="init()"> - <table summary="" class="navigation"> - <tr> - <td class="navigation-links" valign="top"> - <!-- <table><tr></tr></table> --> - </td> - <td align="right" valign="top" style="white-space:nowrap;" rowspan="2"> - <div class="doctitle-larger">SiMS</div> - </td> - </tr> - <tr><td></td></tr> - </table> - - <div class="entity"> - <a href="../../sims/geometry$package.html" target="_self">sims.geometry</a> - <br></br> - <span class="entity">class Vector2D</span> - </div><hr></hr> - <div class="source"> - [source: <a href="" class="sims/geometry/Vector2D"><code>sims/geometry/Vector2D.scala</code></a>] - </div><hr></hr> - <a name="Vector2D"></a><dl> - <dt> - - <code>case</code> - <code>class</code> - <em>Vector2D</em>(<code>val </code><em>x</em> : <a href="http://www.scala-lang.org/docu/files/api/scala/Double.html" target="_self">Double</a>, <code>val </code><em>y</em> : <a href="http://www.scala-lang.org/docu/files/api/scala/Double.html" target="_self">Double</a>) - </dt> - <dd><code> extends </code><a href="" target="contentFrame" class="scala/Product">scala.Product</a></dd> - </dl> - <dl><dd>A 2D vector.</dd></dl> - <dl><dt style="margin:10px 0 0 20px;"> - <b>Parameters</b></dt><dd><code>x - </code>1st component</dd><dd><code>y - </code>2nd component</dd></dl> + <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> -<table summary="" cellpadding="3" class="member"> - <tr><td class="title" colspan="2">Value Summary</td></tr> - <tr> - <td class="modifiers" valign="top"> - <code> val</code> - </td> - <td class="signature"> - <em><a href="../../sims/geometry/Vector2D.html#length" target="_self">length</a></em> - : <a href="http://www.scala-lang.org/docu/files/api/scala/Double.html" target="_self">Double</a> - - <div>Norm or length of this vector.</div> - </td> - </tr> - </table> -<table summary="" cellpadding="3" class="member"> - <tr><td class="title" colspan="2">Method Summary</td></tr> - <tr> - <td class="modifiers" valign="top"> - <code> def</code> - </td> - <td class="signature"> - <em><a href="../../sims/geometry/Vector2D.html#*%28Double%29" target="_self">*</a></em> - (<em>n</em> : <a href="http://www.scala-lang.org/docu/files/api/scala/Double.html" target="_self">Double</a>) : <a href="../../sims/geometry/Vector2D.html" target="_self">Vector2D</a> - - <div>Scalar multiplication.</div> - </td> - </tr> -<tr> - <td class="modifiers" valign="top"> - <code> def</code> - </td> - <td class="signature"> - <em><a href="../../sims/geometry/Vector2D.html#%2B%28sims.geometry.Vector2D%29" target="_self">+</a></em> - (<em>v</em> : <a href="../../sims/geometry/Vector2D.html" target="_self">Vector2D</a>) : <a href="../../sims/geometry/Vector2D.html" target="_self">Vector2D</a> - - <div>Vector addition.</div> - </td> - </tr> -<tr> - <td class="modifiers" valign="top"> - <code> def</code> - </td> - <td class="signature"> - <em><a href="../../sims/geometry/Vector2D.html#-%28sims.geometry.Vector2D%29" target="_self">-</a></em> - (<em>v</em> : <a href="../../sims/geometry/Vector2D.html" target="_self">Vector2D</a>) : <a href="../../sims/geometry/Vector2D.html" target="_self">Vector2D</a> - - <div>Vector substraction.</div> - </td> - </tr> -<tr> - <td class="modifiers" valign="top"> - <code> def</code> - </td> - <td class="signature"> - <em><a href="../../sims/geometry/Vector2D.html#%2F%28Double%29" target="_self">/</a></em> - (<em>n</em> : <a href="http://www.scala-lang.org/docu/files/api/scala/Double.html" target="_self">Double</a>) : <a href="../../sims/geometry/Vector2D.html" target="_self">Vector2D</a> - - <div>Scalar division.</div> - </td> - </tr> -<tr> - <td class="modifiers" valign="top"> - <code> def</code> - </td> - <td class="signature"> - <em><a href="../../sims/geometry/Vector2D.html#components" target="_self">components</a></em> - : <a href="" target="contentFrame" class="scala/List">scala.List</a>[<a href="http://www.scala-lang.org/docu/files/api/scala/Double.html" target="_self">Double</a>] - - <div>Returns a list of this vector's components.</div> - </td> - </tr> -<tr> - <td class="modifiers" valign="top"> - <code> def</code> - </td> - <td class="signature"> - <em><a href="../../sims/geometry/Vector2D.html#cross%28sims.geometry.Vector2D%29" target="_self">cross</a></em> - (<em>v</em> : <a href="../../sims/geometry/Vector2D.html" target="_self">Vector2D</a>) : <a href="http://www.scala-lang.org/docu/files/api/scala/Double.html" target="_self">Double</a> - - <div>Cross product. Length only because in 2D. The direction would be given by the x3-axis.</div> - </td> - </tr> -<tr> - <td class="modifiers" valign="top"> - <code> def</code> - </td> - <td class="signature"> - <em><a href="../../sims/geometry/Vector2D.html#dot%28sims.geometry.Vector2D%29" target="_self">dot</a></em> - (<em>v</em> : <a href="../../sims/geometry/Vector2D.html" target="_self">Vector2D</a>) : <a href="http://www.scala-lang.org/docu/files/api/scala/Double.html" target="_self">Double</a> - - <div>Dot product.</div> - </td> - </tr> -<tr> - <td class="modifiers" valign="top"> - <code>override def</code> - </td> - <td class="signature"> - <em><a href="../../sims/geometry/Vector2D.html#equals%28Any%29" target="_self">equals</a></em> - (<em>arg0</em> : <a href="http://www.scala-lang.org/docu/files/api/scala/Any.html" target="_self">Any</a>) : <a href="http://www.scala-lang.org/docu/files/api/scala/Boolean.html" target="_self">Boolean</a> - - <div>This method is used to compare the receiver object (<code>this</code>)
- with the argument object (<code>arg0</code>) for equivalence.</div> - </td> - </tr> -<tr> - <td class="modifiers" valign="top"> - <code>override def</code> - </td> - <td class="signature"> - <em><a href="../../sims/geometry/Vector2D.html#hashCode%28%29" target="_self">hashCode</a></em> - : <a href="http://www.scala-lang.org/docu/files/api/scala/Int.html" target="_self">Int</a> - - <div>Returns a hash code value for the object.</div> - </td> - </tr> -<tr> - <td class="modifiers" valign="top"> - <code> def</code> - </td> - <td class="signature"> - <em><a href="../../sims/geometry/Vector2D.html#isNull" target="_self">isNull</a></em> - : <a href="http://www.scala-lang.org/docu/files/api/scala/Boolean.html" target="_self">Boolean</a> - - <div>Checks if this vector is the null vector.</div> - </td> - </tr> -<tr> - <td class="modifiers" valign="top"> - <code> def</code> - </td> - <td class="signature"> - <em><a href="../../sims/geometry/Vector2D.html#leftNormal" target="_self">leftNormal</a></em> - : <a href="../../sims/geometry/Vector2D.html" target="_self">Vector2D</a> - - <div>Left normal vector. (-y, x)</div> - </td> - </tr> -<tr> - <td class="modifiers" valign="top"> - <code>override def</code> - </td> - <td class="signature"> - <em><a href="../../sims/geometry/Vector2D.html#productArity" target="_self">productArity</a></em> - : <a href="http://www.scala-lang.org/docu/files/api/scala/Int.html" target="_self">Int</a> - - - </td> - </tr> -<tr> - <td class="modifiers" valign="top"> - <code>override def</code> - </td> - <td class="signature"> - <em><a href="../../sims/geometry/Vector2D.html#productElement%28Int%29" target="_self">productElement</a></em> - (<em>arg0</em> : <a href="http://www.scala-lang.org/docu/files/api/scala/Int.html" target="_self">Int</a>) : <a href="http://www.scala-lang.org/docu/files/api/scala/Any.html" target="_self">Any</a> - - - </td> - </tr> -<tr> - <td class="modifiers" valign="top"> - <code>override def</code> - </td> - <td class="signature"> - <em><a href="../../sims/geometry/Vector2D.html#productPrefix" target="_self">productPrefix</a></em> - : <a href="" target="contentFrame" class="java/lang/String">java.lang.String</a> - - - </td> - </tr> -<tr> - <td class="modifiers" valign="top"> - <code> def</code> - </td> - <td class="signature"> - <em><a href="../../sims/geometry/Vector2D.html#project%28sims.geometry.Vector2D%29" target="_self">project</a></em> - (<em>v</em> : <a href="../../sims/geometry/Vector2D.html" target="_self">Vector2D</a>) : <a href="../../sims/geometry/Vector2D.html" target="_self">Vector2D</a> - - <div>Returns the projection of this vector onto the vector <code>v</code>.</div> - </td> - </tr> -<tr> - <td class="modifiers" valign="top"> - <code> def</code> - </td> - <td class="signature"> - <em><a href="../../sims/geometry/Vector2D.html#rightNormal" target="_self">rightNormal</a></em> - : <a href="../../sims/geometry/Vector2D.html" target="_self">Vector2D</a> - - <div>Right normal vector. (y, -x)</div> - </td> - </tr> -<tr> - <td class="modifiers" valign="top"> - <code> def</code> - </td> - <td class="signature"> - <em><a href="../../sims/geometry/Vector2D.html#rotate%28Double%29" target="_self">rotate</a></em> - (<em>angle</em> : <a href="http://www.scala-lang.org/docu/files/api/scala/Double.html" target="_self">Double</a>) : <a href="../../sims/geometry/Vector2D.html" target="_self">Vector2D</a> - - <div>Returns a rotation of this vector by <code>angle</code> radian.</div> - </td> - </tr> -<tr> - <td class="modifiers" valign="top"> - <code>override def</code> - </td> - <td class="signature"> - <em><a href="../../sims/geometry/Vector2D.html#toString%28%29" target="_self">toString</a></em> - : <a href="" target="contentFrame" class="java/lang/String">java.lang.String</a> - - <div>Returns a string representation of the object.</div> - </td> - </tr> -<tr> - <td class="modifiers" valign="top"> - <code> def</code> - </td> - <td class="signature"> - <em><a href="../../sims/geometry/Vector2D.html#unary_-" target="_self">unary_-</a></em> - : <a href="../../sims/geometry/Vector2D.html" target="_self">Vector2D</a> - - <div>Unary minus.</div> - </td> - </tr> -<tr> - <td class="modifiers" valign="top"> - <code> def</code> - </td> - <td class="signature"> - <em><a href="../../sims/geometry/Vector2D.html#unit" target="_self">unit</a></em> - : <a href="../../sims/geometry/Vector2D.html" target="_self">Vector2D</a> - - <div>Unit vector.</div> - </td> - </tr> - </table><table summary="" cellpadding="3" class="inherited"> - <tr><td class="title" colspan="2"> - Methods inherited from <a href="http://www.scala-lang.org/docu/files/api/scala/AnyRef.html" target="_self">AnyRef</a> - </td></tr> - <tr><td class="signature" colspan="2"> - <a href="http://www.scala-lang.org/docu/files/api/scala/AnyRef.html#getClass%28%29" target="_self">getClass</a>, <a href="http://www.scala-lang.org/docu/files/api/scala/AnyRef.html#clone%28%29" target="_self">clone</a>, <a href="http://www.scala-lang.org/docu/files/api/scala/AnyRef.html#notify%28%29" target="_self">notify</a>, <a href="http://www.scala-lang.org/docu/files/api/scala/AnyRef.html#notifyAll%28%29" target="_self">notifyAll</a>, <a href="http://www.scala-lang.org/docu/files/api/scala/AnyRef.html#wait%28Long%29" target="_self">wait</a>, <a href="http://www.scala-lang.org/docu/files/api/scala/AnyRef.html#wait%28Long%2CInt%29" target="_self">wait</a>, <a href="http://www.scala-lang.org/docu/files/api/scala/AnyRef.html#wait%28%29" target="_self">wait</a>, <a href="http://www.scala-lang.org/docu/files/api/scala/AnyRef.html#finalize%28%29" target="_self">finalize</a>, <a href="http://www.scala-lang.org/docu/files/api/scala/AnyRef.html#%3D%3D%28AnyRef%29" target="_self">==</a>, <a href="http://www.scala-lang.org/docu/files/api/scala/AnyRef.html#%21%3D%28AnyRef%29" target="_self">!=</a>, <a href="http://www.scala-lang.org/docu/files/api/scala/AnyRef.html#eq%28AnyRef%29" target="_self">eq</a>, <a href="http://www.scala-lang.org/docu/files/api/scala/AnyRef.html#ne%28AnyRef%29" target="_self">ne</a>, <a href="http://www.scala-lang.org/docu/files/api/scala/AnyRef.html#synchronized%28T0%29" target="_self">synchronized</a> - </td></tr> - </table><table summary="" cellpadding="3" class="inherited"> - <tr><td class="title" colspan="2"> - Methods inherited from <a href="http://www.scala-lang.org/docu/files/api/scala/Any.html" target="_self">Any</a> - </td></tr> - <tr><td class="signature" colspan="2"> - <a href="http://www.scala-lang.org/docu/files/api/scala/Any.html#%3D%3D%28Any%29" target="_self">==</a>, <a href="http://www.scala-lang.org/docu/files/api/scala/Any.html#%21%3D%28Any%29" target="_self">!=</a>, <a href="http://www.scala-lang.org/docu/files/api/scala/Any.html#isInstanceOf" target="_self">isInstanceOf</a>, <a href="http://www.scala-lang.org/docu/files/api/scala/Any.html#asInstanceOf" target="_self">asInstanceOf</a> - </td></tr> - </table> - + <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> - -<table summary="" cellpadding="3" class="member-detail"> - <tr><td class="title">Value Details</td></tr> - </table><div><a name="length"></a><dl> - <dt> - - <code></code> - <code>val</code> - <em>length</em> : <a href="http://www.scala-lang.org/docu/files/api/scala/Double.html" target="_self">Double</a> - </dt> - <dd></dd> - </dl> - <dl><dd>Norm or length of this vector.</dd></dl> - <dl></dl> - <hr></hr></div> -<table summary="" cellpadding="3" class="member-detail"> - <tr><td class="title">Method Details</td></tr> - </table><div><a name="%2B%28sims.geometry.Vector2D%29"></a><dl> - <dt> - - <code></code> - <code>def</code> - <em>+</em>(<em>v</em> : <a href="../../sims/geometry/Vector2D.html" target="_self">Vector2D</a>) : <a href="../../sims/geometry/Vector2D.html" target="_self">Vector2D</a> - </dt> - <dd></dd> - </dl> - <dl><dd>Vector addition.</dd></dl> - <dl></dl> - <hr></hr> -<a name="-%28sims.geometry.Vector2D%29"></a><dl> - <dt> - - <code></code> - <code>def</code> - <em>-</em>(<em>v</em> : <a href="../../sims/geometry/Vector2D.html" target="_self">Vector2D</a>) : <a href="../../sims/geometry/Vector2D.html" target="_self">Vector2D</a> - </dt> - <dd></dd> - </dl> - <dl><dd>Vector substraction.</dd></dl> - <dl></dl> - <hr></hr> -<a name="*%28Double%29"></a><dl> - <dt> - - <code></code> - <code>def</code> - <em>*</em>(<em>n</em> : <a href="http://www.scala-lang.org/docu/files/api/scala/Double.html" target="_self">Double</a>) : <a href="../../sims/geometry/Vector2D.html" target="_self">Vector2D</a> - </dt> - <dd></dd> - </dl> - <dl><dd>Scalar multiplication.</dd></dl> - <dl></dl> - <hr></hr> -<a name="%2F%28Double%29"></a><dl> - <dt> - - <code></code> - <code>def</code> - <em>/</em>(<em>n</em> : <a href="http://www.scala-lang.org/docu/files/api/scala/Double.html" target="_self">Double</a>) : <a href="../../sims/geometry/Vector2D.html" target="_self">Vector2D</a> - </dt> - <dd></dd> - </dl> - <dl><dd>Scalar division.</dd></dl> - <dl></dl> - <hr></hr> -<a name="unary_-"></a><dl> - <dt> - - <code></code> - <code>def</code> - <em>unary_-</em> : <a href="../../sims/geometry/Vector2D.html" target="_self">Vector2D</a> - </dt> - <dd></dd> - </dl> - <dl><dd>Unary minus.</dd></dl> - <dl></dl> - <hr></hr> -<a name="dot%28sims.geometry.Vector2D%29"></a><dl> - <dt> - - <code></code> - <code>def</code> - <em>dot</em>(<em>v</em> : <a href="../../sims/geometry/Vector2D.html" target="_self">Vector2D</a>) : <a href="http://www.scala-lang.org/docu/files/api/scala/Double.html" target="_self">Double</a> - </dt> - <dd></dd> - </dl> - <dl><dd>Dot product.</dd></dl> - <dl></dl> - <hr></hr> -<a name="cross%28sims.geometry.Vector2D%29"></a><dl> - <dt> - - <code></code> - <code>def</code> - <em>cross</em>(<em>v</em> : <a href="../../sims/geometry/Vector2D.html" target="_self">Vector2D</a>) : <a href="http://www.scala-lang.org/docu/files/api/scala/Double.html" target="_self">Double</a> - </dt> - <dd></dd> - </dl> - <dl><dd>Cross product. Length only because in 2D. The direction would be given by the x3-axis.</dd></dl> - <dl></dl> - <hr></hr> -<a name="unit"></a><dl> - <dt> - - <code></code> - <code>def</code> - <em>unit</em> : <a href="../../sims/geometry/Vector2D.html" target="_self">Vector2D</a> - </dt> - <dd></dd> - </dl> - <dl><dd>Unit vector.</dd></dl> - <dl></dl> - <hr></hr> -<a name="project%28sims.geometry.Vector2D%29"></a><dl> - <dt> - - <code></code> - <code>def</code> - <em>project</em>(<em>v</em> : <a href="../../sims/geometry/Vector2D.html" target="_self">Vector2D</a>) : <a href="../../sims/geometry/Vector2D.html" target="_self">Vector2D</a> - </dt> - <dd></dd> - </dl> - <dl><dd>Returns the projection of this vector onto the vector <code>v</code>.</dd></dl> - <dl></dl> - <hr></hr> -<a name="rotate%28Double%29"></a><dl> - <dt> - - <code></code> - <code>def</code> - <em>rotate</em>(<em>angle</em> : <a href="http://www.scala-lang.org/docu/files/api/scala/Double.html" target="_self">Double</a>) : <a href="../../sims/geometry/Vector2D.html" target="_self">Vector2D</a> - </dt> - <dd></dd> - </dl> - <dl><dd>Returns a rotation of this vector by <code>angle</code> radian.</dd></dl> - <dl></dl> - <hr></hr> -<a name="leftNormal"></a><dl> - <dt> - - <code></code> - <code>def</code> - <em>leftNormal</em> : <a href="../../sims/geometry/Vector2D.html" target="_self">Vector2D</a> - </dt> - <dd></dd> - </dl> - <dl><dd>Left normal vector. (-y, x)</dd></dl> - <dl></dl> - <hr></hr> -<a name="rightNormal"></a><dl> - <dt> - - <code></code> - <code>def</code> - <em>rightNormal</em> : <a href="../../sims/geometry/Vector2D.html" target="_self">Vector2D</a> - </dt> - <dd></dd> - </dl> - <dl><dd>Right normal vector. (y, -x)</dd></dl> - <dl></dl> - <hr></hr> -<a name="isNull"></a><dl> - <dt> - - <code></code> - <code>def</code> - <em>isNull</em> : <a href="http://www.scala-lang.org/docu/files/api/scala/Boolean.html" target="_self">Boolean</a> - </dt> - <dd></dd> - </dl> - <dl><dd>Checks if this vector is the null vector.</dd></dl> - <dl></dl> - <hr></hr> -<a name="components"></a><dl> - <dt> - - <code></code> - <code>def</code> - <em>components</em> : <a href="" target="contentFrame" class="scala/List">scala.List</a>[<a href="http://www.scala-lang.org/docu/files/api/scala/Double.html" target="_self">Double</a>] - </dt> - <dd></dd> - </dl> - <dl><dd>Returns a list of this vector's components.</dd></dl> - <dl></dl> - <hr></hr> -<a name="hashCode%28%29"></a><dl> - <dt> - - <code>override</code> - <code>def</code> - <em>hashCode</em> : <a href="http://www.scala-lang.org/docu/files/api/scala/Int.html" target="_self">Int</a> - </dt> - <dd></dd> - </dl> - <dl><dd>Returns a hash code value for the object.
- <p>
- The default hashing algorithm is platform dependent.
- 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></dd></dl> - <dl><dt style="margin:10px 0 0 20px;"> - <b>Returns</b></dt><dd>the hash code value for the object. </p></dd></dl> - <hr></hr> -<a name="toString%28%29"></a><dl> - <dt> - - <code>override</code> - <code>def</code> - <em>toString</em> : <a href="" target="contentFrame" class="java/lang/String">java.lang.String</a> - </dt> - <dd></dd> - </dl> - <dl><dd>Returns a string representation of the object.
- <p>
- The default representation is platform dependent.</dd></dl> - <dl><dt style="margin:10px 0 0 20px;"> - <b>Returns</b></dt><dd>a string representation of the object. </p></dd></dl> - <hr></hr> -<a name="equals%28Any%29"></a><dl> - <dt> - - <code>override</code> - <code>def</code> - <em>equals</em>(<em>arg0</em> : <a href="http://www.scala-lang.org/docu/files/api/scala/Any.html" target="_self">Any</a>) : <a href="http://www.scala-lang.org/docu/files/api/scala/Boolean.html" target="_self">Boolean</a> - </dt> - <dd></dd> - </dl> - <dl><dd>This method is used to compare the receiver object (<code>this</code>)
- with the argument object (<code>arg0</code>) for equivalence.
-
- <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>
- 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>).</dd></dl> - <dl><dt style="margin:10px 0 0 20px;"> - <b>Parameters</b></dt><dd><code>arg0 - </code>the object to compare against this object for equality.</dd><dt style="margin:10px 0 0 20px;"> - <b>Returns</b></dt><dd><code>true</code> if the receiver object is equivalent to the argument; <code>false</code> otherwise. </p></dd></dl> - <hr></hr> -<a name="productPrefix"></a><dl> - <dt> - - <code>override</code> - <code>def</code> - <em>productPrefix</em> : <a href="" target="contentFrame" class="java/lang/String">java.lang.String</a> - </dt> - <dd></dd> - </dl><dl> - <dt style="margin:10px 0 0 20px;"> - <b>Overrides</b> - </dt> - <dd> - <a href="" target="contentFrame" class="scala/Product">scala.Product</a>.<a href="#productPrefix" target="contentFrame" class="scala/Product">scala.Product.productPrefix</a> - </dd> - </dl><hr></hr> -<a name="productArity"></a><dl> - <dt> - - <code>override</code> - <code>def</code> - <em>productArity</em> : <a href="http://www.scala-lang.org/docu/files/api/scala/Int.html" target="_self">Int</a> - </dt> - <dd></dd> - </dl><dl> - <dt style="margin:10px 0 0 20px;"> - <b>Overrides</b> - </dt> - <dd> - <a href="" target="contentFrame" class="scala/Product">scala.Product</a>.<a href="#productArity" target="contentFrame" class="scala/Product">scala.Product.productArity</a> - </dd> - </dl><hr></hr> -<a name="productElement%28Int%29"></a><dl> - <dt> + + + </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> - <code>override</code> - <code>def</code> - <em>productElement</em>(<em>arg0</em> : <a href="http://www.scala-lang.org/docu/files/api/scala/Int.html" target="_self">Int</a>) : <a href="http://www.scala-lang.org/docu/files/api/scala/Any.html" target="_self">Any</a> - </dt> - <dd></dd> - </dl><dl> - <dt style="margin:10px 0 0 20px;"> - <b>Overrides</b> - </dt> - <dd> - <a href="" target="contentFrame" class="scala/Product">scala.Product</a>.<a href="#productElement" target="contentFrame" class="scala/Product">scala.Product.productElement</a> - </dd> - </dl><hr></hr></div> - - - <hr></hr> - <table summary="" class="navigation"> - <tr> - <td class="navigation-links" valign="top"> - <!-- <table><tr></tr></table> --> - </td> - <td align="right" valign="top" style="white-space:nowrap;" rowspan="2"> - <div class="doctitle-larger">SiMS</div> - </td> - </tr> - <tr><td></td></tr> - </table> - </body> + </div> + + </body> </html>
\ No newline at end of file diff --git a/doc/sims/geometry/package.html b/doc/sims/geometry/package.html new file mode 100644 index 0000000..7ae3ade --- /dev/null +++ b/doc/sims/geometry/package.html @@ -0,0 +1,105 @@ +<?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 |