diff options
Diffstat (limited to 'doc/sims/collision')
-rw-r--r-- | doc/sims/collision/AABB$object.html | 82 | ||||
-rw-r--r-- | doc/sims/collision/AABB.html | 534 | ||||
-rw-r--r-- | doc/sims/collision/CircleCollision$object.html | 82 | ||||
-rw-r--r-- | doc/sims/collision/CircleCollision.html | 706 | ||||
-rw-r--r-- | doc/sims/collision/Collision$.html | 162 | ||||
-rw-r--r-- | doc/sims/collision/Collision$object.html | 101 | ||||
-rw-r--r-- | doc/sims/collision/Collision.html | 500 | ||||
-rw-r--r-- | doc/sims/collision/Detector.html | 308 | ||||
-rw-r--r-- | doc/sims/collision/GridDetector.html | 604 | ||||
-rw-r--r-- | doc/sims/collision/Overlap$object.html | 82 | ||||
-rw-r--r-- | doc/sims/collision/Overlap.html | 493 | ||||
-rw-r--r-- | doc/sims/collision/Pair$object.html | 82 | ||||
-rw-r--r-- | doc/sims/collision/Pair.html | 513 | ||||
-rw-r--r-- | doc/sims/collision/PolyCircleCollision$object.html | 82 | ||||
-rw-r--r-- | doc/sims/collision/PolyCircleCollision.html | 706 | ||||
-rw-r--r-- | doc/sims/collision/PolyCollision$object.html | 82 | ||||
-rw-r--r-- | doc/sims/collision/PolyCollision.html | 798 | ||||
-rw-r--r-- | doc/sims/collision/package.html | 137 |
18 files changed, 2719 insertions, 3335 deletions
diff --git a/doc/sims/collision/AABB$object.html b/doc/sims/collision/AABB$object.html deleted file mode 100644 index 6d5d29d..0000000 --- a/doc/sims/collision/AABB$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 AABB in sims.collision</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/collision$package.html" target="_self">sims.collision</a> - <br></br> - <span class="entity">object AABB</span> - </div><hr></hr> - <div class="source"> - [source: <a href="" class="sims/collision/AABB"><code>sims/collision/AABB.scala</code></a>] - </div><hr></hr> - <a name="AABB"></a><dl> - <dt> - - <code></code> - <code>object</code> - <em>AABB</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/collision/AABB.html" target="_self">AABB</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/collision/AABB.html b/doc/sims/collision/AABB.html index a687d9d..9666bff 100644 --- a/doc/sims/collision/AABB.html +++ b/doc/sims/collision/AABB.html @@ -1,308 +1,242 @@ -<!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 AABB in sims.collision</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.collision.AABB</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/collision$package.html" target="_self">sims.collision</a> - <br></br> - <span class="entity">class AABB</span> - </div><hr></hr> - <div class="source"> - [source: <a href="" class="sims/collision/AABB"><code>sims/collision/AABB.scala</code></a>] - </div><hr></hr> - <a name="AABB"></a><dl> - <dt> - - <code>case</code> - <code>class</code> - <em>AABB</em>(<code>val </code><em>minVertex</em> : <a href="../../sims/geometry/Vector2D.html" target="_self">Vector2D</a>, <code>val </code><em>maxVertex</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>Axis Aligned Bounding Boxes (AABBs) are rectangles that frame a shape.
- Their X-Axis and Y-Axis orientation makes it easy to test two AABBs for overlap.</dd></dl> - <dl><dt style="margin:10px 0 0 20px;"> - <b>Parameters</b></dt><dd><code>minVertex - </code>Position vector of the bottom-left vertex</dd><dd><code>maxVertex - </code>Position vector of the upper-right vertex</dd></dl> - <dl> - <dt style="margin:10px 0 0 20px;"><b>Direct Known Subclasses:</b></dt> - <dd><a href="../../graphyx/graphics/GraphicalAABB.html" target="_self">GraphicalAABB</a></dd> - </dl><hr></hr> + <body class="type"> + <p id="owner"><a href="../package.html">sims</a>.<a href="package.html">collision</a></p> + <div id="definition"> + <img src="../../lib/class_big.png" /> + <h1>AABB</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/collision/AABB.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/collision/AABB.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/collision/AABB.html#overlaps%28sims.collision.AABB%29" target="_self">overlaps</a></em> - (<em>box</em> : <a href="../../sims/collision/AABB.html" target="_self">AABB</a>) : <a href="http://www.scala-lang.org/docu/files/api/scala/Boolean.html" target="_self">Boolean</a> - - <div>Checks this AABB with <code>box</code> for overlap.</div> - </td> - </tr> -<tr> - <td class="modifiers" valign="top"> - <code>override def</code> - </td> - <td class="signature"> - <em><a href="../../sims/collision/AABB.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/collision/AABB.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/collision/AABB.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/collision/AABB.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">AABB</span><span class="params">(<span name="minVertex">minVertex: <a href="../geometry/Vector2D.html" class="extype" name="sims.geometry.Vector2D">Vector2D</a></span>, <span name="maxVertex">maxVertex: <a href="../geometry/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>Axis Aligned Bounding Boxes (AABBs) are rectangles that frame a shape. +Their X-Axis and Y-Axis orientation makes it easy to test two AABBs for overlap.</p></div> + <dl class="paramcmts block"><dt class="param">minVertex</dt><dd class="cmt"><p>Position vector of the bottom-left vertex</p></dd><dt class="param">maxVertex</dt><dd class="cmt"><p>Position vector of the upper-right vertex</p></dd></dl> - - -<table summary="" cellpadding="3" class="member-detail"> - <tr><td class="title">Method Details</td></tr> - </table><div><a name="overlaps%28sims.collision.AABB%29"></a><dl> - <dt> - - <code></code> - <code>def</code> - <em>overlaps</em>(<em>box</em> : <a href="../../sims/collision/AABB.html" target="_self">AABB</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 AABB with <code>box</code> for overlap.</dd></dl> - <dl><dt style="margin:10px 0 0 20px;"> - <b>Parameters</b></dt><dd><code>box - </code>AABB with which to check for overlap</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 class="block"> + known subclasses: <a href="../../graphyx/graphics/GraphicalAABB.html">GraphicalAABB</a> + </div> + </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.collision.AABB#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.collision.AABB#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.collision.AABB#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.collision.AABB#maxVertex"> + <h4 class="signature"> + <span class="kind">val</span> + <span class="symbol"> + <span class="name">maxVertex</span><span class="result">: <a href="../geometry/Vector2D.html" class="extype" name="sims.geometry.Vector2D">Vector2D</a></span> + </span> + </h4> + + </li><li name="sims.collision.AABB#minVertex"> + <h4 class="signature"> + <span class="kind">val</span> + <span class="symbol"> + <span class="name">minVertex</span><span class="result">: <a href="../geometry/Vector2D.html" class="extype" name="sims.geometry.Vector2D">Vector2D</a></span> + </span> + </h4> + + </li><li name="sims.collision.AABB#overlaps"> + <h4 class="signature"> + <span class="kind">def</span> + <span class="symbol"> + <span class="name">overlaps</span><span class="params">(<span name="box">box: <a href="" class="extype" name="sims.collision.AABB">AABB</a></span>)</span><span class="result">: <span class="extype" name="scala.Boolean">Boolean</span></span> + </span> + </h4> + <p class="shortcomment cmt">Checks this AABB with <code>box</code> for overlap</p><div class="fullcomment"> + <div class="comment cmt"><p>Checks this AABB with <code>box</code> for overlap.</p></div> + <dl class="paramcmts block"><dt class="param">box</dt><dd class="cmt"><p>AABB with which to check for overlap</p></dd></dl> + + + + </div> + </li><li name="sims.collision.AABB#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.collision.AABB#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.collision.AABB#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.collision.AABB#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.collision.AABB#this"> + <h4 class="signature"> + <span class="kind">new</span> + <span class="symbol"> + <span class="name">AABB</span><span class="params">(<span name="minVertex">minVertex: <a href="../geometry/Vector2D.html" class="extype" name="sims.geometry.Vector2D">Vector2D</a></span>, <span name="maxVertex">maxVertex: <a href="../geometry/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">AABB</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/collision/CircleCollision$object.html b/doc/sims/collision/CircleCollision$object.html deleted file mode 100644 index c175c15..0000000 --- a/doc/sims/collision/CircleCollision$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 CircleCollision in sims.collision</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/collision$package.html" target="_self">sims.collision</a> - <br></br> - <span class="entity">object CircleCollision</span> - </div><hr></hr> - <div class="source"> - [source: <a href="" class="sims/collision/CircleCollision"><code>sims/collision/CircleCollision.scala</code></a>] - </div><hr></hr> - <a name="CircleCollision"></a><dl> - <dt> - - <code></code> - <code>object</code> - <em>CircleCollision</em> - </dt> - <dd><code> extends </code>(<a href="../../sims/dynamics/Circle.html" target="_self">Circle</a>, <a href="../../sims/dynamics/Circle.html" target="_self">Circle</a>) => <a href="../../sims/collision/CircleCollision.html" target="_self">CircleCollision</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/collision/CircleCollision.html b/doc/sims/collision/CircleCollision.html index e26027f..80e6b4d 100644 --- a/doc/sims/collision/CircleCollision.html +++ b/doc/sims/collision/CircleCollision.html @@ -1,409 +1,321 @@ -<!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 CircleCollision in sims.collision</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/collision$package.html" target="_self">sims.collision</a> - <br></br> - <span class="entity">class CircleCollision</span> - </div><hr></hr> - <div class="source"> - [source: <a href="" class="sims/collision/CircleCollision"><code>sims/collision/CircleCollision.scala</code></a>] - </div><hr></hr> - <a name="CircleCollision"></a><dl> - <dt> - - <code>case</code> - <code>class</code> - <em>CircleCollision</em>(<code>val </code><em>c1</em> : <a href="../../sims/dynamics/Circle.html" target="_self">Circle</a>, <code>val </code><em>c2</em> : <a href="../../sims/dynamics/Circle.html" target="_self">Circle</a>) - </dt> - <dd><code> extends </code><a href="../../sims/collision/Collision.html" target="_self">Collision</a><code> with </code><a href="" target="contentFrame" class="scala/Product">scala.Product</a></dd> - </dl> - <dl><dd>Collision between two circles.</dd></dl> - <dl></dl> + <head> + <title>Scaladoc for sims.collision.CircleCollision</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">collision</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/collision/CircleCollision.html#normal" target="_self">normal</a></em> - : <a href="../../sims/geometry/Vector2D.html" target="_self">Vector2D</a> - - <div>Normal vector to the collision face.</div> - </td> - </tr> -<tr> - <td class="modifiers" valign="top"> - <code> val</code> - </td> - <td class="signature"> - <em><a href="../../sims/collision/CircleCollision.html#points" target="_self">points</a></em> - : <a href="" target="contentFrame" class="scala/List">scala.List</a>[<a href="../../sims/geometry/Vector2D.html" target="_self">Vector2D</a>] - - <div>Collision points.</div> - </td> - </tr> -<tr> - <td class="modifiers" valign="top"> - <code> val</code> - </td> - <td class="signature"> - <em><a href="../../sims/collision/CircleCollision.html#shape1" target="_self">shape1</a></em> - : <a href="../../sims/dynamics/Circle.html" target="_self">Circle</a> - - <div>First colliding shape (reference shape).</div> - </td> - </tr> -<tr> - <td class="modifiers" valign="top"> - <code> val</code> - </td> - <td class="signature"> - <em><a href="../../sims/collision/CircleCollision.html#shape2" target="_self">shape2</a></em> - : <a href="../../sims/dynamics/Circle.html" target="_self">Circle</a> - - <div>Second colliding shape (incident shape).</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>override def</code> - </td> - <td class="signature"> - <em><a href="../../sims/collision/CircleCollision.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/collision/CircleCollision.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/collision/CircleCollision.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/collision/CircleCollision.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/collision/CircleCollision.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/collision/CircleCollision.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="../../sims/collision/Collision.html" target="_self">Collision</a> - </td></tr> - <tr><td class="signature" colspan="2"> - <a href="../../sims/collision/Collision.html#correctVelocity%28Double%29" target="_self">correctVelocity</a>, <a href="../../sims/collision/Collision.html#correctFriction%28sims.geometry.Vector2D%2CDouble%2CDouble%29" target="_self">correctFriction</a>, <a href="../../sims/collision/Collision.html#correctPosition%28Double%29" target="_self">correctPosition</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#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>CircleCollision</h1> + </div> + <h4 class="signature"> + <span class="kind">class</span> + <span class="symbol"> + <span class="name">CircleCollision</span><span class="params">(<span name="c1">c1: <a href="../dynamics/Circle.html" class="extype" name="sims.dynamics.Circle">Circle</a></span>, <span name="c2">c2: <a href="../dynamics/Circle.html" class="extype" name="sims.dynamics.Circle">Circle</a></span>)</span><span class="result"> extends <a href="Collision.html" class="extype" name="sims.collision.Collision">Collision</a> with <span class="extype" name="scala.Product">Product</span></span> + </span> + </h4> + <div class="fullcomment" id="comment"> + <div class="comment cmt"><p>Collision between two circles.</p></div> - -<table summary="" cellpadding="3" class="member-detail"> - <tr><td class="title">Value Details</td></tr> - </table><div><a name="shape1"></a><dl> - <dt> - - <code></code> - <code>val</code> - <em>shape1</em> : <a href="../../sims/dynamics/Circle.html" target="_self">Circle</a> - </dt> - <dd></dd> - </dl> - <dl><dd>First colliding shape (reference shape).</dd></dl> - <dl></dl> - <dl> - <dt style="margin:10px 0 0 20px;"> - <b>Overrides</b> - </dt> - <dd> - <a href="../../sims/collision/Collision.html" target="_self">Collision</a>.<a href="../../sims/collision/Collision.html#shape1" target="_self">shape1</a> - </dd> - </dl><hr></hr> -<a name="shape2"></a><dl> - <dt> - - <code></code> - <code>val</code> - <em>shape2</em> : <a href="../../sims/dynamics/Circle.html" target="_self">Circle</a> - </dt> - <dd></dd> - </dl> - <dl><dd>Second colliding shape (incident shape).</dd></dl> - <dl></dl> - <dl> - <dt style="margin:10px 0 0 20px;"> - <b>Overrides</b> - </dt> - <dd> - <a href="../../sims/collision/Collision.html" target="_self">Collision</a>.<a href="../../sims/collision/Collision.html#shape2" target="_self">shape2</a> - </dd> - </dl><hr></hr> -<a name="normal"></a><dl> - <dt> - - <code></code> - <code>val</code> - <em>normal</em> : <a href="../../sims/geometry/Vector2D.html" target="_self">Vector2D</a> - </dt> - <dd></dd> - </dl> - <dl><dd>Normal vector to the collision face.</dd></dl> - <dl></dl> - <dl> - <dt style="margin:10px 0 0 20px;"> - <b>Overrides</b> - </dt> - <dd> - <a href="../../sims/collision/Collision.html" target="_self">Collision</a>.<a href="../../sims/collision/Collision.html#normal" target="_self">normal</a> - </dd> - </dl><hr></hr> -<a name="points"></a><dl> - <dt> - - <code></code> - <code>val</code> - <em>points</em> : <a href="" target="contentFrame" class="scala/List">scala.List</a>[<a href="../../sims/geometry/Vector2D.html" target="_self">Vector2D</a>] - </dt> - <dd></dd> - </dl> - <dl><dd>Collision points.</dd></dl> - <dl></dl> - <dl> - <dt style="margin:10px 0 0 20px;"> - <b>Overrides</b> - </dt> - <dd> - <a href="../../sims/collision/Collision.html" target="_self">Collision</a>.<a href="../../sims/collision/Collision.html#points" target="_self">points</a> - </dd> - </dl><hr></hr></div> -<table summary="" cellpadding="3" class="member-detail"> - <tr><td class="title">Method Details</td></tr> - </table><div><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="sims.collision.Collision">Collision</li><li class="in" name="sims.dynamics.Constraint">Constraint</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.collision.CircleCollision#c1"> + <h4 class="signature"> + <span class="kind">val</span> + <span class="symbol"> + <span class="name">c1</span><span class="result">: <a href="../dynamics/Circle.html" class="extype" name="sims.dynamics.Circle">Circle</a></span> + </span> + </h4> + + </li><li name="sims.collision.CircleCollision#c2"> + <h4 class="signature"> + <span class="kind">val</span> + <span class="symbol"> + <span class="name">c2</span><span class="result">: <a href="../dynamics/Circle.html" class="extype" name="sims.dynamics.Circle">Circle</a></span> + </span> + </h4> + + </li><li name="sims.collision.CircleCollision#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.collision.Collision#correctFriction"> + <h4 class="signature"> + <span class="kind">def</span> + <span class="symbol"> + <span class="name">correctFriction</span><span class="params">(<span name="point">point: <a href="../geometry/Vector2D.html" class="extype" name="sims.geometry.Vector2D">Vector2D</a></span>, <span name="normalForce">normalForce: <span class="extype" name="scala.Double">Double</span></span>, <span name="h">h: <span class="extype" name="scala.Double">Double</span></span>)</span><span class="result">: <span class="extype" name="scala.Unit">Unit</span></span> + </span> + </h4> + + </li><li name="sims.collision.Collision#correctPosition"> + <h4 class="signature"> + <span class="kind">def</span> + <span class="symbol"> + <span class="name">correctPosition</span><span class="params">(<span name="h">h: <span class="extype" name="scala.Double">Double</span></span>)</span><span class="result">: <span class="extype" name="scala.Unit">Unit</span></span> + </span> + </h4> + <p class="shortcomment cmt">Corrects the positions of bodies according to this constraint</p><div class="fullcomment"> + <div class="comment cmt"><p>Corrects the positions of bodies according to this constraint.</p></div> + <dl class="paramcmts block"><dt class="param">h</dt><dd class="cmt"><p>a time interval, used for converting forces and impulses</p></dd></dl> + + <div class="block"> + definition classes: <a href="Collision.html">Collision</a> ⇐ <a href="../dynamics/Constraint.html">Constraint</a> + </div> + + </div> + </li><li name="sims.collision.Collision#correctVelocity"> + <h4 class="signature"> + <span class="kind">def</span> + <span class="symbol"> + <span class="name">correctVelocity</span><span class="params">(<span name="h">h: <span class="extype" name="scala.Double">Double</span></span>)</span><span class="result">: <span class="extype" name="scala.Unit">Unit</span></span> + </span> + </h4> + <p class="shortcomment cmt">Corrects the velocities of bodies according to this constraint</p><div class="fullcomment"> + <div class="comment cmt"><p>Corrects the velocities of bodies according to this constraint.</p></div> + <dl class="paramcmts block"><dt class="param">h</dt><dd class="cmt"><p>a time interval, used for converting forces and impulses</p></dd></dl> + + <div class="block"> + definition classes: <a href="Collision.html">Collision</a> ⇐ <a href="../dynamics/Constraint.html">Constraint</a> + </div> + + </div> + </li><li name="sims.collision.CircleCollision#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.collision.CircleCollision#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.collision.CircleCollision#normal"> + <h4 class="signature"> + <span class="kind">val</span> + <span class="symbol"> + <span class="name">normal</span><span class="result">: <a href="../geometry/Vector2D.html" class="extype" name="sims.geometry.Vector2D">Vector2D</a></span> + </span> + </h4> + <p class="shortcomment cmt">Normal vector to the collision face</p><div class="fullcomment"> + <div class="comment cmt"><p>Normal vector to the collision face.</p></div> + + + + + </div> + </li><li name="sims.collision.CircleCollision#points"> + <h4 class="signature"> + <span class="kind">val</span> + <span class="symbol"> + <span class="name">points</span><span class="result">: <span class="extype" name="scala.collection.immutable.List">List</span>[<a href="../geometry/Vector2D.html" class="extype" name="sims.geometry.Vector2D">Vector2D</a>]</span> + </span> + </h4> + <p class="shortcomment cmt">Collision points</p><div class="fullcomment"> + <div class="comment cmt"><p>Collision points.</p></div> + + + + + </div> + </li><li name="sims.collision.CircleCollision#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.collision.CircleCollision#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.collision.CircleCollision#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.collision.CircleCollision#shape1"> + <h4 class="signature"> + <span class="kind">val</span> + <span class="symbol"> + <span class="name">shape1</span><span class="result">: <a href="../dynamics/Circle.html" class="extype" name="sims.dynamics.Circle">Circle</a></span> + </span> + </h4> + <p class="shortcomment cmt">First colliding shape (reference shape)</p><div class="fullcomment"> + <div class="comment cmt"><p>First colliding shape (reference shape).</p></div> + + + + + </div> + </li><li name="sims.collision.CircleCollision#shape2"> + <h4 class="signature"> + <span class="kind">val</span> + <span class="symbol"> + <span class="name">shape2</span><span class="result">: <a href="../dynamics/Circle.html" class="extype" name="sims.dynamics.Circle">Circle</a></span> + </span> + </h4> + <p class="shortcomment cmt">Second colliding shape (incident shape)</p><div class="fullcomment"> + <div class="comment cmt"><p>Second colliding shape (incident shape).</p></div> + + + + + </div> + </li><li name="sims.collision.CircleCollision#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> - <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.collision.CircleCollision#this"> + <h4 class="signature"> + <span class="kind">new</span> + <span class="symbol"> + <span class="name">CircleCollision</span><span class="params">(<span name="c1">c1: <a href="../dynamics/Circle.html" class="extype" name="sims.dynamics.Circle">Circle</a></span>, <span name="c2">c2: <a href="../dynamics/Circle.html" class="extype" name="sims.dynamics.Circle">Circle</a></span>)</span> + </span> + </h4> + + </li><li name="sims.collision.Collision#this"> + <h4 class="signature"> + <span class="kind">new</span> + <span class="symbol"> + <span class="name">CircleCollision</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/collision/Collision$.html b/doc/sims/collision/Collision$.html new file mode 100644 index 0000000..a7c64d8 --- /dev/null +++ b/doc/sims/collision/Collision$.html @@ -0,0 +1,162 @@ +<?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.collision.Collision</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">collision</a></p> + + <div id="definition"> + <img src="../../lib/object_big.png" /> + <h1>Collision</h1> + </div> + + <h4 class="signature"> + <span class="kind">object</span> + <span class="symbol"> + <span class="name">Collision</span><span class="result"> extends AnyRef</span> + </span> + </h4> + <div class="fullcomment" id="comment"> + + + + + + </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.collision.Collision#ToleratedOverlap"> + <h4 class="signature"> + <span class="kind">val</span> + <span class="symbol"> + <span class="name">ToleratedOverlap</span><span class="result">: <span class="extype" name="scala.Double">Double</span></span> + </span> + </h4> + <p class="shortcomment cmt">Tolerated overlap</p><div class="fullcomment"> + <div class="comment cmt"><p>Tolerated overlap. Collision response will only be applied if the overlap of two shapes exceeds the tolerated overlap.</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="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/collision/Collision$object.html b/doc/sims/collision/Collision$object.html deleted file mode 100644 index 0d02762..0000000 --- a/doc/sims/collision/Collision$object.html +++ /dev/null @@ -1,101 +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 Collision in sims.collision</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/collision$package.html" target="_self">sims.collision</a> - <br></br> - <span class="entity">object Collision</span> - </div><hr></hr> - <div class="source"> - [source: <a href="" class="sims/collision/Collision"><code>sims/collision/Collision.scala</code></a>] - </div><hr></hr> - <a name="Collision"></a><dl> - <dt> - - <code></code> - <code>object</code> - <em>Collision</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> - - -<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/collision/Collision$object.html#ToleratedOverlap" target="_self">ToleratedOverlap</a></em> - : <a href="http://www.scala-lang.org/docu/files/api/scala/Double.html" target="_self">Double</a> - - <div>Tolerated overlap. Collision response will only be applied if the overlap of two shapes exceeds the tolerated overlap.</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="ToleratedOverlap"></a><dl> - <dt> - - <code></code> - <code>val</code> - <em>ToleratedOverlap</em> : <a href="http://www.scala-lang.org/docu/files/api/scala/Double.html" target="_self">Double</a> - </dt> - <dd></dd> - </dl> - <dl><dd>Tolerated overlap. Collision response will only be applied if the overlap of two shapes exceeds the tolerated overlap.</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/collision/Collision.html b/doc/sims/collision/Collision.html index 028dc09..c74223c 100644 --- a/doc/sims/collision/Collision.html +++ b/doc/sims/collision/Collision.html @@ -1,261 +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 Collision in sims.collision</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.collision.Collision</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/collision$package.html" target="_self">sims.collision</a> - <br></br> - <span class="entity">class Collision</span> - </div><hr></hr> - <div class="source"> - [source: <a href="" class="sims/collision/Collision"><code>sims/collision/Collision.scala</code></a>] - </div><hr></hr> - <a name="Collision"></a><dl> - <dt> - - <code>abstract</code> - <code>class</code> - <em>Collision</em> - </dt> - <dd><code> extends </code><a href="../../sims/dynamics/Constraint.html" target="_self">Constraint</a><code> with </code><a href="http://www.scala-lang.org/docu/files/api/scala/AnyRef.html" target="_self">AnyRef</a></dd> - </dl> - <dl><dd>Collision between two shapes. Contains methods to compute the collision response.</dd></dl> - <dl></dl> - <dl> - <dt style="margin:10px 0 0 20px;"><b>Direct Known Subclasses:</b></dt> - <dd><a href="../../sims/collision/CircleCollision.html" target="_self">CircleCollision</a>, <a href="../../sims/collision/PolyCircleCollision.html" target="_self">PolyCircleCollision</a>, <a href="../../sims/collision/PolyCollision.html" target="_self">PolyCollision</a></dd> - </dl><hr></hr> + <body class="type"> + <p id="owner"><a href="../package.html">sims</a>.<a href="package.html">collision</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>abstract val</code> - </td> - <td class="signature"> - <em><a href="../../sims/collision/Collision.html#normal" target="_self">normal</a></em> - : <a href="../../sims/geometry/Vector2D.html" target="_self">Vector2D</a> - - <div>Normal vector to the collision face.</div> - </td> - </tr> -<tr> - <td class="modifiers" valign="top"> - <code>abstract val</code> - </td> - <td class="signature"> - <em><a href="../../sims/collision/Collision.html#points" target="_self">points</a></em> - : <a href="" target="contentFrame" class="scala/Iterable">scala.Iterable</a>[<a href="../../sims/geometry/Vector2D.html" target="_self">Vector2D</a>] - - <div>Collision points.</div> - </td> - </tr> -<tr> - <td class="modifiers" valign="top"> - <code>abstract val</code> - </td> - <td class="signature"> - <em><a href="../../sims/collision/Collision.html#shape1" target="_self">shape1</a></em> - : <a href="../../sims/dynamics/Shape.html" target="_self">Shape</a> - - <div>First colliding shape (reference shape).</div> - </td> - </tr> -<tr> - <td class="modifiers" valign="top"> - <code>abstract val</code> - </td> - <td class="signature"> - <em><a href="../../sims/collision/Collision.html#shape2" target="_self">shape2</a></em> - : <a href="../../sims/dynamics/Shape.html" target="_self">Shape</a> - - <div>Second colliding shape (incident shape).</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/collision/Collision.html#correctFriction%28sims.geometry.Vector2D%2CDouble%2CDouble%29" target="_self">correctFriction</a></em> - (<em>point</em> : <a href="../../sims/geometry/Vector2D.html" target="_self">Vector2D</a>, <em>normalForce</em> : <a href="http://www.scala-lang.org/docu/files/api/scala/Double.html" target="_self">Double</a>, <em>h</em> : <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/Unit.html" target="_self">Unit</a> - - - </td> - </tr> -<tr> - <td class="modifiers" valign="top"> - <code> def</code> - </td> - <td class="signature"> - <em><a href="../../sims/collision/Collision.html#correctPosition%28Double%29" target="_self">correctPosition</a></em> - (<em>h</em> : <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/Unit.html" target="_self">Unit</a> - - <div>Corrects the positions of bodies according to this constraint.</div> - </td> - </tr> -<tr> - <td class="modifiers" valign="top"> - <code> def</code> - </td> - <td class="signature"> - <em><a href="../../sims/collision/Collision.html#correctVelocity%28Double%29" target="_self">correctVelocity</a></em> - (<em>h</em> : <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/Unit.html" target="_self">Unit</a> - - <div>Corrects the velocities of bodies according to this constraint.</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 id="definition"> + <img src="../../lib/class_big.png" /> + <h1>Collision</h1> + </div> + <h4 class="signature"> + <span class="kind">class</span> + <span class="symbol"> + <span class="name">Collision</span><span class="result"> extends <a href="../dynamics/Constraint.html" class="extype" name="sims.dynamics.Constraint">Constraint</a></span> + </span> + </h4> + <div class="fullcomment" id="comment"> + <div class="comment cmt"><p>Collision between two shapes. Contains methods to compute the collision response.</p></div> - -<table summary="" cellpadding="3" class="member-detail"> - <tr><td class="title">Value Details</td></tr> - </table><div><a name="shape1"></a><dl> - <dt> - - <code>abstract</code> - <code>val</code> - <em>shape1</em> : <a href="../../sims/dynamics/Shape.html" target="_self">Shape</a> - </dt> - <dd></dd> - </dl> - <dl><dd>First colliding shape (reference shape).</dd></dl> - <dl></dl> - <hr></hr> -<a name="shape2"></a><dl> - <dt> - - <code>abstract</code> - <code>val</code> - <em>shape2</em> : <a href="../../sims/dynamics/Shape.html" target="_self">Shape</a> - </dt> - <dd></dd> - </dl> - <dl><dd>Second colliding shape (incident shape).</dd></dl> - <dl></dl> - <hr></hr> -<a name="points"></a><dl> - <dt> + <div class="block"> + attributes: abstract + </div> + + <div class="block"> + known subclasses: <a href="PolyCollision.html">PolyCollision</a>, <a href="PolyCircleCollision.html">PolyCircleCollision</a>, <a href="CircleCollision.html">CircleCollision</a> + </div> + </div> + + <div id="template"> + + <div id="mbrsel"> + <div id="ancestors"> + <h3>Inherits</h3> + <ol><li class="in" name="sims.dynamics.Constraint">Constraint</li><li class="in" name="scala.AnyRef">AnyRef</li><li class="in" name="scala.Any">Any</li></ol> + </div> + </div> - <code>abstract</code> - <code>val</code> - <em>points</em> : <a href="" target="contentFrame" class="scala/Iterable">scala.Iterable</a>[<a href="../../sims/geometry/Vector2D.html" target="_self">Vector2D</a>] - </dt> - <dd></dd> - </dl> - <dl><dd>Collision points.</dd></dl> - <dl></dl> - <hr></hr> -<a name="normal"></a><dl> - <dt> - <code>abstract</code> - <code>val</code> - <em>normal</em> : <a href="../../sims/geometry/Vector2D.html" target="_self">Vector2D</a> - </dt> - <dd></dd> - </dl> - <dl><dd>Normal vector to the collision face.</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="correctVelocity%28Double%29"></a><dl> - <dt> - <code></code> - <code>def</code> - <em>correctVelocity</em>(<em>h</em> : <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/Unit.html" target="_self">Unit</a> - </dt> - <dd></dd> - </dl> - <dl><dd>Corrects the velocities of bodies according to this constraint.</dd></dl> - <dl><dt style="margin:10px 0 0 20px;"> - <b>Parameters</b></dt><dd><code>h - </code>a time interval, used for converting forces and impulses</dd></dl> - <dl> - <dt style="margin:10px 0 0 20px;"> - <b>Overrides</b> - </dt> - <dd> - <a href="../../sims/dynamics/Constraint.html" target="_self">Constraint</a>.<a href="../../sims/dynamics/Constraint.html#correctVelocity%28Double%29" target="_self">correctVelocity</a> - </dd> - </dl><hr></hr> -<a name="correctFriction%28sims.geometry.Vector2D%2CDouble%2CDouble%29"></a><dl> - <dt> + <div class="members" id="values"> + <h3>Value Members</h3> + <ol><li name="sims.collision.Collision#correctFriction"> + <h4 class="signature"> + <span class="kind">def</span> + <span class="symbol"> + <span class="name">correctFriction</span><span class="params">(<span name="point">point: <a href="../geometry/Vector2D.html" class="extype" name="sims.geometry.Vector2D">Vector2D</a></span>, <span name="normalForce">normalForce: <span class="extype" name="scala.Double">Double</span></span>, <span name="h">h: <span class="extype" name="scala.Double">Double</span></span>)</span><span class="result">: <span class="extype" name="scala.Unit">Unit</span></span> + </span> + </h4> + + </li><li name="sims.collision.Collision#correctPosition"> + <h4 class="signature"> + <span class="kind">def</span> + <span class="symbol"> + <span class="name">correctPosition</span><span class="params">(<span name="h">h: <span class="extype" name="scala.Double">Double</span></span>)</span><span class="result">: <span class="extype" name="scala.Unit">Unit</span></span> + </span> + </h4> + <p class="shortcomment cmt">Corrects the positions of bodies according to this constraint</p><div class="fullcomment"> + <div class="comment cmt"><p>Corrects the positions of bodies according to this constraint.</p></div> + <dl class="paramcmts block"><dt class="param">h</dt><dd class="cmt"><p>a time interval, used for converting forces and impulses</p></dd></dl> + + + + </div> + </li><li name="sims.collision.Collision#correctVelocity"> + <h4 class="signature"> + <span class="kind">def</span> + <span class="symbol"> + <span class="name">correctVelocity</span><span class="params">(<span name="h">h: <span class="extype" name="scala.Double">Double</span></span>)</span><span class="result">: <span class="extype" name="scala.Unit">Unit</span></span> + </span> + </h4> + <p class="shortcomment cmt">Corrects the velocities of bodies according to this constraint</p><div class="fullcomment"> + <div class="comment cmt"><p>Corrects the velocities of bodies according to this constraint.</p></div> + <dl class="paramcmts block"><dt class="param">h</dt><dd class="cmt"><p>a time interval, used for converting forces and impulses</p></dd></dl> + + + + </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.collision.Collision#normal"> + <h4 class="signature"> + <span class="kind">val</span> + <span class="symbol"> + <span class="name">normal</span><span class="result">: <a href="../geometry/Vector2D.html" class="extype" name="sims.geometry.Vector2D">Vector2D</a></span> + </span> + </h4> + <p class="shortcomment cmt">Normal vector to the collision face</p><div class="fullcomment"> + <div class="comment cmt"><p>Normal vector to the collision face.</p></div> + + <div class="block"> + attributes: abstract + </div> + + + </div> + </li><li name="sims.collision.Collision#points"> + <h4 class="signature"> + <span class="kind">val</span> + <span class="symbol"> + <span class="name">points</span><span class="result">: <span class="extype" name="scala.collection.Iterable">Iterable</span>[<a href="../geometry/Vector2D.html" class="extype" name="sims.geometry.Vector2D">Vector2D</a>]</span> + </span> + </h4> + <p class="shortcomment cmt">Collision points</p><div class="fullcomment"> + <div class="comment cmt"><p>Collision points.</p></div> + + <div class="block"> + attributes: abstract + </div> + + + </div> + </li><li name="sims.collision.Collision#shape1"> + <h4 class="signature"> + <span class="kind">val</span> + <span class="symbol"> + <span class="name">shape1</span><span class="result">: <a href="../dynamics/Shape.html" class="extype" name="sims.dynamics.Shape">Shape</a></span> + </span> + </h4> + <p class="shortcomment cmt">First colliding shape (reference shape)</p><div class="fullcomment"> + <div class="comment cmt"><p>First colliding shape (reference shape).</p></div> + + <div class="block"> + attributes: abstract + </div> + + + </div> + </li><li name="sims.collision.Collision#shape2"> + <h4 class="signature"> + <span class="kind">val</span> + <span class="symbol"> + <span class="name">shape2</span><span class="result">: <a href="../dynamics/Shape.html" class="extype" name="sims.dynamics.Shape">Shape</a></span> + </span> + </h4> + <p class="shortcomment cmt">Second colliding shape (incident shape)</p><div class="fullcomment"> + <div class="comment cmt"><p>Second colliding shape (incident shape).</p></div> + + <div class="block"> + attributes: abstract + </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> - <code></code> - <code>def</code> - <em>correctFriction</em>(<em>point</em> : <a href="../../sims/geometry/Vector2D.html" target="_self">Vector2D</a>, <em>normalForce</em> : <a href="http://www.scala-lang.org/docu/files/api/scala/Double.html" target="_self">Double</a>, <em>h</em> : <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/Unit.html" target="_self">Unit</a> - </dt> - <dd></dd> - </dl><hr></hr> -<a name="correctPosition%28Double%29"></a><dl> - <dt> + <div class="members" id="constructors"> + <h3>Instance constructors</h3> + <ol><li name="sims.collision.Collision#this"> + <h4 class="signature"> + <span class="kind">new</span> + <span class="symbol"> + <span class="name">Collision</span><span class="params">()</span> + </span> + </h4> + + </li></ol> + </div> - <code></code> - <code>def</code> - <em>correctPosition</em>(<em>h</em> : <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/Unit.html" target="_self">Unit</a> - </dt> - <dd></dd> - </dl> - <dl><dd>Corrects the positions of bodies according to this constraint.</dd></dl> - <dl><dt style="margin:10px 0 0 20px;"> - <b>Parameters</b></dt><dd><code>h - </code>a time interval, used for converting forces and impulses</dd></dl> - <dl> - <dt style="margin:10px 0 0 20px;"> - <b>Overrides</b> - </dt> - <dd> - <a href="../../sims/dynamics/Constraint.html" target="_self">Constraint</a>.<a href="../../sims/dynamics/Constraint.html#correctPosition%28Double%29" target="_self">correctPosition</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/collision/Detector.html b/doc/sims/collision/Detector.html index ad93c73..c858df8 100644 --- a/doc/sims/collision/Detector.html +++ b/doc/sims/collision/Detector.html @@ -1,133 +1,195 @@ -<!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 Detector in sims.collision</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.collision.Detector</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/collision$package.html" target="_self">sims.collision</a> - <br></br> - <span class="entity">class Detector</span> - </div><hr></hr> - <div class="source"> - [source: <a href="" class="sims/collision/Detector"><code>sims/collision/Detector.scala</code></a>] - </div><hr></hr> - <a name="Detector"></a><dl> - <dt> - - <code>abstract</code> - <code>class</code> - <em>Detector</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>A world detects its collisions through concrete implementations of this class.</dd></dl> - <dl></dl> - <dl> - <dt style="margin:10px 0 0 20px;"><b>Direct Known Subclasses:</b></dt> - <dd><a href="../../sims/collision/GridDetector.html" target="_self">GridDetector</a></dd> - </dl><hr></hr> + <body class="type"> + <p id="owner"><a href="../package.html">sims</a>.<a href="package.html">collision</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>abstract val</code> - </td> - <td class="signature"> - <em><a href="../../sims/collision/Detector.html#world" target="_self">world</a></em> - : <a href="../../sims/dynamics/World.html" target="_self">World</a> + <div id="definition"> + <img src="../../lib/class_big.png" /> + <h1>Detector</h1> + </div> + + <h4 class="signature"> + <span class="kind">class</span> + <span class="symbol"> + <span class="name">Detector</span><span class="result"> extends AnyRef</span> + </span> + </h4> + <div class="fullcomment" id="comment"> + <div class="comment cmt"><p>A world detects its collisions through concrete implementations of this class.</p></div> + + <div class="block"> + attributes: abstract + </div> + + <div class="block"> + known subclasses: <a href="GridDetector.html">GridDetector</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>The world whose shapes are to be checked for collisions.</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>abstract def</code> - </td> - <td class="signature"> - <em><a href="../../sims/collision/Detector.html#collisions" target="_self">collisions</a></em> - : <a href="" target="contentFrame" class="scala/Seq">scala.Seq</a>[<a href="../../sims/collision/Collision.html" target="_self">Collision</a>] - <div>Returns all collisions between shapes in the world <code>world</code>.</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.collision.Detector#collisions"> + <h4 class="signature"> + <span class="kind">def</span> + <span class="symbol"> + <span class="name">collisions</span><span class="result">: <span class="extype" name="scala.collection.Seq">Seq</span>[<a href="Collision.html" class="extype" name="sims.collision.Collision">Collision</a>]</span> + </span> + </h4> + <p class="shortcomment cmt">Returns all collisions between shapes in the world <code>world</code></p><div class="fullcomment"> + <div class="comment cmt"><p>Returns all collisions between shapes in the world <code>world</code>.</p></div> - -<table summary="" cellpadding="3" class="member-detail"> - <tr><td class="title">Value Details</td></tr> - </table><div><a name="world"></a><dl> - <dt> + <div class="block"> + attributes: abstract + </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="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.collision.Detector#world"> + <h4 class="signature"> + <span class="kind">val</span> + <span class="symbol"> + <span class="name">world</span><span class="result">: <a href="../dynamics/World.html" class="extype" name="sims.dynamics.World">World</a></span> + </span> + </h4> + <p class="shortcomment cmt">The world whose shapes are to be checked for collisions</p><div class="fullcomment"> + <div class="comment cmt"><p>The world whose shapes are to be checked for collisions.</p></div> + + <div class="block"> + attributes: abstract + </div> + + + </div> + </li></ol> + </div> - <code>abstract</code> - <code>val</code> - <em>world</em> : <a href="../../sims/dynamics/World.html" target="_self">World</a> - </dt> - <dd></dd> - </dl> - <dl><dd>The world whose shapes are to be checked for collisions.</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="collisions"></a><dl> - <dt> + <div class="members" id="constructors"> + <h3>Instance constructors</h3> + <ol><li name="sims.collision.Detector#this"> + <h4 class="signature"> + <span class="kind">new</span> + <span class="symbol"> + <span class="name">Detector</span><span class="params">()</span> + </span> + </h4> + + </li></ol> + </div> - <code>abstract</code> - <code>def</code> - <em>collisions</em> : <a href="" target="contentFrame" class="scala/Seq">scala.Seq</a>[<a href="../../sims/collision/Collision.html" target="_self">Collision</a>] - </dt> - <dd></dd> - </dl> - <dl><dd>Returns all collisions between shapes in the world <code>world</code>.</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/collision/GridDetector.html b/doc/sims/collision/GridDetector.html index 9007d31..6cdaad7 100644 --- a/doc/sims/collision/GridDetector.html +++ b/doc/sims/collision/GridDetector.html @@ -1,311 +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 GridDetector in sims.collision</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/collision$package.html" target="_self">sims.collision</a> - <br></br> - <span class="entity">class GridDetector</span> - </div><hr></hr> - <div class="source"> - [source: <a href="" class="sims/collision/GridDetector"><code>sims/collision/GridDetector.scala</code></a>] - </div><hr></hr> - <a name="GridDetector"></a><dl> - <dt> - - <code></code> - <code>class</code> - <em>GridDetector</em>(<code>val override </code><em>world</em> : <a href="../../sims/dynamics/World.html" target="_self">World</a>) - </dt> - <dd><code> extends </code><a href="../../sims/collision/Detector.html" target="_self">Detector</a></dd> - </dl> - <dl><dd>A conrete implementation of <code>Detector</code>. <code>GridDetector</code> divides the world into a grid
- for faster collision detection.</dd></dl> - <dl></dl> + <head> + <title>Scaladoc for sims.collision.GridDetector</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">collision</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/collision/GridDetector.html#collisionMethods" target="_self">collisionMethods</a></em> - : <a href="" target="contentFrame" class="scala/collection/mutable/ArrayBuffer">scala.collection.mutable.ArrayBuffer</a>[<a href="" target="contentFrame" class="scala/PartialFunction">scala.PartialFunction</a>[(<a href="../../sims/dynamics/Shape.html" target="_self">Shape</a>, <a href="../../sims/dynamics/Shape.html" target="_self">Shape</a>), <a href="../../sims/collision/Collision.html" target="_self">Collision</a>]] - - <div>Array of methods returning collisions. It is assumed that both shapes are colliding.</div> - </td> - </tr> -<tr> - <td class="modifiers" valign="top"> - <code> val</code> - </td> - <td class="signature"> - <em><a href="../../sims/collision/GridDetector.html#detectionMethods" target="_self">detectionMethods</a></em> - : <a href="" target="contentFrame" class="scala/collection/mutable/ArrayBuffer">scala.collection.mutable.ArrayBuffer</a>[<a href="" target="contentFrame" class="scala/PartialFunction">scala.PartialFunction</a>[(<a href="../../sims/dynamics/Shape.html" target="_self">Shape</a>, <a href="../../sims/dynamics/Shape.html" target="_self">Shape</a>), <a href="http://www.scala-lang.org/docu/files/api/scala/Boolean.html" target="_self">Boolean</a>]] - - <div>Array of collision detection methods. These methods return <code>true</code> if two shapes are colliding.</div> - </td> - </tr> -<tr> - <td class="modifiers" valign="top"> - <code> var</code> - </td> - <td class="signature"> - <em><a href="../../sims/collision/GridDetector.html#gridSide" target="_self">gridSide</a></em> - : <a href="http://www.scala-lang.org/docu/files/api/scala/Double.html" target="_self">Double</a> - - <div>Width and height of a grid cell.</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/collision/GridDetector.html#colliding%28sims.collision.Pair%29" target="_self">colliding</a></em> - (<em>p</em> : <a href="../../sims/collision/Pair.html" target="_self">Pair</a>) : <a href="http://www.scala-lang.org/docu/files/api/scala/Boolean.html" target="_self">Boolean</a> - - <div>Checks the pair of shapes <code>p</code> for collision.</div> - </td> - </tr> -<tr> - <td class="modifiers" valign="top"> - <code> def</code> - </td> - <td class="signature"> - <em><a href="../../sims/collision/GridDetector.html#collidingPairs" target="_self">collidingPairs</a></em> - : <a href="" target="contentFrame" class="scala/Seq">scala.Seq</a>[<a href="../../sims/collision/Pair.html" target="_self">Pair</a>] - - <div>Returns all colliding pairs.</div> - </td> - </tr> -<tr> - <td class="modifiers" valign="top"> - <code> def</code> - </td> - <td class="signature"> - <em><a href="../../sims/collision/GridDetector.html#collision%28sims.collision.Pair%29" target="_self">collision</a></em> - (<em>p</em> : <a href="../../sims/collision/Pair.html" target="_self">Pair</a>) : <a href="../../sims/collision/Collision.html" target="_self">Collision</a> - - <div>Returns the collision between both shapes of the pair <code>p</code>.</div> - </td> - </tr> -<tr> - <td class="modifiers" valign="top"> - <code> def</code> - </td> - <td class="signature"> - <em><a href="../../sims/collision/GridDetector.html#collisions" target="_self">collisions</a></em> - : <a href="" target="contentFrame" class="scala/Seq">scala.Seq</a>[<a href="../../sims/collision/Collision.html" target="_self">Collision</a>] - - <div>Returns all collisions.</div> - </td> - </tr> -<tr> - <td class="modifiers" valign="top"> - <code> def</code> - </td> - <td class="signature"> - <em><a href="../../sims/collision/GridDetector.html#getPairs" target="_self">getPairs</a></em> - : <a href="" target="contentFrame" class="scala/Seq">scala.Seq</a>[<a href="../../sims/collision/Pair.html" target="_self">Pair</a>] - - <div>Returns potential colliding pairs of shapes of the world <code>world</code>.</div> - </td> - </tr> -<tr> - <td class="modifiers" valign="top"> - <code> def</code> - </td> - <td class="signature"> - <em><a href="../../sims/collision/GridDetector.html#pairs" target="_self">pairs</a></em> - : <a href="" target="contentFrame" class="scala/Seq">scala.Seq</a>[<a href="../../sims/collision/Pair.html" target="_self">Pair</a>] - - <div>All potential colliding pairs of the world.</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 id="definition"> + <img src="../../lib/class_big.png" /> + <h1>GridDetector</h1> + </div> + <h4 class="signature"> + <span class="kind">class</span> + <span class="symbol"> + <span class="name">GridDetector</span><span class="result"> extends <a href="Detector.html" class="extype" name="sims.collision.Detector">Detector</a></span> + </span> + </h4> + <div class="fullcomment" id="comment"> + <div class="comment cmt"><p>A conrete implementation of <code>Detector</code>. <code>GridDetector</code> divides the world into a grid +for faster collision detection.</p></div> - -<table summary="" cellpadding="3" class="member-detail"> - <tr><td class="title">Value Details</td></tr> - </table><div><a name="detectionMethods"></a><dl> - <dt> - - <code></code> - <code>val</code> - <em>detectionMethods</em> : <a href="" target="contentFrame" class="scala/collection/mutable/ArrayBuffer">scala.collection.mutable.ArrayBuffer</a>[<a href="" target="contentFrame" class="scala/PartialFunction">scala.PartialFunction</a>[(<a href="../../sims/dynamics/Shape.html" target="_self">Shape</a>, <a href="../../sims/dynamics/Shape.html" target="_self">Shape</a>), <a href="http://www.scala-lang.org/docu/files/api/scala/Boolean.html" target="_self">Boolean</a>]] - </dt> - <dd></dd> - </dl> - <dl><dd>Array of collision detection methods. These methods return <code>true</code> if two shapes are colliding.</dd></dl> - <dl></dl> - <hr></hr> -<a name="collisionMethods"></a><dl> - <dt> - - <code></code> - <code>val</code> - <em>collisionMethods</em> : <a href="" target="contentFrame" class="scala/collection/mutable/ArrayBuffer">scala.collection.mutable.ArrayBuffer</a>[<a href="" target="contentFrame" class="scala/PartialFunction">scala.PartialFunction</a>[(<a href="../../sims/dynamics/Shape.html" target="_self">Shape</a>, <a href="../../sims/dynamics/Shape.html" target="_self">Shape</a>), <a href="../../sims/collision/Collision.html" target="_self">Collision</a>]] - </dt> - <dd></dd> - </dl> - <dl><dd>Array of methods returning collisions. It is assumed that both shapes are colliding.</dd></dl> - <dl></dl> - <hr></hr> -<a name="gridSide"></a><dl> - <dt> - - <code></code> - <code>var</code> - <em>gridSide</em> : <a href="http://www.scala-lang.org/docu/files/api/scala/Double.html" target="_self">Double</a> - </dt> - <dd></dd> - </dl> - <dl><dd>Width and height of a grid cell.</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="colliding%28sims.collision.Pair%29"></a><dl> - <dt> - - <code></code> - <code>def</code> - <em>colliding</em>(<em>p</em> : <a href="../../sims/collision/Pair.html" target="_self">Pair</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 the pair of shapes <code>p</code> for collision.</dd></dl> - <dl><dt style="margin:10px 0 0 20px;"> - <b>Parameters</b></dt><dd><code>p - </code>Pair of shapes.</dd></dl> - <hr></hr> -<a name="collision%28sims.collision.Pair%29"></a><dl> - <dt> + + + + </div> + + <div id="template"> + + <div id="mbrsel"> + <div id="ancestors"> + <h3>Inherits</h3> + <ol><li class="in" name="sims.collision.Detector">Detector</li><li class="in" name="scala.AnyRef">AnyRef</li><li class="in" name="scala.Any">Any</li></ol> + </div> + </div> - <code></code> - <code>def</code> - <em>collision</em>(<em>p</em> : <a href="../../sims/collision/Pair.html" target="_self">Pair</a>) : <a href="../../sims/collision/Collision.html" target="_self">Collision</a> - </dt> - <dd></dd> - </dl> - <dl><dd>Returns the collision between both shapes of the pair <code>p</code>.</dd></dl> - <dl><dt style="margin:10px 0 0 20px;"> - <b>Parameters</b></dt><dd><code>p - </code>Pair of shapes.</dd></dl> - <hr></hr> -<a name="getPairs"></a><dl> - <dt> - <code></code> - <code>def</code> - <em>getPairs</em> : <a href="" target="contentFrame" class="scala/Seq">scala.Seq</a>[<a href="../../sims/collision/Pair.html" target="_self">Pair</a>] - </dt> - <dd></dd> - </dl> - <dl><dd>Returns potential colliding pairs of shapes of the world <code>world</code>.
- <p>
- A potential colliding pair is a pair of two shapes that comply with the following criteria:
- <ul>
- <li>The shapes are situated in the same grid cell.</li>
- <li>Their AABBs overlap.</li>
- <li>The shapes do not belong to the same body.</li>
- <li>At least one shape is not fixed.</li>
- <li>Both shapes are {@link dynamics.Shape#collidable}.</li>
- </ul></dd></dl> - <dl></dl> - <hr></hr> -<a name="pairs"></a><dl> - <dt> - <code></code> - <code>def</code> - <em>pairs</em> : <a href="" target="contentFrame" class="scala/Seq">scala.Seq</a>[<a href="../../sims/collision/Pair.html" target="_self">Pair</a>] - </dt> - <dd></dd> - </dl> - <dl><dd>All potential colliding pairs of the world.</dd></dl> - <dl><dt style="margin:10px 0 0 20px;"> - <b>See Also</b></dt><dd>getPairs</dd></dl> - <hr></hr> -<a name="collidingPairs"></a><dl> - <dt> + <div class="members" id="values"> + <h3>Value Members</h3> + <ol><li name="sims.collision.GridDetector#colliding"> + <h4 class="signature"> + <span class="kind">def</span> + <span class="symbol"> + <span class="name">colliding</span><span class="params">(<span name="p">p: <a href="Pair.html" class="extype" name="sims.collision.Pair">Pair</a></span>)</span><span class="result">: <span class="extype" name="scala.Boolean">Boolean</span></span> + </span> + </h4> + <p class="shortcomment cmt">Checks the pair of shapes <code>p</code> for collision</p><div class="fullcomment"> + <div class="comment cmt"><p>Checks the pair of shapes <code>p</code> for collision.</p></div> + <dl class="paramcmts block"><dt class="param">p</dt><dd class="cmt"><p>Pair of shapes.</p></dd></dl> + + + + </div> + </li><li name="sims.collision.GridDetector#collidingPairs"> + <h4 class="signature"> + <span class="kind">def</span> + <span class="symbol"> + <span class="name">collidingPairs</span><span class="result">: <span class="extype" name="scala.collection.Seq">Seq</span>[<a href="Pair.html" class="extype" name="sims.collision.Pair">Pair</a>]</span> + </span> + </h4> + <p class="shortcomment cmt">Returns all colliding pairs</p><div class="fullcomment"> + <div class="comment cmt"><p>Returns all colliding pairs.</p></div> + + + + + </div> + </li><li name="sims.collision.GridDetector#collision"> + <h4 class="signature"> + <span class="kind">def</span> + <span class="symbol"> + <span class="name">collision</span><span class="params">(<span name="p">p: <a href="Pair.html" class="extype" name="sims.collision.Pair">Pair</a></span>)</span><span class="result">: <a href="Collision.html" class="extype" name="sims.collision.Collision">Collision</a></span> + </span> + </h4> + <p class="shortcomment cmt">Returns the collision between both shapes of the pair <code>p</code></p><div class="fullcomment"> + <div class="comment cmt"><p>Returns the collision between both shapes of the pair <code>p</code>.</p></div> + <dl class="paramcmts block"><dt class="param">p</dt><dd class="cmt"><p>Pair of shapes.</p></dd></dl> + + + + </div> + </li><li name="sims.collision.GridDetector#collisionMethods"> + <h4 class="signature"> + <span class="kind">val</span> + <span class="symbol"> + <span class="name">collisionMethods</span><span class="result">: <span class="extype" name="scala.collection.mutable.ArrayBuffer">ArrayBuffer</span>[<span class="extype" name="scala.PartialFunction">PartialFunction</span>[(<a href="../dynamics/Shape.html" class="extype" name="sims.dynamics.Shape">Shape</a>, <a href="../dynamics/Shape.html" class="extype" name="sims.dynamics.Shape">Shape</a>), <a href="Collision.html" class="extype" name="sims.collision.Collision">Collision</a>]]</span> + </span> + </h4> + <p class="shortcomment cmt">Array of methods returning collisions</p><div class="fullcomment"> + <div class="comment cmt"><p>Array of methods returning collisions. It is assumed that both shapes are colliding.</p></div> + + + + + </div> + </li><li name="sims.collision.GridDetector#collisions"> + <h4 class="signature"> + <span class="kind">def</span> + <span class="symbol"> + <span class="name">collisions</span><span class="result">: <span class="extype" name="scala.collection.Seq">Seq</span>[<a href="Collision.html" class="extype" name="sims.collision.Collision">Collision</a>]</span> + </span> + </h4> + <p class="shortcomment cmt">Returns all collisions</p><div class="fullcomment"> + <div class="comment cmt"><p>Returns all collisions.</p></div> + + + + + </div> + </li><li name="sims.collision.GridDetector#detectionMethods"> + <h4 class="signature"> + <span class="kind">val</span> + <span class="symbol"> + <span class="name">detectionMethods</span><span class="result">: <span class="extype" name="scala.collection.mutable.ArrayBuffer">ArrayBuffer</span>[<span class="extype" name="scala.PartialFunction">PartialFunction</span>[(<a href="../dynamics/Shape.html" class="extype" name="sims.dynamics.Shape">Shape</a>, <a href="../dynamics/Shape.html" class="extype" name="sims.dynamics.Shape">Shape</a>), <span class="extype" name="scala.Boolean">Boolean</span>]]</span> + </span> + </h4> + <p class="shortcomment cmt">Array of collision detection methods</p><div class="fullcomment"> + <div class="comment cmt"><p>Array of collision detection methods. These methods return <code>true</code> if two shapes are colliding.</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="sims.collision.GridDetector#getPairs"> + <h4 class="signature"> + <span class="kind">def</span> + <span class="symbol"> + <span class="name">getPairs</span><span class="result">: <span class="extype" name="scala.collection.Seq">Seq</span>[<a href="Pair.html" class="extype" name="sims.collision.Pair">Pair</a>]</span> + </span> + </h4> + <p class="shortcomment cmt">Returns potential colliding pairs of shapes of the world <code>world</code></p><div class="fullcomment"> + <div class="comment cmt"><p>Returns potential colliding pairs of shapes of the world <code>world</code>. +<p> +A potential colliding pair is a pair of two shapes that comply with the following criteria: +<ul> +<li>The shapes are situated in the same grid cell.</li> +<li>Their AABBs overlap.</li> +<li>The shapes do not belong to the same body.</li> +<li>At least one shape is not fixed.</li> +<li>Both shapes are {@link dynamics.Shape#collidable}.</li> +</ul></p></div> + + + + + </div> + </li><li name="sims.collision.GridDetector#gridSide"> + <h4 class="signature"> + <span class="kind">var</span> + <span class="symbol"> + <span class="name">gridSide</span><span class="result">: <span class="extype" name="scala.Double">Double</span></span> + </span> + </h4> + <p class="shortcomment cmt">Width and height of a grid cell</p><div class="fullcomment"> + <div class="comment cmt"><p>Width and height of a grid cell.</p></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.collision.GridDetector#pairs"> + <h4 class="signature"> + <span class="kind">def</span> + <span class="symbol"> + <span class="name">pairs</span><span class="result">: <span class="extype" name="scala.collection.Seq">Seq</span>[<a href="Pair.html" class="extype" name="sims.collision.Pair">Pair</a>]</span> + </span> + </h4> + <p class="shortcomment cmt">All potential colliding pairs of the world</p><div class="fullcomment"> + <div class="comment cmt"><p>All potential colliding pairs of the world.</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.collision.GridDetector#world"> + <h4 class="signature"> + <span class="kind">val</span> + <span class="symbol"> + <span class="name">world</span><span class="result">: <a href="../dynamics/World.html" class="extype" name="sims.dynamics.World">World</a></span> + </span> + </h4> + <p class="shortcomment cmt">The world whose shapes are to be checked for collisions</p><div class="fullcomment"> + <div class="comment cmt"><p>The world whose shapes are to be checked for collisions.</p></div> + + + + + </div> + </li></ol> + </div> - <code></code> - <code>def</code> - <em>collidingPairs</em> : <a href="" target="contentFrame" class="scala/Seq">scala.Seq</a>[<a href="../../sims/collision/Pair.html" target="_self">Pair</a>] - </dt> - <dd></dd> - </dl> - <dl><dd>Returns all colliding pairs.</dd></dl> - <dl></dl> - <hr></hr> -<a name="collisions"></a><dl> - <dt> + <div class="members" id="constructors"> + <h3>Instance constructors</h3> + <ol><li name="sims.collision.GridDetector#this"> + <h4 class="signature"> + <span class="kind">new</span> + <span class="symbol"> + <span class="name">GridDetector</span><span class="params">(<span name="world">world: <a href="../dynamics/World.html" class="extype" name="sims.dynamics.World">World</a></span>)</span> + </span> + </h4> + + </li><li name="sims.collision.Detector#this"> + <h4 class="signature"> + <span class="kind">new</span> + <span class="symbol"> + <span class="name">GridDetector</span><span class="params">()</span> + </span> + </h4> + + </li></ol> + </div> - <code></code> - <code>def</code> - <em>collisions</em> : <a href="" target="contentFrame" class="scala/Seq">scala.Seq</a>[<a href="../../sims/collision/Collision.html" target="_self">Collision</a>] - </dt> - <dd></dd> - </dl> - <dl><dd>Returns all collisions.</dd></dl> - <dl></dl> - <dl> - <dt style="margin:10px 0 0 20px;"> - <b>Overrides</b> - </dt> - <dd> - <a href="../../sims/collision/Detector.html" target="_self">Detector</a>.<a href="../../sims/collision/Detector.html#collisions" target="_self">collisions</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/collision/Overlap$object.html b/doc/sims/collision/Overlap$object.html deleted file mode 100644 index 0989c48..0000000 --- a/doc/sims/collision/Overlap$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 Overlap in sims.collision</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/collision$package.html" target="_self">sims.collision</a> - <br></br> - <span class="entity">object Overlap</span> - </div><hr></hr> - <div class="source"> - [source: <a href="" class="sims/collision/Overlap"><code>sims/collision/Overlap.scala</code></a>] - </div><hr></hr> - <a name="Overlap"></a><dl> - <dt> - - <code></code> - <code>object</code> - <em>Overlap</em> - </dt> - <dd><code> extends </code>(<a href="../../sims/geometry/ConvexPolygon.html" target="_self">ConvexPolygon</a>, <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/Double.html" target="_self">Double</a>) => <a href="../../sims/collision/Overlap.html" target="_self">Overlap</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/collision/Overlap.html b/doc/sims/collision/Overlap.html index f76df7e..b6f9960 100644 --- a/doc/sims/collision/Overlap.html +++ b/doc/sims/collision/Overlap.html @@ -1,276 +1,233 @@ -<!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 Overlap in sims.collision</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.collision.Overlap</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/collision$package.html" target="_self">sims.collision</a> - <br></br> - <span class="entity">class Overlap</span> - </div><hr></hr> - <div class="source"> - [source: <a href="" class="sims/collision/Overlap"><code>sims/collision/Overlap.scala</code></a>] - </div><hr></hr> - <a name="Overlap"></a><dl> - <dt> - - <code>case</code> - <code>class</code> - <em>Overlap</em>(<code>val </code><em>poly</em> : <a href="../../sims/geometry/ConvexPolygon.html" target="_self">ConvexPolygon</a>, <code>val </code><em>sideNum</em> : <a href="http://www.scala-lang.org/docu/files/api/scala/Int.html" target="_self">Int</a>, <code>val </code><em>overlap</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> + <body class="type"> + <p id="owner"><a href="../package.html">sims</a>.<a href="package.html">collision</a></p> + <div id="definition"> + <img src="../../lib/class_big.png" /> + <h1>Overlap</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/collision/Overlap.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/collision/Overlap.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/collision/Overlap.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/collision/Overlap.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/collision/Overlap.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/collision/Overlap.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">Overlap</span><span class="params">(<span name="poly">poly: <a href="../geometry/ConvexPolygon.html" class="extype" name="sims.geometry.ConvexPolygon">ConvexPolygon</a></span>, <span name="sideNum">sideNum: <span class="extype" name="scala.Int">Int</span></span>, <span name="overlap">overlap: <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"> - - -<table summary="" cellpadding="3" class="member-detail"> - <tr><td class="title">Method Details</td></tr> - </table><div><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.collision.Overlap#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.collision.Overlap#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.collision.Overlap#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.collision.Overlap#overlap"> + <h4 class="signature"> + <span class="kind">val</span> + <span class="symbol"> + <span class="name">overlap</span><span class="result">: <span class="extype" name="scala.Double">Double</span></span> + </span> + </h4> + + </li><li name="sims.collision.Overlap#poly"> + <h4 class="signature"> + <span class="kind">val</span> + <span class="symbol"> + <span class="name">poly</span><span class="result">: <a href="../geometry/ConvexPolygon.html" class="extype" name="sims.geometry.ConvexPolygon">ConvexPolygon</a></span> + </span> + </h4> + + </li><li name="sims.collision.Overlap#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.collision.Overlap#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.collision.Overlap#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.collision.Overlap#sideNum"> + <h4 class="signature"> + <span class="kind">val</span> + <span class="symbol"> + <span class="name">sideNum</span><span class="result">: <span class="extype" name="scala.Int">Int</span></span> + </span> + </h4> + + </li><li name="sims.collision.Overlap#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.collision.Overlap#this"> + <h4 class="signature"> + <span class="kind">new</span> + <span class="symbol"> + <span class="name">Overlap</span><span class="params">(<span name="poly">poly: <a href="../geometry/ConvexPolygon.html" class="extype" name="sims.geometry.ConvexPolygon">ConvexPolygon</a></span>, <span name="sideNum">sideNum: <span class="extype" name="scala.Int">Int</span></span>, <span name="overlap">overlap: <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">Overlap</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/collision/Pair$object.html b/doc/sims/collision/Pair$object.html deleted file mode 100644 index fab5d78..0000000 --- a/doc/sims/collision/Pair$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 Pair in sims.collision</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/collision$package.html" target="_self">sims.collision</a> - <br></br> - <span class="entity">object Pair</span> - </div><hr></hr> - <div class="source"> - [source: <a href="" class="sims/collision/Pair"><code>sims/collision/Pair.scala</code></a>] - </div><hr></hr> - <a name="Pair"></a><dl> - <dt> - - <code></code> - <code>object</code> - <em>Pair</em> - </dt> - <dd><code> extends </code>(<a href="../../sims/dynamics/Shape.html" target="_self">Shape</a>, <a href="../../sims/dynamics/Shape.html" target="_self">Shape</a>) => <a href="../../sims/collision/Pair.html" target="_self">Pair</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/collision/Pair.html b/doc/sims/collision/Pair.html index e210fc9..af5a434 100644 --- a/doc/sims/collision/Pair.html +++ b/doc/sims/collision/Pair.html @@ -1,257 +1,274 @@ -<!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 Pair in sims.collision</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/collision$package.html" target="_self">sims.collision</a> - <br></br> - <span class="entity">class Pair</span> - </div><hr></hr> - <div class="source"> - [source: <a href="" class="sims/collision/Pair"><code>sims/collision/Pair.scala</code></a>] - </div><hr></hr> - <a name="Pair"></a><dl> - <dt> - - <code>case</code> - <code>class</code> - <em>Pair</em>(<code>val </code><em>s1</em> : <a href="../../sims/dynamics/Shape.html" target="_self">Shape</a>, <code>val </code><em>s2</em> : <a href="../../sims/dynamics/Shape.html" target="_self">Shape</a>) - </dt> - <dd><code> extends </code>(<a href="../../sims/dynamics/Shape.html" target="_self">Shape</a>, <a href="../../sims/dynamics/Shape.html" target="_self">Shape</a>)</dd> - </dl> - <dl><dd>Pair of shapes.</dd></dl> - <dl></dl> + <head> + <title>Scaladoc for sims.collision.Pair</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> - <table summary="" cellpadding="3" class="member"> - <tr><td class="title" colspan="2">Additional Constructor Summary</td></tr> - <tr> - <td class="modifiers" valign="top"> - <code> def</code> - </td> - <td class="signature"> - <em><a href="../../sims/collision/Pair.html#this%28%28sims.dynamics.Shape%2Csims.dynamics.Shape%29%29" target="_self">this</a></em> - (<em>t</em> : (<a href="../../sims/dynamics/Shape.html" target="_self">Shape</a>, <a href="../../sims/dynamics/Shape.html" target="_self">Shape</a>)) : <a href="../../sims/collision/Pair.html" target="_self">Pair</a> - - - </td> - </tr> - </table> - -<table summary="" cellpadding="3" class="inherited"> - <tr><td class="title" colspan="2"> - Values and Variables inherited from <a href="" target="contentFrame" class="scala/Tuple2">scala.Tuple2</a> - </td></tr> - <tr><td class="signature" colspan="2"> - <a href="#_1" target="contentFrame" class="scala/Tuple2">scala.Tuple2._1</a>, <a href="#_2" target="contentFrame" class="scala/Tuple2">scala.Tuple2._2</a> - </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>override def</code> - </td> - <td class="signature"> - <em><a href="../../sims/collision/Pair.html#equals%28Any%29" target="_self">equals</a></em> - (<em>other</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/collision/Pair.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/collision/Pair.html#productPrefix" target="_self">productPrefix</a></em> - : <a href="" target="contentFrame" class="java/lang/String">java.lang.String</a> - - - </td> - </tr> - </table><table summary="" cellpadding="3" class="inherited"> - <tr><td class="title" colspan="2"> - Methods inherited from <a href="" target="contentFrame" class="scala/Tuple2">scala.Tuple2</a> - </td></tr> - <tr><td class="signature" colspan="2"> - <a href="#toString" target="contentFrame" class="scala/Tuple2">scala.Tuple2.toString</a>, <a href="#swap" target="contentFrame" class="scala/Tuple2">scala.Tuple2.swap</a> - </td></tr> - </table><table summary="" cellpadding="3" class="inherited"> - <tr><td class="title" colspan="2"> - Methods inherited from <a href="" target="contentFrame" class="scala/Product2">scala.Product2</a> - </td></tr> - <tr><td class="signature" colspan="2"> - <a href="#productArity" target="contentFrame" class="scala/Product2">scala.Product2.productArity</a>, <a href="#productElement" target="contentFrame" class="scala/Product2">scala.Product2.productElement</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#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> + </head> + <body class="type"> + + <p id="owner"><a href="../package.html">sims</a>.<a href="package.html">collision</a></p> + <div id="definition"> + <img src="../../lib/class_big.png" /> + <h1>Pair</h1> + </div> - <table summary="" cellpadding="3" class="member-detail"> - <tr><td class="title">Additional Constructor Details</td></tr> - </table><div><a name="this%28%28sims.dynamics.Shape%2Csims.dynamics.Shape%29%29"></a><dl> - <dt> + <h4 class="signature"> + <span class="kind">class</span> + <span class="symbol"> + <span class="name">Pair</span><span class="params">(<span name="s1">s1: <a href="../dynamics/Shape.html" class="extype" name="sims.dynamics.Shape">Shape</a></span>, <span name="s2">s2: <a href="../dynamics/Shape.html" class="extype" name="sims.dynamics.Shape">Shape</a></span>)</span><span class="result"> extends (<a href="../dynamics/Shape.html" class="extype" name="sims.dynamics.Shape">Shape</a>, <a href="../dynamics/Shape.html" class="extype" name="sims.dynamics.Shape">Shape</a>) with <span class="extype" name="scala.Product">Product</span></span> + </span> + </h4> + <div class="fullcomment" id="comment"> + <div class="comment cmt"><p>Pair of shapes.</p></div> + + + + + </div> + + <div id="template"> + + <div id="mbrsel"> + <div id="ancestors"> + <h3>Inherits</h3> + <ol><li class="in" name="scala.Tuple2">Tuple2</li><li class="in" name="scala.Product2">Product2</li><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></code> - <code>def</code> - <em>this</em>(<em>t</em> : (<a href="../../sims/dynamics/Shape.html" target="_self">Shape</a>, <a href="../../sims/dynamics/Shape.html" target="_self">Shape</a>)) : <a href="../../sims/collision/Pair.html" target="_self">Pair</a> - </dt> - <dd></dd> - </dl><hr></hr></div> - - -<table summary="" cellpadding="3" class="member-detail"> - <tr><td class="title">Method Details</td></tr> - </table><div><a name="equals%28Any%29"></a><dl> - <dt> - <code>override</code> - <code>def</code> - <em>equals</em>(<em>other</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> - <dl> - <dt style="margin:10px 0 0 20px;"> - <b>Overrides</b> - </dt> - <dd> - <a href="" target="contentFrame" class="scala/Tuple2">scala.Tuple2</a>.<a href="#equals" target="contentFrame" class="scala/Tuple2">scala.Tuple2.equals</a> - </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> - <dl> - <dt style="margin:10px 0 0 20px;"> - <b>Overrides</b> - </dt> - <dd> - <a href="" target="contentFrame" class="scala/Tuple2">scala.Tuple2</a>.<a href="#hashCode" target="contentFrame" class="scala/Tuple2">scala.Tuple2.hashCode</a> - </dd> - </dl><hr></hr> -<a name="productPrefix"></a><dl> - <dt> + <div class="members" id="values"> + <h3>Value Members</h3> + <ol><li name="scala.Tuple2#_1"> + <h4 class="signature"> + <span class="kind">val</span> + <span class="symbol"> + <span class="name">_1</span><span class="result">: <a href="../dynamics/Shape.html" class="extype" name="sims.dynamics.Shape">Shape</a></span> + </span> + </h4> + + </li><li name="scala.Tuple2#_2"> + <h4 class="signature"> + <span class="kind">val</span> + <span class="symbol"> + <span class="name">_2</span><span class="result">: <a href="../dynamics/Shape.html" class="extype" name="sims.dynamics.Shape">Shape</a></span> + </span> + </h4> + + </li><li name="sims.collision.Pair#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.collision.Pair#equals"> + <h4 class="signature"> + <span class="kind">def</span> + <span class="symbol"> + <span class="name">equals</span><span class="params">(<span name="other">other: <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> + + + + + </div> + </li><li name="sims.collision.Pair#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="scala.Product2#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="scala.Product2#productElement"> + <h4 class="signature"> + <span class="kind">def</span> + <span class="symbol"> + <span class="name">productElement</span><span class="params">(<span name="n">n: <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.collision.Pair#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.collision.Pair#s1"> + <h4 class="signature"> + <span class="kind">val</span> + <span class="symbol"> + <span class="name">s1</span><span class="result">: <a href="../dynamics/Shape.html" class="extype" name="sims.dynamics.Shape">Shape</a></span> + </span> + </h4> + + </li><li name="sims.collision.Pair#s2"> + <h4 class="signature"> + <span class="kind">val</span> + <span class="symbol"> + <span class="name">s2</span><span class="result">: <a href="../dynamics/Shape.html" class="extype" name="sims.dynamics.Shape">Shape</a></span> + </span> + </h4> + + </li><li name="scala.Tuple2#swap"> + <h4 class="signature"> + <span class="kind">def</span> + <span class="symbol"> + <span class="name">swap</span><span class="result">: (<a href="../dynamics/Shape.html" class="extype" name="sims.dynamics.Shape">Shape</a>, <a href="../dynamics/Shape.html" class="extype" name="sims.dynamics.Shape">Shape</a>)</span> + </span> + </h4> + + </li><li name="scala.Tuple2#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: Tuple2 ⇐ AnyRef ⇐ Any + </div> + + </div> + </li><li name="scala.Tuple2#zip"> + <h4 class="signature"> + <span class="kind">def</span> + <span class="symbol"> + <span class="name">zip</span><span class="tparams">[<span name="Repr1">Repr1</span>, <span name="El1">El1</span>, <span name="El2">El2</span>, <span name="To">To</span>]</span><span class="params">(<span name="w1">w1: (<a href="../dynamics/Shape.html" class="extype" name="sims.dynamics.Shape">Shape</a>) ⇒ <span class="extype" name="scala.collection.TraversableLike">TraversableLike</span>[El1, Repr1]</span>, <span name="w2">w2: (<a href="../dynamics/Shape.html" class="extype" name="sims.dynamics.Shape">Shape</a>) ⇒ <span class="extype" name="scala.collection.Iterable">Iterable</span>[El2]</span>, <span name="cbf1">cbf1: <span class="extype" name="scala.collection.generic.CanBuildFrom">CanBuildFrom</span>[Repr1, (El1, El2), To]</span>)</span><span class="result">: To</span> + </span> + </h4> + + </li><li name="scala.Tuple2#zipped"> + <h4 class="signature"> + <span class="kind">def</span> + <span class="symbol"> + <span class="name">zipped</span><span class="tparams">[<span name="Repr1">Repr1</span>, <span name="El1">El1</span>, <span name="Repr2">Repr2</span>, <span name="El2">El2</span>]</span><span class="params">(<span name="w1">w1: (<a href="../dynamics/Shape.html" class="extype" name="sims.dynamics.Shape">Shape</a>) ⇒ <span class="extype" name="scala.collection.TraversableLike">TraversableLike</span>[El1, Repr1]</span>, <span name="w2">w2: (<a href="../dynamics/Shape.html" class="extype" name="sims.dynamics.Shape">Shape</a>) ⇒ <span class="extype" name="scala.collection.IterableLike">IterableLike</span>[El2, Repr2]</span>)</span><span class="result">: <span class="extype" name="scala.Tuple2.Zipped">Zipped</span>[Repr1, El1, Repr2, El2]</span> + </span> + </h4> + + </li></ol> + </div> - <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/Tuple2">scala.Tuple2</a>.<a href="#productPrefix" target="contentFrame" class="scala/Tuple2">scala.Tuple2.productPrefix</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 class="members" id="constructors"> + <h3>Instance constructors</h3> + <ol><li name="sims.collision.Pair#this"> + <h4 class="signature"> + <span class="kind">new</span> + <span class="symbol"> + <span class="name">Pair</span><span class="params">(<span name="t">t: (<a href="../dynamics/Shape.html" class="extype" name="sims.dynamics.Shape">Shape</a>, <a href="../dynamics/Shape.html" class="extype" name="sims.dynamics.Shape">Shape</a>)</span>)</span> + </span> + </h4> + + </li><li name="sims.collision.Pair#this"> + <h4 class="signature"> + <span class="kind">new</span> + <span class="symbol"> + <span class="name">Pair</span><span class="params">(<span name="s1">s1: <a href="../dynamics/Shape.html" class="extype" name="sims.dynamics.Shape">Shape</a></span>, <span name="s2">s2: <a href="../dynamics/Shape.html" class="extype" name="sims.dynamics.Shape">Shape</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">Pair</span><span class="params">()</span> + </span> + </h4> + + </li></ol> + </div> + + </div> + + </body> </html>
\ No newline at end of file diff --git a/doc/sims/collision/PolyCircleCollision$object.html b/doc/sims/collision/PolyCircleCollision$object.html deleted file mode 100644 index 7ccdcf3..0000000 --- a/doc/sims/collision/PolyCircleCollision$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 PolyCircleCollision in sims.collision</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/collision$package.html" target="_self">sims.collision</a> - <br></br> - <span class="entity">object PolyCircleCollision</span> - </div><hr></hr> - <div class="source"> - [source: <a href="" class="sims/collision/PolyCircleCollision"><code>sims/collision/PolyCircleCollision.scala</code></a>] - </div><hr></hr> - <a name="PolyCircleCollision"></a><dl> - <dt> - - <code></code> - <code>object</code> - <em>PolyCircleCollision</em> - </dt> - <dd><code> extends </code>(<a href="../../sims/geometry/ConvexPolygon.html" target="_self">ConvexPolygon</a>, <a href="../../sims/dynamics/Circle.html" target="_self">Circle</a>) => <a href="../../sims/collision/PolyCircleCollision.html" target="_self">PolyCircleCollision</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/collision/PolyCircleCollision.html b/doc/sims/collision/PolyCircleCollision.html index 3b1d094..fc31ca6 100644 --- a/doc/sims/collision/PolyCircleCollision.html +++ b/doc/sims/collision/PolyCircleCollision.html @@ -1,409 +1,321 @@ -<!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 PolyCircleCollision in sims.collision</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/collision$package.html" target="_self">sims.collision</a> - <br></br> - <span class="entity">class PolyCircleCollision</span> - </div><hr></hr> - <div class="source"> - [source: <a href="" class="sims/collision/PolyCircleCollision"><code>sims/collision/PolyCircleCollision.scala</code></a>] - </div><hr></hr> - <a name="PolyCircleCollision"></a><dl> - <dt> - - <code>case</code> - <code>class</code> - <em>PolyCircleCollision</em>(<code>val </code><em>p</em> : <a href="../../sims/geometry/ConvexPolygon.html" target="_self">ConvexPolygon</a>, <code>val </code><em>c</em> : <a href="../../sims/dynamics/Circle.html" target="_self">Circle</a>) - </dt> - <dd><code> extends </code><a href="../../sims/collision/Collision.html" target="_self">Collision</a><code> with </code><a href="" target="contentFrame" class="scala/Product">scala.Product</a></dd> - </dl> - <dl><dd>Collision between a convex polygon and a circle.</dd></dl> - <dl></dl> + <head> + <title>Scaladoc for sims.collision.PolyCircleCollision</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">collision</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/collision/PolyCircleCollision.html#normal" target="_self">normal</a></em> - : <a href="../../sims/geometry/Vector2D.html" target="_self">Vector2D</a> - - <div>Normal vector to the collision face.</div> - </td> - </tr> -<tr> - <td class="modifiers" valign="top"> - <code> val</code> - </td> - <td class="signature"> - <em><a href="../../sims/collision/PolyCircleCollision.html#points" target="_self">points</a></em> - : <a href="" target="contentFrame" class="scala/List">scala.List</a>[<a href="../../sims/geometry/Vector2D.html" target="_self">Vector2D</a>] - - <div>Collision points.</div> - </td> - </tr> -<tr> - <td class="modifiers" valign="top"> - <code> val</code> - </td> - <td class="signature"> - <em><a href="../../sims/collision/PolyCircleCollision.html#shape1" target="_self">shape1</a></em> - : <a href="../../sims/dynamics/Shape.html" target="_self">Shape</a> - - <div>First colliding shape (reference shape).</div> - </td> - </tr> -<tr> - <td class="modifiers" valign="top"> - <code> val</code> - </td> - <td class="signature"> - <em><a href="../../sims/collision/PolyCircleCollision.html#shape2" target="_self">shape2</a></em> - : <a href="../../sims/dynamics/Circle.html" target="_self">Circle</a> - - <div>Second colliding shape (incident shape).</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>override def</code> - </td> - <td class="signature"> - <em><a href="../../sims/collision/PolyCircleCollision.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/collision/PolyCircleCollision.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/collision/PolyCircleCollision.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/collision/PolyCircleCollision.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/collision/PolyCircleCollision.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/collision/PolyCircleCollision.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="../../sims/collision/Collision.html" target="_self">Collision</a> - </td></tr> - <tr><td class="signature" colspan="2"> - <a href="../../sims/collision/Collision.html#correctVelocity%28Double%29" target="_self">correctVelocity</a>, <a href="../../sims/collision/Collision.html#correctFriction%28sims.geometry.Vector2D%2CDouble%2CDouble%29" target="_self">correctFriction</a>, <a href="../../sims/collision/Collision.html#correctPosition%28Double%29" target="_self">correctPosition</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#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>PolyCircleCollision</h1> + </div> + <h4 class="signature"> + <span class="kind">class</span> + <span class="symbol"> + <span class="name">PolyCircleCollision</span><span class="params">(<span name="p">p: <a href="../geometry/ConvexPolygon.html" class="extype" name="sims.geometry.ConvexPolygon">ConvexPolygon</a></span>, <span name="c">c: <a href="../dynamics/Circle.html" class="extype" name="sims.dynamics.Circle">Circle</a></span>)</span><span class="result"> extends <a href="Collision.html" class="extype" name="sims.collision.Collision">Collision</a> with <span class="extype" name="scala.Product">Product</span></span> + </span> + </h4> + <div class="fullcomment" id="comment"> + <div class="comment cmt"><p>Collision between a convex polygon and a circle.</p></div> - -<table summary="" cellpadding="3" class="member-detail"> - <tr><td class="title">Value Details</td></tr> - </table><div><a name="shape1"></a><dl> - <dt> - - <code></code> - <code>val</code> - <em>shape1</em> : <a href="../../sims/dynamics/Shape.html" target="_self">Shape</a> - </dt> - <dd></dd> - </dl> - <dl><dd>First colliding shape (reference shape).</dd></dl> - <dl></dl> - <dl> - <dt style="margin:10px 0 0 20px;"> - <b>Overrides</b> - </dt> - <dd> - <a href="../../sims/collision/Collision.html" target="_self">Collision</a>.<a href="../../sims/collision/Collision.html#shape1" target="_self">shape1</a> - </dd> - </dl><hr></hr> -<a name="shape2"></a><dl> - <dt> - - <code></code> - <code>val</code> - <em>shape2</em> : <a href="../../sims/dynamics/Circle.html" target="_self">Circle</a> - </dt> - <dd></dd> - </dl> - <dl><dd>Second colliding shape (incident shape).</dd></dl> - <dl></dl> - <dl> - <dt style="margin:10px 0 0 20px;"> - <b>Overrides</b> - </dt> - <dd> - <a href="../../sims/collision/Collision.html" target="_self">Collision</a>.<a href="../../sims/collision/Collision.html#shape2" target="_self">shape2</a> - </dd> - </dl><hr></hr> -<a name="normal"></a><dl> - <dt> - - <code></code> - <code>val</code> - <em>normal</em> : <a href="../../sims/geometry/Vector2D.html" target="_self">Vector2D</a> - </dt> - <dd></dd> - </dl> - <dl><dd>Normal vector to the collision face.</dd></dl> - <dl></dl> - <dl> - <dt style="margin:10px 0 0 20px;"> - <b>Overrides</b> - </dt> - <dd> - <a href="../../sims/collision/Collision.html" target="_self">Collision</a>.<a href="../../sims/collision/Collision.html#normal" target="_self">normal</a> - </dd> - </dl><hr></hr> -<a name="points"></a><dl> - <dt> - - <code></code> - <code>val</code> - <em>points</em> : <a href="" target="contentFrame" class="scala/List">scala.List</a>[<a href="../../sims/geometry/Vector2D.html" target="_self">Vector2D</a>] - </dt> - <dd></dd> - </dl> - <dl><dd>Collision points.</dd></dl> - <dl></dl> - <dl> - <dt style="margin:10px 0 0 20px;"> - <b>Overrides</b> - </dt> - <dd> - <a href="../../sims/collision/Collision.html" target="_self">Collision</a>.<a href="../../sims/collision/Collision.html#points" target="_self">points</a> - </dd> - </dl><hr></hr></div> -<table summary="" cellpadding="3" class="member-detail"> - <tr><td class="title">Method Details</td></tr> - </table><div><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="sims.collision.Collision">Collision</li><li class="in" name="sims.dynamics.Constraint">Constraint</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.collision.PolyCircleCollision#c"> + <h4 class="signature"> + <span class="kind">val</span> + <span class="symbol"> + <span class="name">c</span><span class="result">: <a href="../dynamics/Circle.html" class="extype" name="sims.dynamics.Circle">Circle</a></span> + </span> + </h4> + + </li><li name="sims.collision.PolyCircleCollision#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.collision.Collision#correctFriction"> + <h4 class="signature"> + <span class="kind">def</span> + <span class="symbol"> + <span class="name">correctFriction</span><span class="params">(<span name="point">point: <a href="../geometry/Vector2D.html" class="extype" name="sims.geometry.Vector2D">Vector2D</a></span>, <span name="normalForce">normalForce: <span class="extype" name="scala.Double">Double</span></span>, <span name="h">h: <span class="extype" name="scala.Double">Double</span></span>)</span><span class="result">: <span class="extype" name="scala.Unit">Unit</span></span> + </span> + </h4> + + </li><li name="sims.collision.Collision#correctPosition"> + <h4 class="signature"> + <span class="kind">def</span> + <span class="symbol"> + <span class="name">correctPosition</span><span class="params">(<span name="h">h: <span class="extype" name="scala.Double">Double</span></span>)</span><span class="result">: <span class="extype" name="scala.Unit">Unit</span></span> + </span> + </h4> + <p class="shortcomment cmt">Corrects the positions of bodies according to this constraint</p><div class="fullcomment"> + <div class="comment cmt"><p>Corrects the positions of bodies according to this constraint.</p></div> + <dl class="paramcmts block"><dt class="param">h</dt><dd class="cmt"><p>a time interval, used for converting forces and impulses</p></dd></dl> + + <div class="block"> + definition classes: <a href="Collision.html">Collision</a> ⇐ <a href="../dynamics/Constraint.html">Constraint</a> + </div> + + </div> + </li><li name="sims.collision.Collision#correctVelocity"> + <h4 class="signature"> + <span class="kind">def</span> + <span class="symbol"> + <span class="name">correctVelocity</span><span class="params">(<span name="h">h: <span class="extype" name="scala.Double">Double</span></span>)</span><span class="result">: <span class="extype" name="scala.Unit">Unit</span></span> + </span> + </h4> + <p class="shortcomment cmt">Corrects the velocities of bodies according to this constraint</p><div class="fullcomment"> + <div class="comment cmt"><p>Corrects the velocities of bodies according to this constraint.</p></div> + <dl class="paramcmts block"><dt class="param">h</dt><dd class="cmt"><p>a time interval, used for converting forces and impulses</p></dd></dl> + + <div class="block"> + definition classes: <a href="Collision.html">Collision</a> ⇐ <a href="../dynamics/Constraint.html">Constraint</a> + </div> + + </div> + </li><li name="sims.collision.PolyCircleCollision#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.collision.PolyCircleCollision#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.collision.PolyCircleCollision#normal"> + <h4 class="signature"> + <span class="kind">val</span> + <span class="symbol"> + <span class="name">normal</span><span class="result">: <a href="../geometry/Vector2D.html" class="extype" name="sims.geometry.Vector2D">Vector2D</a></span> + </span> + </h4> + <p class="shortcomment cmt">Normal vector to the collision face</p><div class="fullcomment"> + <div class="comment cmt"><p>Normal vector to the collision face.</p></div> + + + + + </div> + </li><li name="sims.collision.PolyCircleCollision#p"> + <h4 class="signature"> + <span class="kind">val</span> + <span class="symbol"> + <span class="name">p</span><span class="result">: <a href="../geometry/ConvexPolygon.html" class="extype" name="sims.geometry.ConvexPolygon">ConvexPolygon</a></span> + </span> + </h4> + + </li><li name="sims.collision.PolyCircleCollision#points"> + <h4 class="signature"> + <span class="kind">val</span> + <span class="symbol"> + <span class="name">points</span><span class="result">: <span class="extype" name="scala.collection.immutable.List">List</span>[<a href="../geometry/Vector2D.html" class="extype" name="sims.geometry.Vector2D">Vector2D</a>]</span> + </span> + </h4> + <p class="shortcomment cmt">Collision points</p><div class="fullcomment"> + <div class="comment cmt"><p>Collision points.</p></div> + + + + + </div> + </li><li name="sims.collision.PolyCircleCollision#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.collision.PolyCircleCollision#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.collision.PolyCircleCollision#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.collision.PolyCircleCollision#shape1"> + <h4 class="signature"> + <span class="kind">val</span> + <span class="symbol"> + <span class="name">shape1</span><span class="result">: <a href="../dynamics/Shape.html" class="extype" name="sims.dynamics.Shape">Shape</a></span> + </span> + </h4> + <p class="shortcomment cmt">First colliding shape (reference shape)</p><div class="fullcomment"> + <div class="comment cmt"><p>First colliding shape (reference shape).</p></div> + + + + + </div> + </li><li name="sims.collision.PolyCircleCollision#shape2"> + <h4 class="signature"> + <span class="kind">val</span> + <span class="symbol"> + <span class="name">shape2</span><span class="result">: <a href="../dynamics/Circle.html" class="extype" name="sims.dynamics.Circle">Circle</a></span> + </span> + </h4> + <p class="shortcomment cmt">Second colliding shape (incident shape)</p><div class="fullcomment"> + <div class="comment cmt"><p>Second colliding shape (incident shape).</p></div> + + + + + </div> + </li><li name="sims.collision.PolyCircleCollision#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> - <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.collision.PolyCircleCollision#this"> + <h4 class="signature"> + <span class="kind">new</span> + <span class="symbol"> + <span class="name">PolyCircleCollision</span><span class="params">(<span name="p">p: <a href="../geometry/ConvexPolygon.html" class="extype" name="sims.geometry.ConvexPolygon">ConvexPolygon</a></span>, <span name="c">c: <a href="../dynamics/Circle.html" class="extype" name="sims.dynamics.Circle">Circle</a></span>)</span> + </span> + </h4> + + </li><li name="sims.collision.Collision#this"> + <h4 class="signature"> + <span class="kind">new</span> + <span class="symbol"> + <span class="name">PolyCircleCollision</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/collision/PolyCollision$object.html b/doc/sims/collision/PolyCollision$object.html deleted file mode 100644 index a9642ae..0000000 --- a/doc/sims/collision/PolyCollision$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 PolyCollision in sims.collision</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/collision$package.html" target="_self">sims.collision</a> - <br></br> - <span class="entity">object PolyCollision</span> - </div><hr></hr> - <div class="source"> - [source: <a href="" class="sims/collision/PolyCollision"><code>sims/collision/PolyCollision.scala</code></a>] - </div><hr></hr> - <a name="PolyCollision"></a><dl> - <dt> - - <code></code> - <code>object</code> - <em>PolyCollision</em> - </dt> - <dd><code> extends </code>(<a href="../../sims/geometry/ConvexPolygon.html" target="_self">ConvexPolygon</a>, <a href="../../sims/geometry/ConvexPolygon.html" target="_self">ConvexPolygon</a>) => <a href="../../sims/collision/PolyCollision.html" target="_self">PolyCollision</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/collision/PolyCollision.html b/doc/sims/collision/PolyCollision.html index 9009f39..8a9cc89 100644 --- a/doc/sims/collision/PolyCollision.html +++ b/doc/sims/collision/PolyCollision.html @@ -1,469 +1,345 @@ -<!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 PolyCollision in sims.collision</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/collision$package.html" target="_self">sims.collision</a> - <br></br> - <span class="entity">class PolyCollision</span> - </div><hr></hr> - <div class="source"> - [source: <a href="" class="sims/collision/PolyCollision"><code>sims/collision/PolyCollision.scala</code></a>] - </div><hr></hr> - <a name="PolyCollision"></a><dl> - <dt> - - <code>case</code> - <code>class</code> - <em>PolyCollision</em>(<code>val </code><em>p1</em> : <a href="../../sims/geometry/ConvexPolygon.html" target="_self">ConvexPolygon</a>, <code>val </code><em>p2</em> : <a href="../../sims/geometry/ConvexPolygon.html" target="_self">ConvexPolygon</a>) - </dt> - <dd><code> extends </code><a href="../../sims/collision/Collision.html" target="_self">Collision</a><code> with </code><a href="" target="contentFrame" class="scala/Product">scala.Product</a></dd> - </dl> - <dl><dd>Collision between two convex polygons.</dd></dl> - <dl></dl> + <head> + <title>Scaladoc for sims.collision.PolyCollision</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">collision</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> var</code> - </td> - <td class="signature"> - <em><a href="../../sims/collision/PolyCollision.html#minOverlap" target="_self">minOverlap</a></em> - : <a href="../../sims/collision/Overlap.html" target="_self">Overlap</a> - - - </td> - </tr> -<tr> - <td class="modifiers" valign="top"> - <code> lazy val</code> - </td> - <td class="signature"> - <em><a href="../../sims/collision/PolyCollision.html#normal" target="_self">normal</a></em> - : <a href="../../sims/geometry/Vector2D.html" target="_self">Vector2D</a> - - <div>Normal vector to the collision face.</div> - </td> - </tr> -<tr> - <td class="modifiers" valign="top"> - <code> lazy val</code> - </td> - <td class="signature"> - <em><a href="../../sims/collision/PolyCollision.html#overlaps" target="_self">overlaps</a></em> - : <a href="" target="contentFrame" class="scala/RandomAccessSeq">scala.RandomAccessSeq</a>[<a href="../../sims/collision/Overlap.html" target="_self">Overlap</a>] - - - </td> - </tr> -<tr> - <td class="modifiers" valign="top"> - <code> lazy val</code> - </td> - <td class="signature"> - <em><a href="../../sims/collision/PolyCollision.html#points" target="_self">points</a></em> - : <a href="" target="contentFrame" class="scala/Seq">scala.Seq</a>[<a href="../../sims/geometry/Vector2D.html" target="_self">Vector2D</a>] - - <div>Collision points.</div> - </td> - </tr> -<tr> - <td class="modifiers" valign="top"> - <code> lazy val</code> - </td> - <td class="signature"> - <em><a href="../../sims/collision/PolyCollision.html#shape1" target="_self">shape1</a></em> - : <a href="../../sims/dynamics/Shape.html" target="_self">Shape</a> - - <div>First colliding shape (reference shape).</div> - </td> - </tr> -<tr> - <td class="modifiers" valign="top"> - <code> lazy val</code> - </td> - <td class="signature"> - <em><a href="../../sims/collision/PolyCollision.html#shape2" target="_self">shape2</a></em> - : <a href="../../sims/dynamics/Shape.html" target="_self">Shape</a> - - <div>Second colliding shape (incident shape).</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>override def</code> - </td> - <td class="signature"> - <em><a href="../../sims/collision/PolyCollision.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/collision/PolyCollision.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/collision/PolyCollision.html#overlap%28sims.geometry.Vector2D%29" target="_self">overlap</a></em> - (<em>axis</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> - - - </td> - </tr> -<tr> - <td class="modifiers" valign="top"> - <code>override def</code> - </td> - <td class="signature"> - <em><a href="../../sims/collision/PolyCollision.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/collision/PolyCollision.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/collision/PolyCollision.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/collision/PolyCollision.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="../../sims/collision/Collision.html" target="_self">Collision</a> - </td></tr> - <tr><td class="signature" colspan="2"> - <a href="../../sims/collision/Collision.html#correctVelocity%28Double%29" target="_self">correctVelocity</a>, <a href="../../sims/collision/Collision.html#correctFriction%28sims.geometry.Vector2D%2CDouble%2CDouble%29" target="_self">correctFriction</a>, <a href="../../sims/collision/Collision.html#correctPosition%28Double%29" target="_self">correctPosition</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#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>PolyCollision</h1> + </div> + <h4 class="signature"> + <span class="kind">class</span> + <span class="symbol"> + <span class="name">PolyCollision</span><span class="params">(<span name="p1">p1: <a href="../geometry/ConvexPolygon.html" class="extype" name="sims.geometry.ConvexPolygon">ConvexPolygon</a></span>, <span name="p2">p2: <a href="../geometry/ConvexPolygon.html" class="extype" name="sims.geometry.ConvexPolygon">ConvexPolygon</a></span>)</span><span class="result"> extends <a href="Collision.html" class="extype" name="sims.collision.Collision">Collision</a> with <span class="extype" name="scala.Product">Product</span></span> + </span> + </h4> + <div class="fullcomment" id="comment"> + <div class="comment cmt"><p>Collision between two convex polygons.</p></div> - -<table summary="" cellpadding="3" class="member-detail"> - <tr><td class="title">Value Details</td></tr> - </table><div><a name="overlaps"></a><dl> - <dt> - - <code></code> - <code>lazy val</code> - <em>overlaps</em> : <a href="" target="contentFrame" class="scala/RandomAccessSeq">scala.RandomAccessSeq</a>[<a href="../../sims/collision/Overlap.html" target="_self">Overlap</a>] - </dt> - <dd></dd> - </dl><hr></hr> -<a name="minOverlap"></a><dl> - <dt> - - <code></code> - <code>var</code> - <em>minOverlap</em> : <a href="../../sims/collision/Overlap.html" target="_self">Overlap</a> - </dt> - <dd></dd> - </dl><hr></hr> -<a name="shape1"></a><dl> - <dt> - - <code></code> - <code>lazy val</code> - <em>shape1</em> : <a href="../../sims/dynamics/Shape.html" target="_self">Shape</a> - </dt> - <dd></dd> - </dl> - <dl><dd>First colliding shape (reference shape).</dd></dl> - <dl></dl> - <dl> - <dt style="margin:10px 0 0 20px;"> - <b>Overrides</b> - </dt> - <dd> - <a href="../../sims/collision/Collision.html" target="_self">Collision</a>.<a href="../../sims/collision/Collision.html#shape1" target="_self">shape1</a> - </dd> - </dl><hr></hr> -<a name="shape2"></a><dl> - <dt> - - <code></code> - <code>lazy val</code> - <em>shape2</em> : <a href="../../sims/dynamics/Shape.html" target="_self">Shape</a> - </dt> - <dd></dd> - </dl> - <dl><dd>Second colliding shape (incident shape).</dd></dl> - <dl></dl> - <dl> - <dt style="margin:10px 0 0 20px;"> - <b>Overrides</b> - </dt> - <dd> - <a href="../../sims/collision/Collision.html" target="_self">Collision</a>.<a href="../../sims/collision/Collision.html#shape2" target="_self">shape2</a> - </dd> - </dl><hr></hr> -<a name="normal"></a><dl> - <dt> - - <code></code> - <code>lazy val</code> - <em>normal</em> : <a href="../../sims/geometry/Vector2D.html" target="_self">Vector2D</a> - </dt> - <dd></dd> - </dl> - <dl><dd>Normal vector to the collision face.</dd></dl> - <dl></dl> - <dl> - <dt style="margin:10px 0 0 20px;"> - <b>Overrides</b> - </dt> - <dd> - <a href="../../sims/collision/Collision.html" target="_self">Collision</a>.<a href="../../sims/collision/Collision.html#normal" target="_self">normal</a> - </dd> - </dl><hr></hr> -<a name="points"></a><dl> - <dt> - - <code></code> - <code>lazy val</code> - <em>points</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>Collision points.</dd></dl> - <dl></dl> - <dl> - <dt style="margin:10px 0 0 20px;"> - <b>Overrides</b> - </dt> - <dd> - <a href="../../sims/collision/Collision.html" target="_self">Collision</a>.<a href="../../sims/collision/Collision.html#points" target="_self">points</a> - </dd> - </dl><hr></hr></div> -<table summary="" cellpadding="3" class="member-detail"> - <tr><td class="title">Method Details</td></tr> - </table><div><a name="overlap%28sims.geometry.Vector2D%29"></a><dl> - <dt> - - <code></code> - <code>def</code> - <em>overlap</em>(<em>axis</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><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="sims.collision.Collision">Collision</li><li class="in" name="sims.dynamics.Constraint">Constraint</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.collision.PolyCollision#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.collision.Collision#correctFriction"> + <h4 class="signature"> + <span class="kind">def</span> + <span class="symbol"> + <span class="name">correctFriction</span><span class="params">(<span name="point">point: <a href="../geometry/Vector2D.html" class="extype" name="sims.geometry.Vector2D">Vector2D</a></span>, <span name="normalForce">normalForce: <span class="extype" name="scala.Double">Double</span></span>, <span name="h">h: <span class="extype" name="scala.Double">Double</span></span>)</span><span class="result">: <span class="extype" name="scala.Unit">Unit</span></span> + </span> + </h4> + + </li><li name="sims.collision.Collision#correctPosition"> + <h4 class="signature"> + <span class="kind">def</span> + <span class="symbol"> + <span class="name">correctPosition</span><span class="params">(<span name="h">h: <span class="extype" name="scala.Double">Double</span></span>)</span><span class="result">: <span class="extype" name="scala.Unit">Unit</span></span> + </span> + </h4> + <p class="shortcomment cmt">Corrects the positions of bodies according to this constraint</p><div class="fullcomment"> + <div class="comment cmt"><p>Corrects the positions of bodies according to this constraint.</p></div> + <dl class="paramcmts block"><dt class="param">h</dt><dd class="cmt"><p>a time interval, used for converting forces and impulses</p></dd></dl> + + <div class="block"> + definition classes: <a href="Collision.html">Collision</a> ⇐ <a href="../dynamics/Constraint.html">Constraint</a> + </div> + + </div> + </li><li name="sims.collision.Collision#correctVelocity"> + <h4 class="signature"> + <span class="kind">def</span> + <span class="symbol"> + <span class="name">correctVelocity</span><span class="params">(<span name="h">h: <span class="extype" name="scala.Double">Double</span></span>)</span><span class="result">: <span class="extype" name="scala.Unit">Unit</span></span> + </span> + </h4> + <p class="shortcomment cmt">Corrects the velocities of bodies according to this constraint</p><div class="fullcomment"> + <div class="comment cmt"><p>Corrects the velocities of bodies according to this constraint.</p></div> + <dl class="paramcmts block"><dt class="param">h</dt><dd class="cmt"><p>a time interval, used for converting forces and impulses</p></dd></dl> + + <div class="block"> + definition classes: <a href="Collision.html">Collision</a> ⇐ <a href="../dynamics/Constraint.html">Constraint</a> + </div> + + </div> + </li><li name="sims.collision.PolyCollision#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.collision.PolyCollision#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.collision.PolyCollision#minOverlap"> + <h4 class="signature"> + <span class="kind">var</span> + <span class="symbol"> + <span class="name">minOverlap</span><span class="result">: <a href="Overlap.html" class="extype" name="sims.collision.Overlap">Overlap</a></span> + </span> + </h4> + + </li><li name="sims.collision.PolyCollision#normal"> + <h4 class="signature"> + <span class="kind">var</span> + <span class="symbol"> + <span class="name">normal</span><span class="result">: <a href="../geometry/Vector2D.html" class="extype" name="sims.geometry.Vector2D">Vector2D</a></span> + </span> + </h4> + <p class="shortcomment cmt">Normal vector to the collision face</p><div class="fullcomment"> + <div class="comment cmt"><p>Normal vector to the collision face.</p></div> + + + + + </div> + </li><li name="sims.collision.PolyCollision#overlap"> + <h4 class="signature"> + <span class="kind">def</span> + <span class="symbol"> + <span class="name">overlap</span><span class="params">(<span name="axis">axis: <a href="../geometry/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> + + </li><li name="sims.collision.PolyCollision#overlaps"> + <h4 class="signature"> + <span class="kind">var</span> + <span class="symbol"> + <span class="name">overlaps</span><span class="result">: <span class="extype" name="scala.collection.immutable.IndexedSeq">IndexedSeq</span>[<a href="Overlap.html" class="extype" name="sims.collision.Overlap">Overlap</a>]</span> + </span> + </h4> + + </li><li name="sims.collision.PolyCollision#p1"> + <h4 class="signature"> + <span class="kind">val</span> + <span class="symbol"> + <span class="name">p1</span><span class="result">: <a href="../geometry/ConvexPolygon.html" class="extype" name="sims.geometry.ConvexPolygon">ConvexPolygon</a></span> + </span> + </h4> + + </li><li name="sims.collision.PolyCollision#p2"> + <h4 class="signature"> + <span class="kind">val</span> + <span class="symbol"> + <span class="name">p2</span><span class="result">: <a href="../geometry/ConvexPolygon.html" class="extype" name="sims.geometry.ConvexPolygon">ConvexPolygon</a></span> + </span> + </h4> + + </li><li name="sims.collision.PolyCollision#points"> + <h4 class="signature"> + <span class="kind">var</span> + <span class="symbol"> + <span class="name">points</span><span class="result">: <span class="extype" name="scala.collection.Seq">Seq</span>[<a href="../geometry/Vector2D.html" class="extype" name="sims.geometry.Vector2D">Vector2D</a>]</span> + </span> + </h4> + <p class="shortcomment cmt">Collision points</p><div class="fullcomment"> + <div class="comment cmt"><p>Collision points.</p></div> + + + + + </div> + </li><li name="sims.collision.PolyCollision#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.collision.PolyCollision#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.collision.PolyCollision#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.collision.PolyCollision#shape1"> + <h4 class="signature"> + <span class="kind">var</span> + <span class="symbol"> + <span class="name">shape1</span><span class="result">: <a href="../dynamics/Shape.html" class="extype" name="sims.dynamics.Shape">Shape</a></span> + </span> + </h4> + <p class="shortcomment cmt">First colliding shape (reference shape)</p><div class="fullcomment"> + <div class="comment cmt"><p>First colliding shape (reference shape).</p></div> + + + + + </div> + </li><li name="sims.collision.PolyCollision#shape2"> + <h4 class="signature"> + <span class="kind">var</span> + <span class="symbol"> + <span class="name">shape2</span><span class="result">: <a href="../dynamics/Shape.html" class="extype" name="sims.dynamics.Shape">Shape</a></span> + </span> + </h4> + <p class="shortcomment cmt">Second colliding shape (incident shape)</p><div class="fullcomment"> + <div class="comment cmt"><p>Second colliding shape (incident shape).</p></div> + + + + + </div> + </li><li name="sims.collision.PolyCollision#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.collision.PolyCollision#this"> + <h4 class="signature"> + <span class="kind">new</span> + <span class="symbol"> + <span class="name">PolyCollision</span><span class="params">(<span name="p1">p1: <a href="../geometry/ConvexPolygon.html" class="extype" name="sims.geometry.ConvexPolygon">ConvexPolygon</a></span>, <span name="p2">p2: <a href="../geometry/ConvexPolygon.html" class="extype" name="sims.geometry.ConvexPolygon">ConvexPolygon</a></span>)</span> + </span> + </h4> + + </li><li name="sims.collision.Collision#this"> + <h4 class="signature"> + <span class="kind">new</span> + <span class="symbol"> + <span class="name">PolyCollision</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/collision/package.html b/doc/sims/collision/package.html new file mode 100644 index 0000000..a1e571e --- /dev/null +++ b/doc/sims/collision/package.html @@ -0,0 +1,137 @@ +<?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.collision</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>collision</h1> + </div> + + <h4 class="signature"> + <span class="kind">package</span> + <span class="symbol"> + <span class="name">collision</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.collision.AABB"> + <h4 class="signature"><a href="AABB.html"> + <span class="kind">class</span> + <span class="symbol"> + <span class="name">AABB</span><span class="params">(<span name="minVertex">minVertex: Vector2D</span>, <span name="maxVertex">maxVertex: Vector2D</span>)</span><span class="result"> extends Product</span> + </span> + </a></h4> + <p class="comment cmt">Axis Aligned Bounding Boxes (AABBs) are rectangles that frame a shape</p> + </li><li name="sims.collision.CircleCollision"> + <h4 class="signature"><a href="CircleCollision.html"> + <span class="kind">class</span> + <span class="symbol"> + <span class="name">CircleCollision</span><span class="params">(<span name="c1">c1: Circle</span>, <span name="c2">c2: Circle</span>)</span><span class="result"> extends Collision with Product</span> + </span> + </a></h4> + <p class="comment cmt">Collision between two circles</p> + </li><li name="sims.collision.Collision"> + <h4 class="signature"><a href="Collision.html"> + <span class="kind">class</span> + <span class="symbol"> + <span class="name">Collision</span><span class="result"> extends Constraint</span> + </span> + </a></h4> + <p class="comment cmt">Collision between two shapes</p> + </li><li name="sims.collision.Detector"> + <h4 class="signature"><a href="Detector.html"> + <span class="kind">class</span> + <span class="symbol"> + <span class="name">Detector</span><span class="result"> extends AnyRef</span> + </span> + </a></h4> + <p class="comment cmt">A world detects its collisions through concrete implementations of this class</p> + </li><li name="sims.collision.GridDetector"> + <h4 class="signature"><a href="GridDetector.html"> + <span class="kind">class</span> + <span class="symbol"> + <span class="name">GridDetector</span><span class="result"> extends Detector</span> + </span> + </a></h4> + <p class="comment cmt">A conrete implementation of <code>Detector</code></p> + </li><li name="sims.collision.Overlap"> + <h4 class="signature"><a href="Overlap.html"> + <span class="kind">class</span> + <span class="symbol"> + <span class="name">Overlap</span><span class="params">(<span name="poly">poly: ConvexPolygon</span>, <span name="sideNum">sideNum: Int</span>, <span name="overlap">overlap: Double</span>)</span><span class="result"> extends Product</span> + </span> + </a></h4> + + </li><li name="sims.collision.Pair"> + <h4 class="signature"><a href="Pair.html"> + <span class="kind">class</span> + <span class="symbol"> + <span class="name">Pair</span><span class="params">(<span name="s1">s1: Shape</span>, <span name="s2">s2: Shape</span>)</span><span class="result"> extends (Shape, Shape) with Product</span> + </span> + </a></h4> + <p class="comment cmt">Pair of shapes</p> + </li><li name="sims.collision.PolyCircleCollision"> + <h4 class="signature"><a href="PolyCircleCollision.html"> + <span class="kind">class</span> + <span class="symbol"> + <span class="name">PolyCircleCollision</span><span class="params">(<span name="p">p: ConvexPolygon</span>, <span name="c">c: Circle</span>)</span><span class="result"> extends Collision with Product</span> + </span> + </a></h4> + <p class="comment cmt">Collision between a convex polygon and a circle</p> + </li><li name="sims.collision.PolyCollision"> + <h4 class="signature"><a href="PolyCollision.html"> + <span class="kind">class</span> + <span class="symbol"> + <span class="name">PolyCollision</span><span class="params">(<span name="p1">p1: ConvexPolygon</span>, <span name="p2">p2: ConvexPolygon</span>)</span><span class="result"> extends Collision with Product</span> + </span> + </a></h4> + <p class="comment cmt">Collision between two convex polygons</p> + </li></ol> + </div> + + <div class="members" id="values"> + <h3>Value Members</h3> + <ol><li name="sims.collision.Collision"> + <h4 class="signature"><a href="Collision$.html"> + <span class="kind">object</span> + <span class="symbol"> + <span class="name">Collision</span><span class="result"> extends AnyRef</span> + </span> + </a></h4> + + </li></ol> + </div> + + + + </div> + + </body> + </html>
\ No newline at end of file |