diff options
| author | Jakob Odersky <jodersky@gmail.com> | 2009-12-13 16:06:50 +0000 |
|---|---|---|
| committer | Jakob Odersky <jodersky@gmail.com> | 2009-12-13 16:06:50 +0000 |
| commit | 66d338aec5d632927fa561a68310c8931938e9e0 (patch) | |
| tree | 1e200fd94bb903772b007690da4e5d13fc46fb5b /doc/sims/dynamics | |
| parent | be2ee4dea92c5a4fc2329959d6e7272c50b221a6 (diff) | |
| download | sims-66d338aec5d632927fa561a68310c8931938e9e0.tar.gz sims-66d338aec5d632927fa561a68310c8931938e9e0.tar.bz2 sims-66d338aec5d632927fa561a68310c8931938e9e0.zip | |
Ported to scala 2.8.
Diffstat (limited to 'doc/sims/dynamics')
32 files changed, 5944 insertions, 6684 deletions
diff --git a/doc/sims/dynamics/Body$.html b/doc/sims/dynamics/Body$.html new file mode 100644 index 0000000..c9c6b49 --- /dev/null +++ b/doc/sims/dynamics/Body$.html @@ -0,0 +1,148 @@ +<?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.dynamics.Body</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">dynamics</a></p> + + <div id="definition"> + <img src="../../lib/object_big.png" /> + <h1>Body</h1> + </div> + + <h4 class="signature"> + <span class="kind">object</span> + <span class="symbol"> + <span class="name">Body</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="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/dynamics/Body$object.html b/doc/sims/dynamics/Body$object.html deleted file mode 100644 index fe5fec2..0000000 --- a/doc/sims/dynamics/Body$object.html +++ /dev/null @@ -1,75 +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 Body in sims.dynamics</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/dynamics$package.html" target="_self">sims.dynamics</a> - <br></br> - <span class="entity">object Body</span> - </div><hr></hr> - <div class="source"> - [source: <a href="" class="sims/dynamics/Body"><code>sims/dynamics/Body.scala</code></a>] - </div><hr></hr> - <a name="Body"></a><dl> - <dt> - - <code></code> - <code>object</code> - <em>Body</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="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> - - - - - - - - - <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/dynamics/Body.html b/doc/sims/dynamics/Body.html index 4bacab2..858116a 100644 --- a/doc/sims/dynamics/Body.html +++ b/doc/sims/dynamics/Body.html @@ -1,660 +1,490 @@ -<!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 Body in sims.dynamics</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/dynamics$package.html" target="_self">sims.dynamics</a> - <br></br> - <span class="entity">class Body</span> - </div><hr></hr> - <div class="source"> - [source: <a href="" class="sims/dynamics/Body"><code>sims/dynamics/Body.scala</code></a>] - </div><hr></hr> - <a name="Body"></a><dl> - <dt> - - <code></code> - <code>class</code> - <em>Body</em>(<em>shps</em> : <a href="../../sims/dynamics/Shape.html" target="_self">Shape</a>*) - </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 two dimensional rigid body is made out of shapes.</dd></dl> - <dl><dt style="margin:10px 0 0 20px;"> - <b>Parameters</b></dt><dd><code>shps - </code>shapes that belong to this body.</dd></dl> + <head> + <title>Scaladoc for sims.dynamics.Body</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">dynamics</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/dynamics/Body.html#angularVelocity" target="_self">angularVelocity</a></em> - : <a href="http://www.scala-lang.org/docu/files/api/scala/Double.html" target="_self">Double</a> - - <div>Angular velocity of this body.</div> - </td> - </tr> -<tr> - <td class="modifiers" valign="top"> - <code> var</code> - </td> - <td class="signature"> - <em><a href="../../sims/dynamics/Body.html#force" target="_self">force</a></em> - : <a href="../../sims/geometry/Vector2D.html" target="_self">Vector2D</a> - - <div>Resulting force on the COM of this body.</div> - </td> - </tr> -<tr> - <td class="modifiers" valign="top"> - <code> var</code> - </td> - <td class="signature"> - <em><a href="../../sims/dynamics/Body.html#linearVelocity" target="_self">linearVelocity</a></em> - : <a href="../../sims/geometry/Vector2D.html" target="_self">Vector2D</a> - - <div>Linear velocity of this body.</div> - </td> - </tr> -<tr> - <td class="modifiers" valign="top"> - <code> var</code> - </td> - <td class="signature"> - <em><a href="../../sims/dynamics/Body.html#monitor" target="_self">monitor</a></em> - : <a href="http://www.scala-lang.org/docu/files/api/scala/Boolean.html" target="_self">Boolean</a> - - <div>Flag for a world to monitor the properties of this body.</div> - </td> - </tr> -<tr> - <td class="modifiers" valign="top"> - <code> val</code> - </td> - <td class="signature"> - <em><a href="../../sims/dynamics/Body.html#shapes" target="_self">shapes</a></em> - : <a href="" target="contentFrame" class="scala/List">scala.List</a>[<a href="../../sims/dynamics/Shape.html" target="_self">Shape</a>] - - <div>Shapes that belong to this body.</div> - </td> - </tr> -<tr> - <td class="modifiers" valign="top"> - <code> var</code> - </td> - <td class="signature"> - <em><a href="../../sims/dynamics/Body.html#torque" target="_self">torque</a></em> - : <a href="http://www.scala-lang.org/docu/files/api/scala/Double.html" target="_self">Double</a> - - <div>Resulting torque on this body.</div> - </td> - </tr> -<tr> - <td class="modifiers" valign="top"> - <code> val</code> - </td> - <td class="signature"> - <em><a href="../../sims/dynamics/Body.html#uid" target="_self">uid</a></em> - : <a href="http://www.scala-lang.org/docu/files/api/scala/Int.html" target="_self">Int</a> - - <div>Unique identification number.</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/dynamics/Body.html#I" target="_self">I</a></em> - : <a href="http://www.scala-lang.org/docu/files/api/scala/Double.html" target="_self">Double</a> - - <div>Returns the moment of inertia for rotations about the COM of this body.
- It is calculated using the moments of inertia of this body's shapes and the parallel axis theorem.
- If the body is fixed, its moment of inertia is infinite (<code>Double.PositiveInfinity</code>).</div> - </td> - </tr> -<tr> - <td class="modifiers" valign="top"> - <code> def</code> - </td> - <td class="signature"> - <em><a href="../../sims/dynamics/Body.html#applyForce%28sims.geometry.Vector2D%2Csims.geometry.Vector2D%29" target="_self">applyForce</a></em> - (<em>force</em> : <a href="../../sims/geometry/Vector2D.html" target="_self">Vector2D</a>, <em>point</em> : <a href="../../sims/geometry/Vector2D.html" target="_self">Vector2D</a>) : <a href="http://www.scala-lang.org/docu/files/api/scala/Unit.html" target="_self">Unit</a> - - <div>Applies a force to a point on this body. Warning: the point is considered to be contained within this body.</div> - </td> - </tr> -<tr> - <td class="modifiers" valign="top"> - <code> def</code> - </td> - <td class="signature"> - <em><a href="../../sims/dynamics/Body.html#applyForce%28sims.geometry.Vector2D%29" target="_self">applyForce</a></em> - (<em>force</em> : <a href="../../sims/geometry/Vector2D.html" target="_self">Vector2D</a>) : <a href="http://www.scala-lang.org/docu/files/api/scala/Unit.html" target="_self">Unit</a> - - <div>Applies a force to the COM of this body.</div> - </td> - </tr> -<tr> - <td class="modifiers" valign="top"> - <code> def</code> - </td> - <td class="signature"> - <em><a href="../../sims/dynamics/Body.html#applyImpulse%28sims.geometry.Vector2D%29" target="_self">applyImpulse</a></em> - (<em>impulse</em> : <a href="../../sims/geometry/Vector2D.html" target="_self">Vector2D</a>) : <a href="http://www.scala-lang.org/docu/files/api/scala/Unit.html" target="_self">Unit</a> - - <div>Applies an impulse to the COM of this body.</div> - </td> - </tr> -<tr> - <td class="modifiers" valign="top"> - <code> def</code> - </td> - <td class="signature"> - <em><a href="../../sims/dynamics/Body.html#applyImpulse%28sims.geometry.Vector2D%2Csims.geometry.Vector2D%29" target="_self">applyImpulse</a></em> - (<em>impulse</em> : <a href="../../sims/geometry/Vector2D.html" target="_self">Vector2D</a>, <em>point</em> : <a href="../../sims/geometry/Vector2D.html" target="_self">Vector2D</a>) : <a href="http://www.scala-lang.org/docu/files/api/scala/Unit.html" target="_self">Unit</a> - - <div>Applies an impulse to a point on this body. Warning: the point is considered to be contained within this body.</div> - </td> - </tr> -<tr> - <td class="modifiers" valign="top"> - <code> def</code> - </td> - <td class="signature"> - <em><a href="../../sims/dynamics/Body.html#contains%28sims.geometry.Vector2D%29" target="_self">contains</a></em> - (<em>point</em> : <a href="../../sims/geometry/Vector2D.html" target="_self">Vector2D</a>) : <a href="http://www.scala-lang.org/docu/files/api/scala/Boolean.html" target="_self">Boolean</a> - - <div>Checks if the point <code>point</code> is contained in this body.</div> - </td> - </tr> -<tr> - <td class="modifiers" valign="top"> - <code> def</code> - </td> - <td class="signature"> - <em><a href="../../sims/dynamics/Body.html#fixed" target="_self">fixed</a></em> - : <a href="http://www.scala-lang.org/docu/files/api/scala/Boolean.html" target="_self">Boolean</a> - - <div>Returns whether this body is fixed or not.</div> - </td> - </tr> -<tr> - <td class="modifiers" valign="top"> - <code> def</code> - </td> - <td class="signature"> - <em><a href="../../sims/dynamics/Body.html#fixed_%3D%28Boolean%29" target="_self">fixed_=</a></em> - (<em>value</em> : <a href="http://www.scala-lang.org/docu/files/api/scala/Boolean.html" target="_self">Boolean</a>) : <a href="http://www.scala-lang.org/docu/files/api/scala/Unit.html" target="_self">Unit</a> - - <div>Fixes or frees this body. By fixing, linear and angular velocities are set to zero.</div> - </td> - </tr> -<tr> - <td class="modifiers" valign="top"> - <code> def</code> - </td> - <td class="signature"> - <em><a href="../../sims/dynamics/Body.html#mass" target="_self">mass</a></em> - : <a href="http://www.scala-lang.org/docu/files/api/scala/Double.html" target="_self">Double</a> - - <div>Returns the mass of this body. If the body is free, its mass is the sum of the masses of its shapes.
- If the body is fixed, its mass is infinite (<code>Double.PositiveInfinity</code>).</div> - </td> - </tr> -<tr> - <td class="modifiers" valign="top"> - <code> def</code> - </td> - <td class="signature"> - <em><a href="../../sims/dynamics/Body.html#pos" target="_self">pos</a></em> - : <a href="../../sims/geometry/Vector2D.html" target="_self">Vector2D</a> - - <div>Returns the position of this body. The position is equivalent to the center of mass.</div> - </td> - </tr> -<tr> - <td class="modifiers" valign="top"> - <code> def</code> - </td> - <td class="signature"> - <em><a href="../../sims/dynamics/Body.html#pos_%3D%28sims.geometry.Vector2D%29" target="_self">pos_=</a></em> - (<em>newPos</em> : <a href="../../sims/geometry/Vector2D.html" target="_self">Vector2D</a>) : <a href="http://www.scala-lang.org/docu/files/api/scala/Unit.html" target="_self">Unit</a> - - <div>Sets the position of this body. By doing so all its shapes are translated.</div> - </td> - </tr> -<tr> - <td class="modifiers" valign="top"> - <code> def</code> - </td> - <td class="signature"> - <em><a href="../../sims/dynamics/Body.html#rotation" target="_self">rotation</a></em> - : <a href="http://www.scala-lang.org/docu/files/api/scala/Double.html" target="_self">Double</a> - - <div>Returns the current rotation of this body.</div> - </td> - </tr> -<tr> - <td class="modifiers" valign="top"> - <code> def</code> - </td> - <td class="signature"> - <em><a href="../../sims/dynamics/Body.html#rotation_%3D%28Double%29" target="_self">rotation_=</a></em> - (<em>newRotation</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>Sets the rotation of this body. Position and rotation of shapes are modified accordingly.</div> - </td> - </tr> -<tr> - <td class="modifiers" valign="top"> - <code>override def</code> - </td> - <td class="signature"> - <em><a href="../../sims/dynamics/Body.html#toString%28%29" target="_self">toString</a></em> - : <a href="" target="contentFrame" class="java/lang/String">java.lang.String</a> - - <div>Returns a string representation of the object.</div> - </td> - </tr> -<tr> - <td class="modifiers" valign="top"> - <code> def</code> - </td> - <td class="signature"> - <em><a href="../../sims/dynamics/Body.html#velocityOfPoint%28sims.geometry.Vector2D%29" target="_self">velocityOfPoint</a></em> - (<em>point</em> : <a href="../../sims/geometry/Vector2D.html" target="_self">Vector2D</a>) : <a href="../../sims/geometry/Vector2D.html" target="_self">Vector2D</a> - - <div>Linear velocity of the given point on this body (in world coordinates).</div> - </td> - </tr> -<tr> - <td class="modifiers" valign="top"> - <code> def</code> - </td> - <td class="signature"> - <em><a href="../../sims/dynamics/Body.html#%7E%28sims.dynamics.Body%29" target="_self">~</a></em> - (<em>b</em> : <a href="../../sims/dynamics/Body.html" target="_self">Body</a>) : <a href="../../sims/dynamics/Body.html" target="_self">Body</a> - - <div>Creates a new body containing this body's shapes and the shapes of another body <code>b</code>.</div> - </td> - </tr> -<tr> - <td class="modifiers" valign="top"> - <code> def</code> - </td> - <td class="signature"> - <em><a href="../../sims/dynamics/Body.html#%7E%28sims.dynamics.Shape%29" target="_self">~</a></em> - (<em>s</em> : <a href="../../sims/dynamics/Shape.html" target="_self">Shape</a>) : <a href="../../sims/dynamics/Body.html" target="_self">Body</a> - - <div>Creates a new body containing this body's shapes and the shape <code>s</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#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>Body</h1> + </div> + <h4 class="signature"> + <span class="kind">class</span> + <span class="symbol"> + <span class="name">Body</span><span class="result"> extends AnyRef</span> + </span> + </h4> + <div class="fullcomment" id="comment"> + <div class="comment cmt"><p>A two dimensional rigid body is made out of shapes.</p></div> - -<table summary="" cellpadding="3" class="member-detail"> - <tr><td class="title">Value Details</td></tr> - </table><div><a name="uid"></a><dl> - <dt> - - <code></code> - <code>val</code> - <em>uid</em> : <a href="http://www.scala-lang.org/docu/files/api/scala/Int.html" target="_self">Int</a> - </dt> - <dd></dd> - </dl> - <dl><dd>Unique identification number.</dd></dl> - <dl></dl> - <hr></hr> -<a name="shapes"></a><dl> - <dt> - - <code></code> - <code>val</code> - <em>shapes</em> : <a href="" target="contentFrame" class="scala/List">scala.List</a>[<a href="../../sims/dynamics/Shape.html" target="_self">Shape</a>] - </dt> - <dd></dd> - </dl> - <dl><dd>Shapes that belong to this body.</dd></dl> - <dl></dl> - <hr></hr> -<a name="monitor"></a><dl> - <dt> - - <code></code> - <code>var</code> - <em>monitor</em> : <a href="http://www.scala-lang.org/docu/files/api/scala/Boolean.html" target="_self">Boolean</a> - </dt> - <dd></dd> - </dl> - <dl><dd>Flag for a world to monitor the properties of this body.</dd></dl> - <dl><dt style="margin:10px 0 0 20px;"> - <b>See Also</b></dt><dd><a href="../../sims/dynamics/World.html#monitors" target="_self">World#monitors</a></dd></dl> - <hr></hr> -<a name="linearVelocity"></a><dl> - <dt> - - <code></code> - <code>var</code> - <em>linearVelocity</em> : <a href="../../sims/geometry/Vector2D.html" target="_self">Vector2D</a> - </dt> - <dd></dd> - </dl> - <dl><dd>Linear velocity of this body.</dd></dl> - <dl></dl> - <hr></hr> -<a name="angularVelocity"></a><dl> - <dt> - - <code></code> - <code>var</code> - <em>angularVelocity</em> : <a href="http://www.scala-lang.org/docu/files/api/scala/Double.html" target="_self">Double</a> - </dt> - <dd></dd> - </dl> - <dl><dd>Angular velocity of this body.</dd></dl> - <dl></dl> - <hr></hr> -<a name="force"></a><dl> - <dt> - - <code></code> - <code>var</code> - <em>force</em> : <a href="../../sims/geometry/Vector2D.html" target="_self">Vector2D</a> - </dt> - <dd></dd> - </dl> - <dl><dd>Resulting force on the COM of this body.</dd></dl> - <dl></dl> - <hr></hr> -<a name="torque"></a><dl> - <dt> - - <code></code> - <code>var</code> - <em>torque</em> : <a href="http://www.scala-lang.org/docu/files/api/scala/Double.html" target="_self">Double</a> - </dt> - <dd></dd> - </dl> - <dl><dd>Resulting torque on this body.</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="fixed"></a><dl> - <dt> - - <code></code> - <code>def</code> - <em>fixed</em> : <a href="http://www.scala-lang.org/docu/files/api/scala/Boolean.html" target="_self">Boolean</a> - </dt> - <dd></dd> - </dl> - <dl><dd>Returns whether this body is fixed or not.</dd></dl> - <dl></dl> - <hr></hr> -<a name="fixed_%3D%28Boolean%29"></a><dl> - <dt> - - <code></code> - <code>def</code> - <em>fixed_=</em>(<em>value</em> : <a href="http://www.scala-lang.org/docu/files/api/scala/Boolean.html" target="_self">Boolean</a>) : <a href="http://www.scala-lang.org/docu/files/api/scala/Unit.html" target="_self">Unit</a> - </dt> - <dd></dd> - </dl> - <dl><dd>Fixes or frees this body. By fixing, linear and angular velocities are set to zero.</dd></dl> - <dl></dl> - <hr></hr> -<a name="pos"></a><dl> - <dt> - - <code></code> - <code>def</code> - <em>pos</em> : <a href="../../sims/geometry/Vector2D.html" target="_self">Vector2D</a> - </dt> - <dd></dd> - </dl> - <dl><dd>Returns the position of this body. The position is equivalent to the center of mass.</dd></dl> - <dl><dt style="margin:10px 0 0 20px;"> - <b>Returns</b></dt><dd>position of this body</dd></dl> - <hr></hr> -<a name="pos_%3D%28sims.geometry.Vector2D%29"></a><dl> - <dt> - - <code></code> - <code>def</code> - <em>pos_=</em>(<em>newPos</em> : <a href="../../sims/geometry/Vector2D.html" target="_self">Vector2D</a>) : <a href="http://www.scala-lang.org/docu/files/api/scala/Unit.html" target="_self">Unit</a> - </dt> - <dd></dd> - </dl> - <dl><dd>Sets the position of this body. By doing so all its shapes are translated.</dd></dl> - <dl><dt style="margin:10px 0 0 20px;"> - <b>Parameters</b></dt><dd><code>newPos - </code>new position</dd></dl> - <hr></hr> -<a name="rotation"></a><dl> - <dt> - - <code></code> - <code>def</code> - <em>rotation</em> : <a href="http://www.scala-lang.org/docu/files/api/scala/Double.html" target="_self">Double</a> - </dt> - <dd></dd> - </dl> - <dl><dd>Returns the current rotation of this body.</dd></dl> - <dl></dl> - <hr></hr> -<a name="rotation_%3D%28Double%29"></a><dl> - <dt> - - <code></code> - <code>def</code> - <em>rotation_=</em>(<em>newRotation</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>Sets the rotation of this body. Position and rotation of shapes are modified accordingly.</dd></dl> - <dl><dt style="margin:10px 0 0 20px;"> - <b>Parameters</b></dt><dd><code>r - </code>new rotation</dd></dl> - <hr></hr> -<a name="velocityOfPoint%28sims.geometry.Vector2D%29"></a><dl> - <dt> - - <code></code> - <code>def</code> - <em>velocityOfPoint</em>(<em>point</em> : <a href="../../sims/geometry/Vector2D.html" target="_self">Vector2D</a>) : <a href="../../sims/geometry/Vector2D.html" target="_self">Vector2D</a> - </dt> - <dd></dd> - </dl> - <dl><dd>Linear velocity of the given point on this body (in world coordinates).</dd></dl> - <dl></dl> - <hr></hr> -<a name="mass"></a><dl> - <dt> - - <code></code> - <code>def</code> - <em>mass</em> : <a href="http://www.scala-lang.org/docu/files/api/scala/Double.html" target="_self">Double</a> - </dt> - <dd></dd> - </dl> - <dl><dd>Returns the mass of this body. If the body is free, its mass is the sum of the masses of its shapes.
- If the body is fixed, its mass is infinite (<code>Double.PositiveInfinity</code>).</dd></dl> - <dl><dt style="margin:10px 0 0 20px;"> - <b>Returns</b></dt><dd>this body's mass</dd></dl> - <hr></hr> -<a name="I"></a><dl> - <dt> - - <code></code> - <code>def</code> - <em>I</em> : <a href="http://www.scala-lang.org/docu/files/api/scala/Double.html" target="_self">Double</a> - </dt> - <dd></dd> - </dl> - <dl><dd>Returns the moment of inertia for rotations about the COM of this body.
- It is calculated using the moments of inertia of this body's shapes and the parallel axis theorem.
- If the body is fixed, its moment of inertia is infinite (<code>Double.PositiveInfinity</code>).</dd></dl> - <dl><dt style="margin:10px 0 0 20px;"> - <b>Returns</b></dt><dd>moment of inertia for rotations about the COM of this body</dd></dl> - <hr></hr> -<a name="applyForce%28sims.geometry.Vector2D%29"></a><dl> - <dt> - - <code></code> - <code>def</code> - <em>applyForce</em>(<em>force</em> : <a href="../../sims/geometry/Vector2D.html" target="_self">Vector2D</a>) : <a href="http://www.scala-lang.org/docu/files/api/scala/Unit.html" target="_self">Unit</a> - </dt> - <dd></dd> - </dl> - <dl><dd>Applies a force to the COM of this body.</dd></dl> - <dl><dt style="margin:10px 0 0 20px;"> - <b>Parameters</b></dt><dd><code>force - </code>applied force</dd></dl> - <hr></hr> -<a name="applyForce%28sims.geometry.Vector2D%2Csims.geometry.Vector2D%29"></a><dl> - <dt> - - <code></code> - <code>def</code> - <em>applyForce</em>(<em>force</em> : <a href="../../sims/geometry/Vector2D.html" target="_self">Vector2D</a>, <em>point</em> : <a href="../../sims/geometry/Vector2D.html" target="_self">Vector2D</a>) : <a href="http://www.scala-lang.org/docu/files/api/scala/Unit.html" target="_self">Unit</a> - </dt> - <dd></dd> - </dl> - <dl><dd>Applies a force to a point on this body. Warning: the point is considered to be contained within this body.</dd></dl> - <dl><dt style="margin:10px 0 0 20px;"> - <b>Parameters</b></dt><dd><code>force - </code>applied force</dd><dd><code>point - </code>position vector of the point (in world coordinates)</dd></dl> - <hr></hr> -<a name="applyImpulse%28sims.geometry.Vector2D%29"></a><dl> - <dt> - - <code></code> - <code>def</code> - <em>applyImpulse</em>(<em>impulse</em> : <a href="../../sims/geometry/Vector2D.html" target="_self">Vector2D</a>) : <a href="http://www.scala-lang.org/docu/files/api/scala/Unit.html" target="_self">Unit</a> - </dt> - <dd></dd> - </dl> - <dl><dd>Applies an impulse to the COM of this body.</dd></dl> - <dl><dt style="margin:10px 0 0 20px;"> - <b>Parameters</b></dt><dd><code>impulse - </code>applied impulse</dd></dl> - <hr></hr> -<a name="applyImpulse%28sims.geometry.Vector2D%2Csims.geometry.Vector2D%29"></a><dl> - <dt> - - <code></code> - <code>def</code> - <em>applyImpulse</em>(<em>impulse</em> : <a href="../../sims/geometry/Vector2D.html" target="_self">Vector2D</a>, <em>point</em> : <a href="../../sims/geometry/Vector2D.html" target="_self">Vector2D</a>) : <a href="http://www.scala-lang.org/docu/files/api/scala/Unit.html" target="_self">Unit</a> - </dt> - <dd></dd> - </dl> - <dl><dd>Applies an impulse to a point on this body. Warning: the point is considered to be contained within this body.</dd></dl> - <dl><dt style="margin:10px 0 0 20px;"> - <b>Parameters</b></dt><dd><code>impulse - </code>applied impulse</dd><dd><code>point - </code>position vector of the point (in world coordinates)</dd></dl> - <hr></hr> -<a name="contains%28sims.geometry.Vector2D%29"></a><dl> - <dt> - - <code></code> - <code>def</code> - <em>contains</em>(<em>point</em> : <a href="../../sims/geometry/Vector2D.html" target="_self">Vector2D</a>) : <a href="http://www.scala-lang.org/docu/files/api/scala/Boolean.html" target="_self">Boolean</a> - </dt> - <dd></dd> - </dl> - <dl><dd>Checks if the point <code>point</code> is contained in this body.</dd></dl> - <dl></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="%7E%28sims.dynamics.Shape%29"></a><dl> - <dt> - - <code></code> - <code>def</code> - <em>~</em>(<em>s</em> : <a href="../../sims/dynamics/Shape.html" target="_self">Shape</a>) : <a href="../../sims/dynamics/Body.html" target="_self">Body</a> - </dt> - <dd></dd> - </dl> - <dl><dd>Creates a new body containing this body's shapes and the shape <code>s</code>.</dd></dl> - <dl><dt style="margin:10px 0 0 20px;"> - <b>Parameters</b></dt><dd><code>s - </code>new shape</dd><dt style="margin:10px 0 0 20px;"> - <b>Returns</b></dt><dd>new body</dd></dl> - <hr></hr> -<a name="%7E%28sims.dynamics.Body%29"></a><dl> - <dt> + + + + </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.dynamics.Body#I"> + <h4 class="signature"> + <span class="kind">def</span> + <span class="symbol"> + <span class="name">I</span><span class="result">: <span class="extype" name="scala.Double">Double</span></span> + </span> + </h4> + <p class="shortcomment cmt">Returns the moment of inertia for rotations about the COM of this body</p><div class="fullcomment"> + <div class="comment cmt"><p>Returns the moment of inertia for rotations about the COM of this body. +It is calculated using the moments of inertia of this body's shapes and the parallel axis theorem. +If the body is fixed, its moment of inertia is infinite (<code>Double.PositiveInfinity</code>).</p></div> + + + + + </div> + </li><li name="sims.dynamics.Body#angularVelocity"> + <h4 class="signature"> + <span class="kind">var</span> + <span class="symbol"> + <span class="name">angularVelocity</span><span class="result">: <span class="extype" name="scala.Double">Double</span></span> + </span> + </h4> + <p class="shortcomment cmt">Angular velocity of this body</p><div class="fullcomment"> + <div class="comment cmt"><p>Angular velocity of this body.</p></div> + + + + + </div> + </li><li name="sims.dynamics.Body#applyForce"> + <h4 class="signature"> + <span class="kind">def</span> + <span class="symbol"> + <span class="name">applyForce</span><span class="params">(<span name="force">force: <a href="../geometry/Vector2D.html" class="extype" name="sims.geometry.Vector2D">Vector2D</a></span>, <span name="point">point: <a href="../geometry/Vector2D.html" class="extype" name="sims.geometry.Vector2D">Vector2D</a></span>)</span><span class="result">: <span class="extype" name="scala.Unit">Unit</span></span> + </span> + </h4> + <p class="shortcomment cmt">Applies a force to a point on this body</p><div class="fullcomment"> + <div class="comment cmt"><p>Applies a force to a point on this body. Warning: the point is considered to be contained within this body.</p></div> + <dl class="paramcmts block"><dt class="param">force</dt><dd class="cmt"><p>applied force</p></dd><dt class="param">point</dt><dd class="cmt"><p>position vector of the point (in world coordinates)</p></dd></dl> + + + + </div> + </li><li name="sims.dynamics.Body#applyForce"> + <h4 class="signature"> + <span class="kind">def</span> + <span class="symbol"> + <span class="name">applyForce</span><span class="params">(<span name="force">force: <a href="../geometry/Vector2D.html" class="extype" name="sims.geometry.Vector2D">Vector2D</a></span>)</span><span class="result">: <span class="extype" name="scala.Unit">Unit</span></span> + </span> + </h4> + <p class="shortcomment cmt">Applies a force to the COM of this body</p><div class="fullcomment"> + <div class="comment cmt"><p>Applies a force to the COM of this body.</p></div> + <dl class="paramcmts block"><dt class="param">force</dt><dd class="cmt"><p>applied force</p></dd></dl> + + + + </div> + </li><li name="sims.dynamics.Body#applyImpulse"> + <h4 class="signature"> + <span class="kind">def</span> + <span class="symbol"> + <span class="name">applyImpulse</span><span class="params">(<span name="impulse">impulse: <a href="../geometry/Vector2D.html" class="extype" name="sims.geometry.Vector2D">Vector2D</a></span>, <span name="point">point: <a href="../geometry/Vector2D.html" class="extype" name="sims.geometry.Vector2D">Vector2D</a></span>)</span><span class="result">: <span class="extype" name="scala.Unit">Unit</span></span> + </span> + </h4> + <p class="shortcomment cmt">Applies an impulse to a point on this body</p><div class="fullcomment"> + <div class="comment cmt"><p>Applies an impulse to a point on this body. Warning: the point is considered to be contained within this body.</p></div> + <dl class="paramcmts block"><dt class="param">impulse</dt><dd class="cmt"><p>applied impulse</p></dd><dt class="param">point</dt><dd class="cmt"><p>position vector of the point (in world coordinates)</p></dd></dl> + + + + </div> + </li><li name="sims.dynamics.Body#applyImpulse"> + <h4 class="signature"> + <span class="kind">def</span> + <span class="symbol"> + <span class="name">applyImpulse</span><span class="params">(<span name="impulse">impulse: <a href="../geometry/Vector2D.html" class="extype" name="sims.geometry.Vector2D">Vector2D</a></span>)</span><span class="result">: <span class="extype" name="scala.Unit">Unit</span></span> + </span> + </h4> + <p class="shortcomment cmt">Applies an impulse to the COM of this body</p><div class="fullcomment"> + <div class="comment cmt"><p>Applies an impulse to the COM of this body.</p></div> + <dl class="paramcmts block"><dt class="param">impulse</dt><dd class="cmt"><p>applied impulse</p></dd></dl> + + + + </div> + </li><li name="sims.dynamics.Body#contains"> + <h4 class="signature"> + <span class="kind">def</span> + <span class="symbol"> + <span class="name">contains</span><span class="params">(<span name="point">point: <a href="../geometry/Vector2D.html" class="extype" name="sims.geometry.Vector2D">Vector2D</a></span>)</span><span class="result">: <span class="extype" name="scala.Boolean">Boolean</span></span> + </span> + </h4> + <p class="shortcomment cmt">Checks if the point <code>point</code> is contained in this body</p><div class="fullcomment"> + <div class="comment cmt"><p>Checks if the point <code>point</code> is contained in this body.</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.dynamics.Body#fixed"> + <h4 class="signature"> + <span class="kind">def</span> + <span class="symbol"> + <span class="name">fixed</span><span class="result">: <span class="extype" name="scala.Boolean">Boolean</span></span> + </span> + </h4> + <p class="shortcomment cmt">Returns whether this body is fixed or not</p><div class="fullcomment"> + <div class="comment cmt"><p>Returns whether this body is fixed or not.</p></div> + + + + + </div> + </li><li name="sims.dynamics.Body#fixed_="> + <h4 class="signature"> + <span class="kind">def</span> + <span class="symbol"> + <span class="name">fixed_=</span><span class="params">(<span name="value">value: <span class="extype" name="scala.Boolean">Boolean</span></span>)</span><span class="result">: <span class="extype" name="scala.Unit">Unit</span></span> + </span> + </h4> + <p class="shortcomment cmt">Fixes or frees this body</p><div class="fullcomment"> + <div class="comment cmt"><p>Fixes or frees this body. By fixing, linear and angular velocities are set to zero.</p></div> + + + + + </div> + </li><li name="sims.dynamics.Body#force"> + <h4 class="signature"> + <span class="kind">var</span> + <span class="symbol"> + <span class="name">force</span><span class="result">: <a href="../geometry/Vector2D.html" class="extype" name="sims.geometry.Vector2D">Vector2D</a></span> + </span> + </h4> + <p class="shortcomment cmt">Resulting force on the COM of this body</p><div class="fullcomment"> + <div class="comment cmt"><p>Resulting force on the COM of this body.</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.dynamics.Body#linearVelocity"> + <h4 class="signature"> + <span class="kind">var</span> + <span class="symbol"> + <span class="name">linearVelocity</span><span class="result">: <a href="../geometry/Vector2D.html" class="extype" name="sims.geometry.Vector2D">Vector2D</a></span> + </span> + </h4> + <p class="shortcomment cmt">Linear velocity of this body</p><div class="fullcomment"> + <div class="comment cmt"><p>Linear velocity of this body.</p></div> + + + + + </div> + </li><li name="sims.dynamics.Body#mass"> + <h4 class="signature"> + <span class="kind">def</span> + <span class="symbol"> + <span class="name">mass</span><span class="result">: <span class="extype" name="scala.Double">Double</span></span> + </span> + </h4> + <p class="shortcomment cmt">Returns the mass of this body</p><div class="fullcomment"> + <div class="comment cmt"><p>Returns the mass of this body. If the body is free, its mass is the sum of the masses of its shapes. +If the body is fixed, its mass is infinite (<code>Double.PositiveInfinity</code>).</p></div> + + + + + </div> + </li><li name="sims.dynamics.Body#monitor"> + <h4 class="signature"> + <span class="kind">var</span> + <span class="symbol"> + <span class="name">monitor</span><span class="result">: <span class="extype" name="scala.Boolean">Boolean</span></span> + </span> + </h4> + <p class="shortcomment cmt">Flag for a world to monitor the properties of this body</p><div class="fullcomment"> + <div class="comment cmt"><p>Flag for a world to monitor the properties of this body.</p></div> + + + + + </div> + </li><li name="sims.dynamics.Body#pos"> + <h4 class="signature"> + <span class="kind">def</span> + <span class="symbol"> + <span class="name">pos</span><span class="result">: <a href="../geometry/Vector2D.html" class="extype" name="sims.geometry.Vector2D">Vector2D</a></span> + </span> + </h4> + <p class="shortcomment cmt">Returns the position of this body</p><div class="fullcomment"> + <div class="comment cmt"><p>Returns the position of this body. The position is equivalent to the center of mass.</p></div> + + + + + </div> + </li><li name="sims.dynamics.Body#pos_="> + <h4 class="signature"> + <span class="kind">def</span> + <span class="symbol"> + <span class="name">pos_=</span><span class="params">(<span name="newPos">newPos: <a href="../geometry/Vector2D.html" class="extype" name="sims.geometry.Vector2D">Vector2D</a></span>)</span><span class="result">: <span class="extype" name="scala.Unit">Unit</span></span> + </span> + </h4> + <p class="shortcomment cmt">Sets the position of this body</p><div class="fullcomment"> + <div class="comment cmt"><p>Sets the position of this body. By doing so all its shapes are translated.</p></div> + <dl class="paramcmts block"><dt class="param">newPos</dt><dd class="cmt"><p>new position</p></dd></dl> + + + + </div> + </li><li name="sims.dynamics.Body#rotation"> + <h4 class="signature"> + <span class="kind">def</span> + <span class="symbol"> + <span class="name">rotation</span><span class="result">: <span class="extype" name="scala.Double">Double</span></span> + </span> + </h4> + <p class="shortcomment cmt">Returns the current rotation of this body</p><div class="fullcomment"> + <div class="comment cmt"><p>Returns the current rotation of this body.</p></div> + + + + + </div> + </li><li name="sims.dynamics.Body#rotation_="> + <h4 class="signature"> + <span class="kind">def</span> + <span class="symbol"> + <span class="name">rotation_=</span><span class="params">(<span name="newRotation">newRotation: <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">Sets the rotation of this body</p><div class="fullcomment"> + <div class="comment cmt"><p>Sets the rotation of this body. Position and rotation of shapes are modified accordingly.</p></div> + + + + + </div> + </li><li name="sims.dynamics.Body#shapes"> + <h4 class="signature"> + <span class="kind">val</span> + <span class="symbol"> + <span class="name">shapes</span><span class="result">: <span class="extype" name="scala.collection.immutable.List">List</span>[<a href="Shape.html" class="extype" name="sims.dynamics.Shape">Shape</a>]</span> + </span> + </h4> + <p class="shortcomment cmt">Shapes that belong to this body</p><div class="fullcomment"> + <div class="comment cmt"><p>Shapes that belong to this body.</p></div> + + + + + </div> + </li><li name="sims.dynamics.Body#toString"> + <h4 class="signature"> + <span class="kind">def</span> + <span class="symbol"> + <span class="name">toString</span><span class="params">()</span><span class="result">: <span class="extype" name="java.lang.String">String</span></span> + </span> + </h4> + <p class="shortcomment cmt">Returns a string representation of the object</p><div class="fullcomment"> + <div class="comment cmt"><p>Returns a string representation of the object. +<p> +The default representation is platform dependent. +</p></div> + + + + + </div> + </li><li name="sims.dynamics.Body#torque"> + <h4 class="signature"> + <span class="kind">var</span> + <span class="symbol"> + <span class="name">torque</span><span class="result">: <span class="extype" name="scala.Double">Double</span></span> + </span> + </h4> + <p class="shortcomment cmt">Resulting torque on this body</p><div class="fullcomment"> + <div class="comment cmt"><p>Resulting torque on this body.</p></div> + + + + + </div> + </li><li name="sims.dynamics.Body#uid"> + <h4 class="signature"> + <span class="kind">val</span> + <span class="symbol"> + <span class="name">uid</span><span class="result">: <span class="extype" name="scala.Int">Int</span></span> + </span> + </h4> + <p class="shortcomment cmt">Unique identification number</p><div class="fullcomment"> + <div class="comment cmt"><p>Unique identification number.</p></div> + + + + + </div> + </li><li name="sims.dynamics.Body#velocityOfPoint"> + <h4 class="signature"> + <span class="kind">def</span> + <span class="symbol"> + <span class="name">velocityOfPoint</span><span class="params">(<span name="point">point: <a href="../geometry/Vector2D.html" class="extype" name="sims.geometry.Vector2D">Vector2D</a></span>)</span><span class="result">: <a href="../geometry/Vector2D.html" class="extype" name="sims.geometry.Vector2D">Vector2D</a></span> + </span> + </h4> + <p class="shortcomment cmt">Linear velocity of the given point on this body (in world coordinates)</p><div class="fullcomment"> + <div class="comment cmt"><p>Linear velocity of the given point on this body (in world coordinates).</p></div> + + + + + </div> + </li><li name="sims.dynamics.Body#~"> + <h4 class="signature"> + <span class="kind">def</span> + <span class="symbol"> + <span class="name">~</span><span class="params">(<span name="b">b: <a href="" class="extype" name="sims.dynamics.Body">Body</a></span>)</span><span class="result">: <a href="" class="extype" name="sims.dynamics.Body">Body</a></span> + </span> + </h4> + <p class="shortcomment cmt">Creates a new body containing this body's shapes and the shapes of another body <code>b</code></p><div class="fullcomment"> + <div class="comment cmt"><p>Creates a new body containing this body's shapes and the shapes of another body <code>b</code>.</p></div> + <dl class="paramcmts block"><dt class="param">b</dt><dd class="cmt"><p>body with extra shapes</p></dd><dt>returns</dt><dd class="cmt"><p>new body</p></dd></dl> + + + + </div> + </li><li name="sims.dynamics.Body#~"> + <h4 class="signature"> + <span class="kind">def</span> + <span class="symbol"> + <span class="name">~</span><span class="params">(<span name="s">s: <a href="Shape.html" class="extype" name="sims.dynamics.Shape">Shape</a></span>)</span><span class="result">: <a href="" class="extype" name="sims.dynamics.Body">Body</a></span> + </span> + </h4> + <p class="shortcomment cmt">Creates a new body containing this body's shapes and the shape <code>s</code></p><div class="fullcomment"> + <div class="comment cmt"><p>Creates a new body containing this body's shapes and the shape <code>s</code>.</p></div> + <dl class="paramcmts block"><dt class="param">s</dt><dd class="cmt"><p>new shape</p></dd><dt>returns</dt><dd class="cmt"><p>new body</p></dd></dl> + + + + </div> + </li></ol> + </div> + + <div class="members" id="constructors"> + <h3>Instance constructors</h3> + <ol><li name="sims.dynamics.Body#this"> + <h4 class="signature"> + <span class="kind">new</span> + <span class="symbol"> + <span class="name">Body</span><span class="params">(<span name="shps">shps: <a href="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">Body</span><span class="params">()</span> + </span> + </h4> + + </li></ol> + </div> - <code></code> - <code>def</code> - <em>~</em>(<em>b</em> : <a href="../../sims/dynamics/Body.html" target="_self">Body</a>) : <a href="../../sims/dynamics/Body.html" target="_self">Body</a> - </dt> - <dd></dd> - </dl> - <dl><dd>Creates a new body containing this body's shapes and the shapes of another body <code>b</code>.</dd></dl> - <dl><dt style="margin:10px 0 0 20px;"> - <b>Parameters</b></dt><dd><code>b - </code>body with extra shapes</dd><dt style="margin:10px 0 0 20px;"> - <b>Returns</b></dt><dd>new body</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/dynamics/Circle$object.html b/doc/sims/dynamics/Circle$object.html deleted file mode 100644 index 086b684..0000000 --- a/doc/sims/dynamics/Circle$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 Circle in sims.dynamics</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/dynamics$package.html" target="_self">sims.dynamics</a> - <br></br> - <span class="entity">object Circle</span> - </div><hr></hr> - <div class="source"> - [source: <a href="" class="sims/dynamics/Circle"><code>sims/dynamics/Circle.scala</code></a>] - </div><hr></hr> - <a name="Circle"></a><dl> - <dt> - - <code></code> - <code>object</code> - <em>Circle</em> - </dt> - <dd><code> extends </code>(<a href="http://www.scala-lang.org/docu/files/api/scala/Double.html" target="_self">Double</a>, <a href="http://www.scala-lang.org/docu/files/api/scala/Double.html" target="_self">Double</a>) => <a href="../../sims/dynamics/Circle.html" target="_self">Circle</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/dynamics/Circle.html b/doc/sims/dynamics/Circle.html index f5a1655..47526f7 100644 --- a/doc/sims/dynamics/Circle.html +++ b/doc/sims/dynamics/Circle.html @@ -1,454 +1,530 @@ -<!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 Circle in sims.dynamics</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.dynamics.Circle</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/dynamics$package.html" target="_self">sims.dynamics</a> - <br></br> - <span class="entity">class Circle</span> - </div><hr></hr> - <div class="source"> - [source: <a href="" class="sims/dynamics/Circle"><code>sims/dynamics/Circle.scala</code></a>] - </div><hr></hr> - <a name="Circle"></a><dl> - <dt> - - <code>case</code> - <code>class</code> - <em>Circle</em>(<code>val </code><em>radius</em> : <a href="http://www.scala-lang.org/docu/files/api/scala/Double.html" target="_self">Double</a>, <code>val </code><em>density</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="../../sims/dynamics/Shape.html" target="_self">Shape</a><code> with </code><a href="" target="contentFrame" class="scala/Product">scala.Product</a></dd> - </dl> - <dl><dd>A circle.</dd></dl> - <dl><dt style="margin:10px 0 0 20px;"> - <b>Parameters</b></dt><dd><code>radius - </code>radius of this circle</dd><dd><code>density - </code>density of this circle</dd></dl> - <dl> - <dt style="margin:10px 0 0 20px;"><b>Direct Known Subclasses:</b></dt> - <dd><a href="../../graphyx/graphics/GraphicalCircle.html" target="_self">GraphicalCircle</a></dd> - </dl><hr></hr> + <body class="type"> + <p id="owner"><a href="../package.html">sims</a>.<a href="package.html">dynamics</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/dynamics/Circle.html#I" target="_self">I</a></em> - : <a href="http://www.scala-lang.org/docu/files/api/scala/Double.html" target="_self">Double</a> - - <div>Moment of inertia for a rotation about this shape's COM.</div> - </td> - </tr> -<tr> - <td class="modifiers" valign="top"> - <code> val</code> - </td> - <td class="signature"> - <em><a href="../../sims/dynamics/Circle.html#volume" target="_self">volume</a></em> - : <a href="http://www.scala-lang.org/docu/files/api/scala/Double.html" target="_self">Double</a> - - <div>Volume. The volume is actually equivalent to this shape's area (SiMS is in 2D)
- and is used with this shape's density to calculate its mass.</div> - </td> - </tr> - </table><table summary="" cellpadding="3" class="inherited"> - <tr><td class="title" colspan="2"> - Values and Variables inherited from <a href="../../sims/dynamics/Shape.html" target="_self">Shape</a> - </td></tr> - <tr><td class="signature" colspan="2"> - <a href="../../sims/dynamics/Shape.html#uid" target="_self">uid</a>, <a href="../../sims/dynamics/Shape.html#collidable" target="_self">collidable</a>, <a href="../../sims/dynamics/Shape.html#restitution" target="_self">restitution</a>, <a href="../../sims/dynamics/Shape.html#friction" target="_self">friction</a>, <a href="../../sims/dynamics/Shape.html#pos" target="_self">pos</a>, <a href="../../sims/dynamics/Shape.html#rotation" target="_self">rotation</a>, <a href="../../sims/dynamics/Shape.html#rotation0" target="_self">rotation0</a>, <a href="../../sims/dynamics/Shape.html#refLocalPos" target="_self">refLocalPos</a>, <a href="../../sims/dynamics/Shape.html#transientShapes" target="_self">transientShapes</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> def</code> - </td> - <td class="signature"> - <em><a href="../../sims/dynamics/Circle.html#AABB" target="_self">AABB</a></em> - : <a href="../../sims/collision/AABB.html" target="_self">AABB</a> - - <div>Returns this shape's axis aligned bounding box.</div> - </td> - </tr> -<tr> - <td class="modifiers" valign="top"> - <code> def</code> - </td> - <td class="signature"> - <em><a href="../../sims/dynamics/Circle.html#contains%28sims.geometry.Vector2D%29" target="_self">contains</a></em> - (<em>point</em> : <a href="../../sims/geometry/Vector2D.html" target="_self">Vector2D</a>) : <a href="http://www.scala-lang.org/docu/files/api/scala/Boolean.html" target="_self">Boolean</a> - - <div>Checks if the point <code>point</code> is contained in this shape.</div> - </td> - </tr> -<tr> - <td class="modifiers" valign="top"> - <code>override def</code> - </td> - <td class="signature"> - <em><a href="../../sims/dynamics/Circle.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/dynamics/Circle.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/dynamics/Circle.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/dynamics/Circle.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/dynamics/Circle.html#productPrefix" target="_self">productPrefix</a></em> - : <a href="" target="contentFrame" class="java/lang/String">java.lang.String</a> - - - </td> - </tr> -<tr> - <td class="modifiers" valign="top"> - <code> def</code> - </td> - <td class="signature"> - <em><a href="../../sims/dynamics/Circle.html#project%28sims.geometry.Vector2D%29" target="_self">project</a></em> - (<em>axis</em> : <a href="../../sims/geometry/Vector2D.html" target="_self">Vector2D</a>) : <a href="../../sims/geometry/Projection.html" target="_self">Projection</a> - - <div>Returns the projection of this shape onto the line given by the directional vector <code>axis</code>.</div> - </td> - </tr> -<tr> - <td class="modifiers" valign="top"> - <code>override def</code> - </td> - <td class="signature"> - <em><a href="../../sims/dynamics/Circle.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/dynamics/Shape.html" target="_self">Shape</a> - </td></tr> - <tr><td class="signature" colspan="2"> - <a href="../../sims/dynamics/Shape.html#mass" target="_self">mass</a>, <a href="../../sims/dynamics/Shape.html#body" target="_self">body</a>, <a href="../../sims/dynamics/Shape.html#asBody" target="_self">asBody</a>, <a href="../../sims/dynamics/Shape.html#%7E%28sims.dynamics.Shape%29" target="_self">~</a>, <a href="../../sims/dynamics/Shape.html#%7E%28sims.dynamics.Body%29" target="_self">~</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>Circle</h1> + </div> + <h4 class="signature"> + <span class="kind">class</span> + <span class="symbol"> + <span class="name">Circle</span><span class="params">(<span name="radius">radius: <span class="extype" name="scala.Double">Double</span></span>, <span name="density">density: <span class="extype" name="scala.Double">Double</span></span>)</span><span class="result"> extends <a href="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>A circle.</p></div> + <dl class="paramcmts block"><dt class="param">radius</dt><dd class="cmt"><p>radius of this circle</p></dd><dt class="param">density</dt><dd class="cmt"><p>density of this circle</p></dd></dl> - -<table summary="" cellpadding="3" class="member-detail"> - <tr><td class="title">Value Details</td></tr> - </table><div><a name="volume"></a><dl> - <dt> - - <code></code> - <code>val</code> - <em>volume</em> : <a href="http://www.scala-lang.org/docu/files/api/scala/Double.html" target="_self">Double</a> - </dt> - <dd></dd> - </dl> - <dl><dd>Volume. The volume is actually equivalent to this shape's area (SiMS is in 2D)
- and is used with this shape's density to calculate its mass.</dd></dl> - <dl></dl> - <dl> - <dt style="margin:10px 0 0 20px;"> - <b>Overrides</b> - </dt> - <dd> - <a href="../../sims/dynamics/Shape.html" target="_self">Shape</a>.<a href="../../sims/dynamics/Shape.html#volume" target="_self">volume</a> - </dd> - </dl><hr></hr> -<a name="I"></a><dl> - <dt> - - <code></code> - <code>val</code> - <em>I</em> : <a href="http://www.scala-lang.org/docu/files/api/scala/Double.html" target="_self">Double</a> - </dt> - <dd></dd> - </dl> - <dl><dd>Moment of inertia for a rotation about this shape's COM.</dd></dl> - <dl></dl> - <dl> - <dt style="margin:10px 0 0 20px;"> - <b>Overrides</b> - </dt> - <dd> - <a href="../../sims/dynamics/Shape.html" target="_self">Shape</a>.<a href="../../sims/dynamics/Shape.html#I" target="_self">I</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="AABB"></a><dl> - <dt> - - <code></code> - <code>def</code> - <em>AABB</em> : <a href="../../sims/collision/AABB.html" target="_self">AABB</a> - </dt> - <dd></dd> - </dl> - <dl><dd>Returns this shape's axis aligned bounding box.</dd></dl> - <dl></dl> - <dl> - <dt style="margin:10px 0 0 20px;"> - <b>Overrides</b> - </dt> - <dd> - <a href="../../sims/dynamics/Shape.html" target="_self">Shape</a>.<a href="../../sims/dynamics/Shape.html#AABB" target="_self">AABB</a> - </dd> - </dl><hr></hr> -<a name="project%28sims.geometry.Vector2D%29"></a><dl> - <dt> - - <code></code> - <code>def</code> - <em>project</em>(<em>axis</em> : <a href="../../sims/geometry/Vector2D.html" target="_self">Vector2D</a>) : <a href="../../sims/geometry/Projection.html" target="_self">Projection</a> - </dt> - <dd></dd> - </dl> - <dl><dd>Returns the projection of this shape onto the line given by the directional vector <code>axis</code>.</dd></dl> - <dl><dt style="margin:10px 0 0 20px;"> - <b>Parameters</b></dt><dd><code>axis - </code>directional vector of the line</dd><dt style="margin:10px 0 0 20px;"> - <b>Returns</b></dt><dd>projection of this shape</dd></dl> - <dl> - <dt style="margin:10px 0 0 20px;"> - <b>Overrides</b> - </dt> - <dd> - <a href="../../sims/dynamics/Shape.html" target="_self">Shape</a>.<a href="../../sims/dynamics/Shape.html#project%28sims.geometry.Vector2D%29" target="_self">project</a> - </dd> - </dl><hr></hr> -<a name="contains%28sims.geometry.Vector2D%29"></a><dl> - <dt> - - <code></code> - <code>def</code> - <em>contains</em>(<em>point</em> : <a href="../../sims/geometry/Vector2D.html" target="_self">Vector2D</a>) : <a href="http://www.scala-lang.org/docu/files/api/scala/Boolean.html" target="_self">Boolean</a> - </dt> - <dd></dd> - </dl> - <dl><dd>Checks if the point <code>point</code> is contained in this shape.</dd></dl> - <dl></dl> - <dl> - <dt style="margin:10px 0 0 20px;"> - <b>Overrides</b> - </dt> - <dd> - <a href="../../sims/dynamics/Shape.html" target="_self">Shape</a>.<a href="../../sims/dynamics/Shape.html#contains%28sims.geometry.Vector2D%29" target="_self">contains</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> - <hr></hr> -<a name="toString%28%29"></a><dl> - <dt> + + <div class="block"> + known subclasses: <a href="../../graphyx/graphics/GraphicalCircle.html">GraphicalCircle</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="sims.dynamics.Shape">Shape</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.dynamics.Circle#AABB"> + <h4 class="signature"> + <span class="kind">def</span> + <span class="symbol"> + <span class="name">AABB</span><span class="result">: <a href="../collision/AABB.html" class="extype" name="sims.collision.AABB">AABB</a></span> + </span> + </h4> + <p class="shortcomment cmt">Returns this shape's axis aligned bounding box</p><div class="fullcomment"> + <div class="comment cmt"><p>Returns this shape's axis aligned bounding box.</p></div> + + + + + </div> + </li><li name="sims.dynamics.Circle#I"> + <h4 class="signature"> + <span class="kind">val</span> + <span class="symbol"> + <span class="name">I</span><span class="result">: <span class="extype" name="scala.Double">Double</span></span> + </span> + </h4> + <p class="shortcomment cmt">Moment of inertia for a rotation about this shape's COM</p><div class="fullcomment"> + <div class="comment cmt"><p>Moment of inertia for a rotation about this shape's COM.</p></div> + + + + + </div> + </li><li name="sims.dynamics.Shape#asBody"> + <h4 class="signature"> + <span class="kind">def</span> + <span class="symbol"> + <span class="name">asBody</span><span class="result">: <a href="Body.html" class="extype" name="sims.dynamics.Body">Body</a></span> + </span> + </h4> + <p class="shortcomment cmt">Creates a new body made out of tis shape</p><div class="fullcomment"> + <div class="comment cmt"><p>Creates a new body made out of tis shape.</p></div> + + + <div class="block"> + definition classes: <a href="Shape.html">Shape</a> + </div> + + </div> + </li><li name="sims.dynamics.Shape#body"> + <h4 class="signature"> + <span class="kind">def</span> + <span class="symbol"> + <span class="name">body</span><span class="result">: <a href="Body.html" class="extype" name="sims.dynamics.Body">Body</a></span> + </span> + </h4> + <p class="shortcomment cmt">Returns this shape's containing body</p><div class="fullcomment"> + <div class="comment cmt"><p>Returns this shape's containing body.</p></div> + + + <div class="block"> + definition classes: <a href="Shape.html">Shape</a> + </div> + + </div> + </li><li name="sims.dynamics.Circle#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.dynamics.Shape#collidable"> + <h4 class="signature"> + <span class="kind">var</span> + <span class="symbol"> + <span class="name">collidable</span><span class="result">: <span class="extype" name="scala.Boolean">Boolean</span></span> + </span> + </h4> + <p class="shortcomment cmt">Flag determining this shapes ability to collide with other shapes</p><div class="fullcomment"> + <div class="comment cmt"><p>Flag determining this shapes ability to collide with other shapes.</p></div> + + + <div class="block"> + definition classes: <a href="Shape.html">Shape</a> + </div> + + </div> + </li><li name="sims.dynamics.Circle#contains"> + <h4 class="signature"> + <span class="kind">def</span> + <span class="symbol"> + <span class="name">contains</span><span class="params">(<span name="point">point: <a href="../geometry/Vector2D.html" class="extype" name="sims.geometry.Vector2D">Vector2D</a></span>)</span><span class="result">: <span class="extype" name="scala.Boolean">Boolean</span></span> + </span> + </h4> + <p class="shortcomment cmt">Checks if the point <code>point</code> is contained in this shape</p><div class="fullcomment"> + <div class="comment cmt"><p>Checks if the point <code>point</code> is contained in this shape.</p></div> + + + + + </div> + </li><li name="sims.dynamics.Circle#density"> + <h4 class="signature"> + <span class="kind">val</span> + <span class="symbol"> + <span class="name">density</span><span class="result">: <span class="extype" name="scala.Double">Double</span></span> + </span> + </h4> + <p class="shortcomment cmt">Density</p><div class="fullcomment"> + <div class="comment cmt"><p>Density. (Mass per area)</p></div> + + + + + </div> + </li><li name="sims.dynamics.Circle#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.dynamics.Shape#friction"> + <h4 class="signature"> + <span class="kind">var</span> + <span class="symbol"> + <span class="name">friction</span><span class="result">: <span class="extype" name="scala.Double">Double</span></span> + </span> + </h4> + <p class="shortcomment cmt">Part of the coefficient of friction for a collision between this shape and another</p><div class="fullcomment"> + <div class="comment cmt"><p>Part of the coefficient of friction for a collision between this shape and another. +The coefficient of friction is calculated out of the product of this part and the other shape's part.</p></div> + + + <div class="block"> + definition classes: <a href="Shape.html">Shape</a> + </div> + + </div> + </li><li name="sims.dynamics.Circle#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.dynamics.Shape#mass"> + <h4 class="signature"> + <span class="kind">def</span> + <span class="symbol"> + <span class="name">mass</span><span class="result">: <span class="extype" name="scala.Double">Double</span></span> + </span> + </h4> + <p class="shortcomment cmt">Returns the mass of this shape</p><div class="fullcomment"> + <div class="comment cmt"><p>Returns the mass of this shape. The mass is given by volume times density.</p></div> + + + <div class="block"> + definition classes: <a href="Shape.html">Shape</a> + </div> + + </div> + </li><li name="sims.dynamics.Shape#pos"> + <h4 class="signature"> + <span class="kind">var</span> + <span class="symbol"> + <span class="name">pos</span><span class="result">: <a href="../geometry/Vector2D.html" class="extype" name="sims.geometry.Vector2D">Vector2D</a></span> + </span> + </h4> + <p class="shortcomment cmt">Position of this shape's COM (in world coordinates)</p><div class="fullcomment"> + <div class="comment cmt"><p>Position of this shape's COM (in world coordinates).</p></div> + + + <div class="block"> + definition classes: <a href="Shape.html">Shape</a> + </div> + + </div> + </li><li name="sims.dynamics.Circle#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.dynamics.Circle#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.dynamics.Circle#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.dynamics.Circle#project"> + <h4 class="signature"> + <span class="kind">def</span> + <span class="symbol"> + <span class="name">project</span><span class="params">(<span name="axis">axis: <a href="../geometry/Vector2D.html" class="extype" name="sims.geometry.Vector2D">Vector2D</a></span>)</span><span class="result">: <a href="../geometry/Projection.html" class="extype" name="sims.geometry.Projection">Projection</a></span> + </span> + </h4> + <p class="shortcomment cmt">Returns the projection of this shape onto the line given by the directional vector <code>axis</code></p><div class="fullcomment"> + <div class="comment cmt"><p>Returns the projection of this shape onto the line given by the directional vector <code>axis</code>.</p></div> + <dl class="paramcmts block"><dt class="param">axis</dt><dd class="cmt"><p>directional vector of the line</p></dd><dt>returns</dt><dd class="cmt"><p>projection of this shape</p></dd></dl> + + + + </div> + </li><li name="sims.dynamics.Circle#radius"> + <h4 class="signature"> + <span class="kind">val</span> + <span class="symbol"> + <span class="name">radius</span><span class="result">: <span class="extype" name="scala.Double">Double</span></span> + </span> + </h4> + + </li><li name="sims.dynamics.Shape#refLocalPos"> + <h4 class="signature"> + <span class="kind">var</span> + <span class="symbol"> + <span class="name">refLocalPos</span><span class="result">: <a href="../geometry/Vector2D.html" class="extype" name="sims.geometry.Vector2D">Vector2D</a></span> + </span> + </h4> + <p class="shortcomment cmt">Local position of this shape's body COM to its COM at a body rotation of zero</p><div class="fullcomment"> + <div class="comment cmt"><p>Local position of this shape's body COM to its COM at a body rotation of zero.</p></div> + + + <div class="block"> + definition classes: <a href="Shape.html">Shape</a> + </div> + + </div> + </li><li name="sims.dynamics.Shape#restitution"> + <h4 class="signature"> + <span class="kind">var</span> + <span class="symbol"> + <span class="name">restitution</span><span class="result">: <span class="extype" name="scala.Double">Double</span></span> + </span> + </h4> + <p class="shortcomment cmt">Part of the coefficient of restitution for a collision between this shape and another</p><div class="fullcomment"> + <div class="comment cmt"><p>Part of the coefficient of restitution for a collision between this shape and another. +The coefficient of restitution is calculated out of the product of this part and the other shape's part.</p></div> + + + <div class="block"> + definition classes: <a href="Shape.html">Shape</a> + </div> + + </div> + </li><li name="sims.dynamics.Shape#rotation"> + <h4 class="signature"> + <span class="kind">var</span> + <span class="symbol"> + <span class="name">rotation</span><span class="result">: <span class="extype" name="scala.Double">Double</span></span> + </span> + </h4> + <p class="shortcomment cmt">Rotation of this shape about its COM</p><div class="fullcomment"> + <div class="comment cmt"><p>Rotation of this shape about its COM.</p></div> + + + <div class="block"> + definition classes: <a href="Shape.html">Shape</a> + </div> + + </div> + </li><li name="sims.dynamics.Shape#rotation0"> + <h4 class="signature"> + <span class="kind">var</span> + <span class="symbol"> + <span class="name">rotation0</span><span class="result">: <span class="extype" name="scala.Double">Double</span></span> + </span> + </h4> + <p class="shortcomment cmt">Initial rotation</p><div class="fullcomment"> + <div class="comment cmt"><p>Initial rotation. Rotation of this shape before it was added to a body.</p></div> + + + <div class="block"> + definition classes: <a href="Shape.html">Shape</a> + </div> + + </div> + </li><li name="sims.dynamics.Circle#toString"> + <h4 class="signature"> + <span class="kind">def</span> + <span class="symbol"> + <span class="name">toString</span><span class="params">()</span><span class="result">: <span class="extype" name="java.lang.String">String</span></span> + </span> + </h4> + <p class="shortcomment cmt">Returns a string representation of the object</p><div class="fullcomment"> + <div class="comment cmt"><p>Returns a string representation of the object. +<p> +The default representation is platform dependent. +</p></div> + + + + + </div> + </li><li name="sims.dynamics.Shape#transientShapes"> + <h4 class="signature"> + <span class="kind">val</span> + <span class="symbol"> + <span class="name">transientShapes</span><span class="result">: <span class="extype" name="scala.collection.mutable.Set">Set</span>[<a href="Shape.html" class="extype" name="sims.dynamics.Shape">Shape</a>]</span> + </span> + </h4> + <p class="shortcomment cmt">Shapes with which this shape cannot collide</p><div class="fullcomment"> + <div class="comment cmt"><p>Shapes with which this shape cannot collide.</p></div> + + + <div class="block"> + definition classes: <a href="Shape.html">Shape</a> + </div> + + </div> + </li><li name="sims.dynamics.Shape#uid"> + <h4 class="signature"> + <span class="kind">val</span> + <span class="symbol"> + <span class="name">uid</span><span class="result">: <span class="extype" name="scala.Int">Int</span></span> + </span> + </h4> + <p class="shortcomment cmt">Unique identification number</p><div class="fullcomment"> + <div class="comment cmt"><p>Unique identification number.</p></div> + + + <div class="block"> + definition classes: <a href="Shape.html">Shape</a> + </div> + + </div> + </li><li name="sims.dynamics.Circle#volume"> + <h4 class="signature"> + <span class="kind">val</span> + <span class="symbol"> + <span class="name">volume</span><span class="result">: <span class="extype" name="scala.Double">Double</span></span> + </span> + </h4> + <p class="shortcomment cmt">Volume</p><div class="fullcomment"> + <div class="comment cmt"><p>Volume. The volume is actually equivalent to this shape's area (SiMS is in 2D) +and is used with this shape's density to calculate its mass.</p></div> + + + + + </div> + </li><li name="sims.dynamics.Shape#~"> + <h4 class="signature"> + <span class="kind">def</span> + <span class="symbol"> + <span class="name">~</span><span class="params">(<span name="b">b: <a href="Body.html" class="extype" name="sims.dynamics.Body">Body</a></span>)</span><span class="result">: <a href="Body.html" class="extype" name="sims.dynamics.Body">Body</a></span> + </span> + </h4> + <p class="shortcomment cmt">Creates a new body out of this shape and the shapes of body <code>b</code></p><div class="fullcomment"> + <div class="comment cmt"><p>Creates a new body out of this shape and the shapes of body <code>b</code>.</p></div> + + + <div class="block"> + definition classes: <a href="Shape.html">Shape</a> + </div> + + </div> + </li><li name="sims.dynamics.Shape#~"> + <h4 class="signature"> + <span class="kind">def</span> + <span class="symbol"> + <span class="name">~</span><span class="params">(<span name="s">s: <a href="Shape.html" class="extype" name="sims.dynamics.Shape">Shape</a></span>)</span><span class="result">: <a href="Body.html" class="extype" name="sims.dynamics.Body">Body</a></span> + </span> + </h4> + <p class="shortcomment cmt">Creates a new body out of this shape and the shape <code>s</code></p><div class="fullcomment"> + <div class="comment cmt"><p>Creates a new body out of this shape and the shape <code>s</code>.</p></div> + + + <div class="block"> + definition classes: <a href="Shape.html">Shape</a> + </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.dynamics.Circle#this"> + <h4 class="signature"> + <span class="kind">new</span> + <span class="symbol"> + <span class="name">Circle</span><span class="params">(<span name="radius">radius: <span class="extype" name="scala.Double">Double</span></span>, <span name="density">density: <span class="extype" name="scala.Double">Double</span></span>)</span> + </span> + </h4> + + </li><li name="sims.dynamics.Shape#this"> + <h4 class="signature"> + <span class="kind">new</span> + <span class="symbol"> + <span class="name">Circle</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/dynamics/Constraint.html b/doc/sims/dynamics/Constraint.html index 570f522..23264ed 100644 --- a/doc/sims/dynamics/Constraint.html +++ b/doc/sims/dynamics/Constraint.html @@ -1,134 +1,184 @@ -<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
+<?xml version='1.0' encoding='UTF-8'?> +<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.1//EN" "http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd"> <html> - <head><title>trait Constraint in sims.dynamics</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.dynamics.Constraint</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/dynamics$package.html" target="_self">sims.dynamics</a> - <br></br> - <span class="entity">trait Constraint</span> - </div><hr></hr> - <div class="source"> - [source: <a href="" class="sims/dynamics/Constraint"><code>sims/dynamics/Constraint.scala</code></a>] - </div><hr></hr> - <a name="Constraint"></a><dl> - <dt> - - <code></code> - <code>trait</code> - <em>Constraint</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>All constraints in SiMS implement this trait.
- Position and velocity can be corrected for each constraint.
- The implementation of constraints was inspired by Erin Catto's box2d.</dd></dl> - <dl></dl> - <dl> - <dt style="margin:10px 0 0 20px;"><b>Direct Known Subclasses:</b></dt> - <dd><a href="../../sims/collision/Collision.html" target="_self">Collision</a>, <a href="../../sims/dynamics/joints/Joint.html" target="_self">Joint</a></dd> - </dl><hr></hr> + <body class="type"> + <p id="owner"><a href="../package.html">sims</a>.<a href="package.html">dynamics</a></p> + <div id="definition"> + <img src="../../lib/trait_big.png" /> + <h1>Constraint</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>abstract def</code> - </td> - <td class="signature"> - <em><a href="../../sims/dynamics/Constraint.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> + <h4 class="signature"> + <span class="kind">trait</span> + <span class="symbol"> + <span class="name">Constraint</span><span class="result"> extends AnyRef</span> + </span> + </h4> + <div class="fullcomment" id="comment"> + <div class="comment cmt"><p>All constraints in SiMS implement this trait. +Position and velocity can be corrected for each constraint. +The implementation of constraints was inspired by Erin Catto's box2d.</p></div> + + + + <div class="block"> + known subclasses: <a href="joints/Joint.html">Joint</a>, <a href="../collision/Collision.html">Collision</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>Corrects the positions of bodies according to this constraint.</div> - </td> - </tr> -<tr> - <td class="modifiers" valign="top"> - <code>abstract def</code> - </td> - <td class="signature"> - <em><a href="../../sims/dynamics/Constraint.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 class="members" id="values"> + <h3>Value Members</h3> + <ol><li name="sims.dynamics.Constraint#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"> + attributes: abstract + </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> + + </div> + </li><li name="sims.dynamics.Constraint#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"> + 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></ol> + </div> - <code>abstract</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> - <hr></hr> -<a name="correctPosition%28Double%29"></a><dl> - <dt> - <code>abstract</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> - <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/dynamics/Rectangle$object.html b/doc/sims/dynamics/Rectangle$object.html deleted file mode 100644 index 7c76345..0000000 --- a/doc/sims/dynamics/Rectangle$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 Rectangle in sims.dynamics</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/dynamics$package.html" target="_self">sims.dynamics</a> - <br></br> - <span class="entity">object Rectangle</span> - </div><hr></hr> - <div class="source"> - [source: <a href="" class="sims/dynamics/Rectangle"><code>sims/dynamics/Rectangle.scala</code></a>] - </div><hr></hr> - <a name="Rectangle"></a><dl> - <dt> - - <code></code> - <code>object</code> - <em>Rectangle</em> - </dt> - <dd><code> extends </code>(<a href="http://www.scala-lang.org/docu/files/api/scala/Double.html" target="_self">Double</a>, <a href="http://www.scala-lang.org/docu/files/api/scala/Double.html" target="_self">Double</a>, <a href="http://www.scala-lang.org/docu/files/api/scala/Double.html" target="_self">Double</a>) => <a href="../../sims/dynamics/Rectangle.html" target="_self">Rectangle</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/dynamics/Rectangle.html b/doc/sims/dynamics/Rectangle.html index df238de..63ef89d 100644 --- a/doc/sims/dynamics/Rectangle.html +++ b/doc/sims/dynamics/Rectangle.html @@ -1,430 +1,598 @@ -<!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 Rectangle in sims.dynamics</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.dynamics.Rectangle</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/dynamics$package.html" target="_self">sims.dynamics</a> - <br></br> - <span class="entity">class Rectangle</span> - </div><hr></hr> - <div class="source"> - [source: <a href="" class="sims/dynamics/Rectangle"><code>sims/dynamics/Rectangle.scala</code></a>] - </div><hr></hr> - <a name="Rectangle"></a><dl> - <dt> - - <code>case</code> - <code>class</code> - <em>Rectangle</em>(<code>val </code><em>halfWidth</em> : <a href="http://www.scala-lang.org/docu/files/api/scala/Double.html" target="_self">Double</a>, <code>val </code><em>halfHeight</em> : <a href="http://www.scala-lang.org/docu/files/api/scala/Double.html" target="_self">Double</a>, <code>val </code><em>density</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="../../sims/dynamics/Shape.html" target="_self">Shape</a><code> with </code><a href="../../sims/geometry/ConvexPolygon.html" target="_self">ConvexPolygon</a><code> with </code><a href="" target="contentFrame" class="scala/Product">scala.Product</a></dd> - </dl> - <dl><dd>A rectangle is a polygon.</dd></dl> - <dl><dt style="margin:10px 0 0 20px;"> - <b>Parameters</b></dt><dd><code>halfWidth - </code>this rectangle's half width</dd><dd><code>halfHeight - </code>this rectangle's half height</dd><dd><code>density - </code>density of this rectangle</dd></dl> - <dl> - <dt style="margin:10px 0 0 20px;"><b>Direct Known Subclasses:</b></dt> - <dd><a href="../../graphyx/graphics/GraphicalRectangle.html" target="_self">GraphicalRectangle</a></dd> - </dl><hr></hr> + <body class="type"> + <p id="owner"><a href="../package.html">sims</a>.<a href="package.html">dynamics</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/dynamics/Rectangle.html#I" target="_self">I</a></em> - : <a href="http://www.scala-lang.org/docu/files/api/scala/Double.html" target="_self">Double</a> - - <div>Moment of inertia for a rotation about this shape's COM.</div> - </td> - </tr> -<tr> - <td class="modifiers" valign="top"> - <code> val</code> - </td> - <td class="signature"> - <em><a href="../../sims/dynamics/Rectangle.html#volume" target="_self">volume</a></em> - : <a href="http://www.scala-lang.org/docu/files/api/scala/Double.html" target="_self">Double</a> - - <div>Volume. The volume is actually equivalent to this shape's area (SiMS is in 2D)
- and is used with this shape's density to calculate its mass.</div> - </td> - </tr> - </table><table summary="" cellpadding="3" class="inherited"> - <tr><td class="title" colspan="2"> - Values and Variables inherited from <a href="../../sims/dynamics/Shape.html" target="_self">Shape</a> - </td></tr> - <tr><td class="signature" colspan="2"> - <a href="../../sims/dynamics/Shape.html#uid" target="_self">uid</a>, <a href="../../sims/dynamics/Shape.html#collidable" target="_self">collidable</a>, <a href="../../sims/dynamics/Shape.html#restitution" target="_self">restitution</a>, <a href="../../sims/dynamics/Shape.html#friction" target="_self">friction</a>, <a href="../../sims/dynamics/Shape.html#pos" target="_self">pos</a>, <a href="../../sims/dynamics/Shape.html#rotation" target="_self">rotation</a>, <a href="../../sims/dynamics/Shape.html#rotation0" target="_self">rotation0</a>, <a href="../../sims/dynamics/Shape.html#refLocalPos" target="_self">refLocalPos</a>, <a href="../../sims/dynamics/Shape.html#transientShapes" target="_self">transientShapes</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/dynamics/Rectangle.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> def</code> - </td> - <td class="signature"> - <em><a href="../../sims/dynamics/Rectangle.html#halfDiags" target="_self">halfDiags</a></em> - : <a href="" target="contentFrame" class="scala/Array">scala.Array</a>[<a href="../../sims/geometry/Vector2D.html" target="_self">Vector2D</a>] - - <div>Returns the vectors from the center to the vertices of this rectangle.
- The first vertex is the upper-right vertex at a rotation of 0.
- Vertices are ordered counter-clockwise.</div> - </td> - </tr> -<tr> - <td class="modifiers" valign="top"> - <code>override def</code> - </td> - <td class="signature"> - <em><a href="../../sims/dynamics/Rectangle.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/dynamics/Rectangle.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/dynamics/Rectangle.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/dynamics/Rectangle.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/dynamics/Rectangle.html#toString%28%29" target="_self">toString</a></em> - : <a href="" target="contentFrame" class="java/lang/String">java.lang.String</a> - - <div>Returns a string representation of the object.</div> - </td> - </tr> -<tr> - <td class="modifiers" valign="top"> - <code> def</code> - </td> - <td class="signature"> - <em><a href="../../sims/dynamics/Rectangle.html#vertices" target="_self">vertices</a></em> - : <a href="" target="contentFrame" class="scala/Array">scala.Array</a>[<a href="../../sims/geometry/Vector2D.html" target="_self">Vector2D</a>] - - <div>Returns the position vectors of this rectangle's vertices.
- The first vertex is the upper-right vertex at a rotation of 0.
- Vertices are ordered counter-clockwise.</div> - </td> - </tr> - </table><table summary="" cellpadding="3" class="inherited"> - <tr><td class="title" colspan="2"> - Methods inherited from <a href="../../sims/geometry/ConvexPolygon.html" target="_self">ConvexPolygon</a> - </td></tr> - <tr><td class="signature" colspan="2"> - <a href="../../sims/geometry/ConvexPolygon.html#sides" target="_self">sides</a>, <a href="../../sims/geometry/ConvexPolygon.html#project%28sims.geometry.Vector2D%29" target="_self">project</a>, <a href="../../sims/geometry/ConvexPolygon.html#AABB" target="_self">AABB</a>, <a href="../../sims/geometry/ConvexPolygon.html#contains%28sims.geometry.Vector2D%29" target="_self">contains</a> - </td></tr> - </table><table summary="" cellpadding="3" class="inherited"> - <tr><td class="title" colspan="2"> - Methods inherited from <a href="../../sims/dynamics/Shape.html" target="_self">Shape</a> - </td></tr> - <tr><td class="signature" colspan="2"> - <a href="../../sims/dynamics/Shape.html#mass" target="_self">mass</a>, <a href="../../sims/dynamics/Shape.html#body" target="_self">body</a>, <a href="../../sims/dynamics/Shape.html#asBody" target="_self">asBody</a>, <a href="../../sims/dynamics/Shape.html#%7E%28sims.dynamics.Shape%29" target="_self">~</a>, <a href="../../sims/dynamics/Shape.html#%7E%28sims.dynamics.Body%29" target="_self">~</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>Rectangle</h1> + </div> + <h4 class="signature"> + <span class="kind">class</span> + <span class="symbol"> + <span class="name">Rectangle</span><span class="params">(<span name="halfWidth">halfWidth: <span class="extype" name="scala.Double">Double</span></span>, <span name="halfHeight">halfHeight: <span class="extype" name="scala.Double">Double</span></span>, <span name="density">density: <span class="extype" name="scala.Double">Double</span></span>)</span><span class="result"> extends <a href="Shape.html" class="extype" name="sims.dynamics.Shape">Shape</a> with <a href="../geometry/ConvexPolygon.html" class="extype" name="sims.geometry.ConvexPolygon">ConvexPolygon</a> with <span class="extype" name="scala.Product">Product</span></span> + </span> + </h4> + <div class="fullcomment" id="comment"> + <div class="comment cmt"><p>A rectangle is a polygon.</p></div> + <dl class="paramcmts block"><dt class="param">halfWidth</dt><dd class="cmt"><p>this rectangle's half width</p></dd><dt class="param">halfHeight</dt><dd class="cmt"><p>this rectangle's half height</p></dd><dt class="param">density</dt><dd class="cmt"><p>density of this rectangle</p></dd></dl> - -<table summary="" cellpadding="3" class="member-detail"> - <tr><td class="title">Value Details</td></tr> - </table><div><a name="volume"></a><dl> - <dt> - - <code></code> - <code>val</code> - <em>volume</em> : <a href="http://www.scala-lang.org/docu/files/api/scala/Double.html" target="_self">Double</a> - </dt> - <dd></dd> - </dl> - <dl><dd>Volume. The volume is actually equivalent to this shape's area (SiMS is in 2D)
- and is used with this shape's density to calculate its mass.</dd></dl> - <dl></dl> - <dl> - <dt style="margin:10px 0 0 20px;"> - <b>Overrides</b> - </dt> - <dd> - <a href="../../sims/dynamics/Shape.html" target="_self">Shape</a>.<a href="../../sims/dynamics/Shape.html#volume" target="_self">volume</a> - </dd> - </dl><hr></hr> -<a name="I"></a><dl> - <dt> - - <code></code> - <code>val</code> - <em>I</em> : <a href="http://www.scala-lang.org/docu/files/api/scala/Double.html" target="_self">Double</a> - </dt> - <dd></dd> - </dl> - <dl><dd>Moment of inertia for a rotation about this shape's COM.</dd></dl> - <dl></dl> - <dl> - <dt style="margin:10px 0 0 20px;"> - <b>Overrides</b> - </dt> - <dd> - <a href="../../sims/dynamics/Shape.html" target="_self">Shape</a>.<a href="../../sims/dynamics/Shape.html#I" target="_self">I</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="halfDiags"></a><dl> - <dt> - - <code></code> - <code>def</code> - <em>halfDiags</em> : <a href="" target="contentFrame" class="scala/Array">scala.Array</a>[<a href="../../sims/geometry/Vector2D.html" target="_self">Vector2D</a>] - </dt> - <dd></dd> - </dl> - <dl><dd>Returns the vectors from the center to the vertices of this rectangle.
- The first vertex is the upper-right vertex at a rotation of 0.
- Vertices are ordered counter-clockwise.</dd></dl> - <dl></dl> - <hr></hr> -<a name="vertices"></a><dl> - <dt> - - <code></code> - <code>def</code> - <em>vertices</em> : <a href="" target="contentFrame" class="scala/Array">scala.Array</a>[<a href="../../sims/geometry/Vector2D.html" target="_self">Vector2D</a>] - </dt> - <dd></dd> - </dl> - <dl><dd>Returns the position vectors of this rectangle's vertices.
- The first vertex is the upper-right vertex at a rotation of 0.
- Vertices are ordered counter-clockwise.</dd></dl> - <dl></dl> - <dl> - <dt style="margin:10px 0 0 20px;"> - <b>Overrides</b> - </dt> - <dd> - <a href="../../sims/geometry/ConvexPolygon.html" target="_self">ConvexPolygon</a>.<a href="../../sims/geometry/ConvexPolygon.html#vertices" target="_self">vertices</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> - <hr></hr> -<a name="toString%28%29"></a><dl> - <dt> + + <div class="block"> + known subclasses: <a href="../../graphyx/graphics/GraphicalRectangle.html">GraphicalRectangle</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="sims.geometry.ConvexPolygon">ConvexPolygon</li><li class="in" name="sims.dynamics.Shape">Shape</li><li class="in" name="scala.AnyRef">AnyRef</li><li class="in" name="scala.Any">Any</li></ol> + </div> + </div> - <code>override</code> - <code>def</code> - <em>toString</em> : <a href="" target="contentFrame" class="java/lang/String">java.lang.String</a> - </dt> - <dd></dd> - </dl> - <dl><dd>Returns a string representation of the object.
- <p>
- The default representation is platform dependent.</dd></dl> - <dl><dt style="margin:10px 0 0 20px;"> - <b>Returns</b></dt><dd>a string representation of the object. </p></dd></dl> - <hr></hr> -<a name="equals%28Any%29"></a><dl> - <dt> - <code>override</code> - <code>def</code> - <em>equals</em>(<em>arg0</em> : <a href="http://www.scala-lang.org/docu/files/api/scala/Any.html" target="_self">Any</a>) : <a href="http://www.scala-lang.org/docu/files/api/scala/Boolean.html" target="_self">Boolean</a> - </dt> - <dd></dd> - </dl> - <dl><dd>This method is used to compare the receiver object (<code>this</code>)
- with the argument object (<code>arg0</code>) for equivalence.
-
- <p>
- The default implementations of this method is an <a
- href="http://en.wikipedia.org/wiki/Equivalence_relation">equivalence
- relation</a>:
- <ul>
- <li>It is reflexive: for any instance <code>x</code> of type <code>Any</code>,
- <code>x.equals(x)</code> should return <code>true</code>.</li>
- <li>It is symmetric: for any instances <code>x</code> and <code>y</code> of type
- <code>Any</code>, <code>x.equals(y)</code> should return <code>true</code> if and only
- if <code>y.equals(x)</code> returns <code>true</code>.</li>
- <li>It is transitive: for any instances
- <code>x</code>, <code>y</code>, and <code>z</code> of type <code>AnyRef</code>
- if <code>x.equals(y)</code> returns <code>true</code> and
- <code>y.equals(z)</code> returns
- <code>true</code>, then <code>x.equals(z)</code> should return <code>true</code>.</li>
- </ul>
- </p>
- <p>
- If you override this method, you should verify that
- your implementation remains an equivalence relation.
- Additionally, when overriding this method it is often necessary to
- override <code>hashCode</code> to ensure that objects that are
- "equal" (<code>o1.equals(o2)</code> returns <code>true</code>)
- hash to the same <a href="Int.html"><code>Int</code></a>
- (<code>o1.hashCode.equals(o2.hashCode)</code>).</dd></dl> - <dl><dt style="margin:10px 0 0 20px;"> - <b>Parameters</b></dt><dd><code>arg0 - </code>the object to compare against this object for equality.</dd><dt style="margin:10px 0 0 20px;"> - <b>Returns</b></dt><dd><code>true</code> if the receiver object is equivalent to the argument; <code>false</code> otherwise. </p></dd></dl> - <hr></hr> -<a name="productPrefix"></a><dl> - <dt> - <code>override</code> - <code>def</code> - <em>productPrefix</em> : <a href="" target="contentFrame" class="java/lang/String">java.lang.String</a> - </dt> - <dd></dd> - </dl><dl> - <dt style="margin:10px 0 0 20px;"> - <b>Overrides</b> - </dt> - <dd> - <a href="" target="contentFrame" class="scala/Product">scala.Product</a>.<a href="#productPrefix" target="contentFrame" class="scala/Product">scala.Product.productPrefix</a> - </dd> - </dl><hr></hr> -<a name="productArity"></a><dl> - <dt> + <div class="members" id="values"> + <h3>Value Members</h3> + <ol><li name="sims.geometry.ConvexPolygon#AABB"> + <h4 class="signature"> + <span class="kind">def</span> + <span class="symbol"> + <span class="name">AABB</span><span class="result">: <a href="../collision/AABB.html" class="extype" name="sims.collision.AABB">AABB</a></span> + </span> + </h4> + <p class="shortcomment cmt">Returns this polygon's axis aligned bounding box</p><div class="fullcomment"> + <div class="comment cmt"><p>Returns this polygon's axis aligned bounding box.</p></div> + + + <div class="block"> + definition classes: <a href="../geometry/ConvexPolygon.html">ConvexPolygon</a> + </div> + + </div> + </li><li name="sims.dynamics.Rectangle#I"> + <h4 class="signature"> + <span class="kind">val</span> + <span class="symbol"> + <span class="name">I</span><span class="result">: <span class="extype" name="scala.Double">Double</span></span> + </span> + </h4> + <p class="shortcomment cmt">Moment of inertia for a rotation about this shape's COM</p><div class="fullcomment"> + <div class="comment cmt"><p>Moment of inertia for a rotation about this shape's COM.</p></div> + + + + + </div> + </li><li name="sims.dynamics.Shape#asBody"> + <h4 class="signature"> + <span class="kind">def</span> + <span class="symbol"> + <span class="name">asBody</span><span class="result">: <a href="Body.html" class="extype" name="sims.dynamics.Body">Body</a></span> + </span> + </h4> + <p class="shortcomment cmt">Creates a new body made out of tis shape</p><div class="fullcomment"> + <div class="comment cmt"><p>Creates a new body made out of tis shape.</p></div> + + + <div class="block"> + definition classes: <a href="Shape.html">Shape</a> + </div> + + </div> + </li><li name="sims.dynamics.Shape#body"> + <h4 class="signature"> + <span class="kind">def</span> + <span class="symbol"> + <span class="name">body</span><span class="result">: <a href="Body.html" class="extype" name="sims.dynamics.Body">Body</a></span> + </span> + </h4> + <p class="shortcomment cmt">Returns this shape's containing body</p><div class="fullcomment"> + <div class="comment cmt"><p>Returns this shape's containing body.</p></div> + + + <div class="block"> + definition classes: <a href="Shape.html">Shape</a> + </div> + + </div> + </li><li name="sims.dynamics.Rectangle#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.dynamics.Shape#collidable"> + <h4 class="signature"> + <span class="kind">var</span> + <span class="symbol"> + <span class="name">collidable</span><span class="result">: <span class="extype" name="scala.Boolean">Boolean</span></span> + </span> + </h4> + <p class="shortcomment cmt">Flag determining this shapes ability to collide with other shapes</p><div class="fullcomment"> + <div class="comment cmt"><p>Flag determining this shapes ability to collide with other shapes.</p></div> + + + <div class="block"> + definition classes: <a href="Shape.html">Shape</a> + </div> + + </div> + </li><li name="sims.geometry.ConvexPolygon#contains"> + <h4 class="signature"> + <span class="kind">def</span> + <span class="symbol"> + <span class="name">contains</span><span class="params">(<span name="point">point: <a href="../geometry/Vector2D.html" class="extype" name="sims.geometry.Vector2D">Vector2D</a></span>)</span><span class="result">: <span class="extype" name="scala.Boolean">Boolean</span></span> + </span> + </h4> + <p class="shortcomment cmt">Checks if the point <code>point</code> is contained in this polygon</p><div class="fullcomment"> + <div class="comment cmt"><p>Checks if the point <code>point</code> is contained in this polygon. +<p> +A ray is created, originating from the point and following an arbitrary direction (X-Axis was chosen). +The number of intersections between the ray and this polygon's sides (including vertices) is counted. +The amount of intersections with vertices is substracted form the previuos number. +If the latter number is odd, the point is contained in the polygon.</p></div> + + + <div class="block"> + definition classes: <a href="../geometry/ConvexPolygon.html">ConvexPolygon</a> + </div> + + </div> + </li><li name="sims.dynamics.Rectangle#density"> + <h4 class="signature"> + <span class="kind">val</span> + <span class="symbol"> + <span class="name">density</span><span class="result">: <span class="extype" name="scala.Double">Double</span></span> + </span> + </h4> + <p class="shortcomment cmt">Density</p><div class="fullcomment"> + <div class="comment cmt"><p>Density. (Mass per area)</p></div> + + + + + </div> + </li><li name="sims.dynamics.Rectangle#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.dynamics.Shape#friction"> + <h4 class="signature"> + <span class="kind">var</span> + <span class="symbol"> + <span class="name">friction</span><span class="result">: <span class="extype" name="scala.Double">Double</span></span> + </span> + </h4> + <p class="shortcomment cmt">Part of the coefficient of friction for a collision between this shape and another</p><div class="fullcomment"> + <div class="comment cmt"><p>Part of the coefficient of friction for a collision between this shape and another. +The coefficient of friction is calculated out of the product of this part and the other shape's part.</p></div> + + + <div class="block"> + definition classes: <a href="Shape.html">Shape</a> + </div> + + </div> + </li><li name="sims.dynamics.Rectangle#halfDiags"> + <h4 class="signature"> + <span class="kind">def</span> + <span class="symbol"> + <span class="name">halfDiags</span><span class="result">: <span class="extype" name="scala.Array">Array</span>[<a href="../geometry/Vector2D.html" class="extype" name="sims.geometry.Vector2D">Vector2D</a>]</span> + </span> + </h4> + <p class="shortcomment cmt">Returns the vectors from the center to the vertices of this rectangle</p><div class="fullcomment"> + <div class="comment cmt"><p>Returns the vectors from the center to the vertices of this rectangle. +The first vertex is the upper-right vertex at a rotation of 0. +Vertices are ordered counter-clockwise.</p></div> + + + + + </div> + </li><li name="sims.dynamics.Rectangle#halfHeight"> + <h4 class="signature"> + <span class="kind">val</span> + <span class="symbol"> + <span class="name">halfHeight</span><span class="result">: <span class="extype" name="scala.Double">Double</span></span> + </span> + </h4> + + </li><li name="sims.dynamics.Rectangle#halfWidth"> + <h4 class="signature"> + <span class="kind">val</span> + <span class="symbol"> + <span class="name">halfWidth</span><span class="result">: <span class="extype" name="scala.Double">Double</span></span> + </span> + </h4> + + </li><li name="sims.dynamics.Rectangle#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.dynamics.Shape#mass"> + <h4 class="signature"> + <span class="kind">def</span> + <span class="symbol"> + <span class="name">mass</span><span class="result">: <span class="extype" name="scala.Double">Double</span></span> + </span> + </h4> + <p class="shortcomment cmt">Returns the mass of this shape</p><div class="fullcomment"> + <div class="comment cmt"><p>Returns the mass of this shape. The mass is given by volume times density.</p></div> + + + <div class="block"> + definition classes: <a href="Shape.html">Shape</a> + </div> + + </div> + </li><li name="sims.dynamics.Shape#pos"> + <h4 class="signature"> + <span class="kind">var</span> + <span class="symbol"> + <span class="name">pos</span><span class="result">: <a href="../geometry/Vector2D.html" class="extype" name="sims.geometry.Vector2D">Vector2D</a></span> + </span> + </h4> + <p class="shortcomment cmt">Position of this shape's COM (in world coordinates)</p><div class="fullcomment"> + <div class="comment cmt"><p>Position of this shape's COM (in world coordinates).</p></div> + + + <div class="block"> + definition classes: <a href="Shape.html">Shape</a> + </div> + + </div> + </li><li name="sims.dynamics.Rectangle#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.dynamics.Rectangle#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.dynamics.Rectangle#productPrefix"> + <h4 class="signature"> + <span class="kind">def</span> + <span class="symbol"> + <span class="name">productPrefix</span><span class="result">: <span class="extype" name="java.lang.String">String</span></span> + </span> + </h4> + + </li><li name="sims.geometry.ConvexPolygon#project"> + <h4 class="signature"> + <span class="kind">def</span> + <span class="symbol"> + <span class="name">project</span><span class="params">(<span name="axis">axis: <a href="../geometry/Vector2D.html" class="extype" name="sims.geometry.Vector2D">Vector2D</a></span>)</span><span class="result">: <a href="../geometry/Projection.html" class="extype" name="sims.geometry.Projection">Projection</a></span> + </span> + </h4> + <p class="shortcomment cmt">Returns the projection of this polygon onto the line given by the directional vector <code>axis</code></p><div class="fullcomment"> + <div class="comment cmt"><p>Returns the projection of this polygon onto the line given by the directional vector <code>axis</code>.</p></div> + <dl class="paramcmts block"><dt class="param">axis</dt><dd class="cmt"><p>directional vector of the line</p></dd><dt>returns</dt><dd class="cmt"><p>projection of this polygon</p></dd></dl> + + <div class="block"> + definition classes: <a href="../geometry/ConvexPolygon.html">ConvexPolygon</a> + </div> + + </div> + </li><li name="sims.dynamics.Shape#refLocalPos"> + <h4 class="signature"> + <span class="kind">var</span> + <span class="symbol"> + <span class="name">refLocalPos</span><span class="result">: <a href="../geometry/Vector2D.html" class="extype" name="sims.geometry.Vector2D">Vector2D</a></span> + </span> + </h4> + <p class="shortcomment cmt">Local position of this shape's body COM to its COM at a body rotation of zero</p><div class="fullcomment"> + <div class="comment cmt"><p>Local position of this shape's body COM to its COM at a body rotation of zero.</p></div> + + + <div class="block"> + definition classes: <a href="Shape.html">Shape</a> + </div> + + </div> + </li><li name="sims.dynamics.Shape#restitution"> + <h4 class="signature"> + <span class="kind">var</span> + <span class="symbol"> + <span class="name">restitution</span><span class="result">: <span class="extype" name="scala.Double">Double</span></span> + </span> + </h4> + <p class="shortcomment cmt">Part of the coefficient of restitution for a collision between this shape and another</p><div class="fullcomment"> + <div class="comment cmt"><p>Part of the coefficient of restitution for a collision between this shape and another. +The coefficient of restitution is calculated out of the product of this part and the other shape's part.</p></div> + + + <div class="block"> + definition classes: <a href="Shape.html">Shape</a> + </div> + + </div> + </li><li name="sims.dynamics.Shape#rotation"> + <h4 class="signature"> + <span class="kind">var</span> + <span class="symbol"> + <span class="name">rotation</span><span class="result">: <span class="extype" name="scala.Double">Double</span></span> + </span> + </h4> + <p class="shortcomment cmt">Rotation of this shape about its COM</p><div class="fullcomment"> + <div class="comment cmt"><p>Rotation of this shape about its COM.</p></div> + + + <div class="block"> + definition classes: <a href="Shape.html">Shape</a> + </div> + + </div> + </li><li name="sims.dynamics.Shape#rotation0"> + <h4 class="signature"> + <span class="kind">var</span> + <span class="symbol"> + <span class="name">rotation0</span><span class="result">: <span class="extype" name="scala.Double">Double</span></span> + </span> + </h4> + <p class="shortcomment cmt">Initial rotation</p><div class="fullcomment"> + <div class="comment cmt"><p>Initial rotation. Rotation of this shape before it was added to a body.</p></div> + + + <div class="block"> + definition classes: <a href="Shape.html">Shape</a> + </div> + + </div> + </li><li name="sims.geometry.ConvexPolygon#sides"> + <h4 class="signature"> + <span class="kind">def</span> + <span class="symbol"> + <span class="name">sides</span><span class="result">: <span class="extype" name="scala.Array">Array</span>[<a href="../geometry/Segment.html" class="extype" name="sims.geometry.Segment">Segment</a>]</span> + </span> + </h4> + <p class="shortcomment cmt">Returns all sides of this polygon</p><div class="fullcomment"> + <div class="comment cmt"><p>Returns all sides of this polygon. The sides are ordered counter-clockwise, the first vertex of the side +giving the side index.</p></div> + + + <div class="block"> + definition classes: <a href="../geometry/ConvexPolygon.html">ConvexPolygon</a> + </div> + + </div> + </li><li name="sims.dynamics.Rectangle#toString"> + <h4 class="signature"> + <span class="kind">def</span> + <span class="symbol"> + <span class="name">toString</span><span class="params">()</span><span class="result">: <span class="extype" name="java.lang.String">String</span></span> + </span> + </h4> + <p class="shortcomment cmt">Returns a string representation of the object</p><div class="fullcomment"> + <div class="comment cmt"><p>Returns a string representation of the object. +<p> +The default representation is platform dependent. +</p></div> + + + + + </div> + </li><li name="sims.dynamics.Shape#transientShapes"> + <h4 class="signature"> + <span class="kind">val</span> + <span class="symbol"> + <span class="name">transientShapes</span><span class="result">: <span class="extype" name="scala.collection.mutable.Set">Set</span>[<a href="Shape.html" class="extype" name="sims.dynamics.Shape">Shape</a>]</span> + </span> + </h4> + <p class="shortcomment cmt">Shapes with which this shape cannot collide</p><div class="fullcomment"> + <div class="comment cmt"><p>Shapes with which this shape cannot collide.</p></div> + + + <div class="block"> + definition classes: <a href="Shape.html">Shape</a> + </div> + + </div> + </li><li name="sims.dynamics.Shape#uid"> + <h4 class="signature"> + <span class="kind">val</span> + <span class="symbol"> + <span class="name">uid</span><span class="result">: <span class="extype" name="scala.Int">Int</span></span> + </span> + </h4> + <p class="shortcomment cmt">Unique identification number</p><div class="fullcomment"> + <div class="comment cmt"><p>Unique identification number.</p></div> + + + <div class="block"> + definition classes: <a href="Shape.html">Shape</a> + </div> + + </div> + </li><li name="sims.dynamics.Rectangle#vertices"> + <h4 class="signature"> + <span class="kind">def</span> + <span class="symbol"> + <span class="name">vertices</span><span class="result">: <span class="extype" name="scala.collection.Seq">Seq</span>[<a href="../geometry/Vector2D.html" class="extype" name="sims.geometry.Vector2D">Vector2D</a>]</span> + </span> + </h4> + <p class="shortcomment cmt">Returns the position vectors of this rectangle's vertices</p><div class="fullcomment"> + <div class="comment cmt"><p>Returns the position vectors of this rectangle's vertices. +The first vertex is the upper-right vertex at a rotation of 0. +Vertices are ordered counter-clockwise.@return position vectors of the vertices</p></div> + + + + + </div> + </li><li name="sims.dynamics.Rectangle#volume"> + <h4 class="signature"> + <span class="kind">val</span> + <span class="symbol"> + <span class="name">volume</span><span class="result">: <span class="extype" name="scala.Double">Double</span></span> + </span> + </h4> + <p class="shortcomment cmt">Volume</p><div class="fullcomment"> + <div class="comment cmt"><p>Volume. The volume is actually equivalent to this shape's area (SiMS is in 2D) +and is used with this shape's density to calculate its mass.</p></div> + + + + + </div> + </li><li name="sims.dynamics.Shape#~"> + <h4 class="signature"> + <span class="kind">def</span> + <span class="symbol"> + <span class="name">~</span><span class="params">(<span name="b">b: <a href="Body.html" class="extype" name="sims.dynamics.Body">Body</a></span>)</span><span class="result">: <a href="Body.html" class="extype" name="sims.dynamics.Body">Body</a></span> + </span> + </h4> + <p class="shortcomment cmt">Creates a new body out of this shape and the shapes of body <code>b</code></p><div class="fullcomment"> + <div class="comment cmt"><p>Creates a new body out of this shape and the shapes of body <code>b</code>.</p></div> + + + <div class="block"> + definition classes: <a href="Shape.html">Shape</a> + </div> + + </div> + </li><li name="sims.dynamics.Shape#~"> + <h4 class="signature"> + <span class="kind">def</span> + <span class="symbol"> + <span class="name">~</span><span class="params">(<span name="s">s: <a href="Shape.html" class="extype" name="sims.dynamics.Shape">Shape</a></span>)</span><span class="result">: <a href="Body.html" class="extype" name="sims.dynamics.Body">Body</a></span> + </span> + </h4> + <p class="shortcomment cmt">Creates a new body out of this shape and the shape <code>s</code></p><div class="fullcomment"> + <div class="comment cmt"><p>Creates a new body out of this shape and the shape <code>s</code>.</p></div> + + + <div class="block"> + definition classes: <a href="Shape.html">Shape</a> + </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.dynamics.Rectangle#this"> + <h4 class="signature"> + <span class="kind">new</span> + <span class="symbol"> + <span class="name">Rectangle</span><span class="params">(<span name="halfWidth">halfWidth: <span class="extype" name="scala.Double">Double</span></span>, <span name="halfHeight">halfHeight: <span class="extype" name="scala.Double">Double</span></span>, <span name="density">density: <span class="extype" name="scala.Double">Double</span></span>)</span> + </span> + </h4> + + </li><li name="sims.dynamics.Shape#this"> + <h4 class="signature"> + <span class="kind">new</span> + <span class="symbol"> + <span class="name">Rectangle</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/dynamics/RegularPolygon$object.html b/doc/sims/dynamics/RegularPolygon$object.html deleted file mode 100644 index b2d8a0e..0000000 --- a/doc/sims/dynamics/RegularPolygon$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 RegularPolygon in sims.dynamics</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/dynamics$package.html" target="_self">sims.dynamics</a> - <br></br> - <span class="entity">object RegularPolygon</span> - </div><hr></hr> - <div class="source"> - [source: <a href="" class="sims/dynamics/RegularPolygon"><code>sims/dynamics/RegularPolygon.scala</code></a>] - </div><hr></hr> - <a name="RegularPolygon"></a><dl> - <dt> - - <code></code> - <code>object</code> - <em>RegularPolygon</em> - </dt> - <dd><code> extends </code>(<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="http://www.scala-lang.org/docu/files/api/scala/Double.html" target="_self">Double</a>) => <a href="../../sims/dynamics/RegularPolygon.html" target="_self">RegularPolygon</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/dynamics/RegularPolygon.html b/doc/sims/dynamics/RegularPolygon.html index e691f51..b0e8cc9 100644 --- a/doc/sims/dynamics/RegularPolygon.html +++ b/doc/sims/dynamics/RegularPolygon.html @@ -1,421 +1,588 @@ -<!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 RegularPolygon in sims.dynamics</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.dynamics.RegularPolygon</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/dynamics$package.html" target="_self">sims.dynamics</a> - <br></br> - <span class="entity">class RegularPolygon</span> - </div><hr></hr> - <div class="source"> - [source: <a href="" class="sims/dynamics/RegularPolygon"><code>sims/dynamics/RegularPolygon.scala</code></a>] - </div><hr></hr> - <a name="RegularPolygon"></a><dl> - <dt> - - <code>case</code> - <code>class</code> - <em>RegularPolygon</em>(<code>val </code><em>n</em> : <a href="http://www.scala-lang.org/docu/files/api/scala/Int.html" target="_self">Int</a>, <code>val </code><em>radius</em> : <a href="http://www.scala-lang.org/docu/files/api/scala/Double.html" target="_self">Double</a>, <code>val </code><em>density</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="../../sims/dynamics/Shape.html" target="_self">Shape</a><code> with </code><a href="../../sims/geometry/ConvexPolygon.html" target="_self">ConvexPolygon</a><code> with </code><a href="" target="contentFrame" class="scala/Product">scala.Product</a></dd> - </dl> - <dl><dd>A regular polygon with <code>n</code> sides whose excircle has a radius <code>radius</code>.</dd></dl> - <dl><dt style="margin:10px 0 0 20px;"> - <b>Parameters</b></dt><dd><code>n - </code>nmber of sides.</dd><dd><code>radius - </code>radius of the excircle</dd><dd><code>density - </code>density of this regular polygon</dd><dt style="margin:10px 0 0 20px;"> - <b>Throws</b></dt><dd><code>IllegalArgumentException - </code>if <code>n</code> is smaller than 3</dd></dl> - <dl> - <dt style="margin:10px 0 0 20px;"><b>Direct Known Subclasses:</b></dt> - <dd><a href="../../graphyx/graphics/GraphicalRegularPolygon.html" target="_self">GraphicalRegularPolygon</a></dd> - </dl><hr></hr> + <body class="type"> + <p id="owner"><a href="../package.html">sims</a>.<a href="package.html">dynamics</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/dynamics/RegularPolygon.html#I" target="_self">I</a></em> - : <a href="http://www.scala-lang.org/docu/files/api/scala/Double.html" target="_self">Double</a> - - <div>Moment of inertia for a rotation about this shape's COM.</div> - </td> - </tr> -<tr> - <td class="modifiers" valign="top"> - <code> val</code> - </td> - <td class="signature"> - <em><a href="../../sims/dynamics/RegularPolygon.html#volume" target="_self">volume</a></em> - : <a href="http://www.scala-lang.org/docu/files/api/scala/Double.html" target="_self">Double</a> - - <div>Volume. The volume is actually equivalent to this shape's area (SiMS is in 2D)
- and is used with this shape's density to calculate its mass.</div> - </td> - </tr> - </table><table summary="" cellpadding="3" class="inherited"> - <tr><td class="title" colspan="2"> - Values and Variables inherited from <a href="../../sims/dynamics/Shape.html" target="_self">Shape</a> - </td></tr> - <tr><td class="signature" colspan="2"> - <a href="../../sims/dynamics/Shape.html#uid" target="_self">uid</a>, <a href="../../sims/dynamics/Shape.html#collidable" target="_self">collidable</a>, <a href="../../sims/dynamics/Shape.html#restitution" target="_self">restitution</a>, <a href="../../sims/dynamics/Shape.html#friction" target="_self">friction</a>, <a href="../../sims/dynamics/Shape.html#pos" target="_self">pos</a>, <a href="../../sims/dynamics/Shape.html#rotation" target="_self">rotation</a>, <a href="../../sims/dynamics/Shape.html#rotation0" target="_self">rotation0</a>, <a href="../../sims/dynamics/Shape.html#refLocalPos" target="_self">refLocalPos</a>, <a href="../../sims/dynamics/Shape.html#transientShapes" target="_self">transientShapes</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/dynamics/RegularPolygon.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> def</code> - </td> - <td class="signature"> - <em><a href="../../sims/dynamics/RegularPolygon.html#halfDiags" target="_self">halfDiags</a></em> - : <a href="" target="contentFrame" class="scala/Array">scala.Array</a>[<a href="../../sims/geometry/Vector2D.html" target="_self">Vector2D</a>] - - - </td> - </tr> -<tr> - <td class="modifiers" valign="top"> - <code>override def</code> - </td> - <td class="signature"> - <em><a href="../../sims/dynamics/RegularPolygon.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/dynamics/RegularPolygon.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/dynamics/RegularPolygon.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/dynamics/RegularPolygon.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/dynamics/RegularPolygon.html#toString%28%29" target="_self">toString</a></em> - : <a href="" target="contentFrame" class="java/lang/String">java.lang.String</a> - - <div>Returns a string representation of the object.</div> - </td> - </tr> -<tr> - <td class="modifiers" valign="top"> - <code> def</code> - </td> - <td class="signature"> - <em><a href="../../sims/dynamics/RegularPolygon.html#vertices" target="_self">vertices</a></em> - : <a href="" target="contentFrame" class="scala/Array">scala.Array</a>[<a href="../../sims/geometry/Vector2D.html" target="_self">Vector2D</a>] - - <div>Returns positions of all vertices of this Polygon. Vertices are ordered counter-clockwise.</div> - </td> - </tr> - </table><table summary="" cellpadding="3" class="inherited"> - <tr><td class="title" colspan="2"> - Methods inherited from <a href="../../sims/geometry/ConvexPolygon.html" target="_self">ConvexPolygon</a> - </td></tr> - <tr><td class="signature" colspan="2"> - <a href="../../sims/geometry/ConvexPolygon.html#sides" target="_self">sides</a>, <a href="../../sims/geometry/ConvexPolygon.html#project%28sims.geometry.Vector2D%29" target="_self">project</a>, <a href="../../sims/geometry/ConvexPolygon.html#AABB" target="_self">AABB</a>, <a href="../../sims/geometry/ConvexPolygon.html#contains%28sims.geometry.Vector2D%29" target="_self">contains</a> - </td></tr> - </table><table summary="" cellpadding="3" class="inherited"> - <tr><td class="title" colspan="2"> - Methods inherited from <a href="../../sims/dynamics/Shape.html" target="_self">Shape</a> - </td></tr> - <tr><td class="signature" colspan="2"> - <a href="../../sims/dynamics/Shape.html#mass" target="_self">mass</a>, <a href="../../sims/dynamics/Shape.html#body" target="_self">body</a>, <a href="../../sims/dynamics/Shape.html#asBody" target="_self">asBody</a>, <a href="../../sims/dynamics/Shape.html#%7E%28sims.dynamics.Shape%29" target="_self">~</a>, <a href="../../sims/dynamics/Shape.html#%7E%28sims.dynamics.Body%29" target="_self">~</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>RegularPolygon</h1> + </div> + <h4 class="signature"> + <span class="kind">class</span> + <span class="symbol"> + <span class="name">RegularPolygon</span><span class="params">(<span name="n">n: <span class="extype" name="scala.Int">Int</span></span>, <span name="radius">radius: <span class="extype" name="scala.Double">Double</span></span>, <span name="density">density: <span class="extype" name="scala.Double">Double</span></span>)</span><span class="result"> extends <a href="Shape.html" class="extype" name="sims.dynamics.Shape">Shape</a> with <a href="../geometry/ConvexPolygon.html" class="extype" name="sims.geometry.ConvexPolygon">ConvexPolygon</a> with <span class="extype" name="scala.Product">Product</span></span> + </span> + </h4> + <div class="fullcomment" id="comment"> + <div class="comment cmt"><p>A regular polygon with <code>n</code> sides whose excircle has a radius <code>radius</code>.</p></div> + <dl class="paramcmts block"><dt class="param">n</dt><dd class="cmt"><p>nmber of sides.</p></dd><dt class="param">radius</dt><dd class="cmt"><p>radius of the excircle</p></dd><dt class="param">density</dt><dd class="cmt"><p>density of this regular polygon</p></dd></dl> - -<table summary="" cellpadding="3" class="member-detail"> - <tr><td class="title">Value Details</td></tr> - </table><div><a name="volume"></a><dl> - <dt> - - <code></code> - <code>val</code> - <em>volume</em> : <a href="http://www.scala-lang.org/docu/files/api/scala/Double.html" target="_self">Double</a> - </dt> - <dd></dd> - </dl> - <dl><dd>Volume. The volume is actually equivalent to this shape's area (SiMS is in 2D)
- and is used with this shape's density to calculate its mass.</dd></dl> - <dl></dl> - <dl> - <dt style="margin:10px 0 0 20px;"> - <b>Overrides</b> - </dt> - <dd> - <a href="../../sims/dynamics/Shape.html" target="_self">Shape</a>.<a href="../../sims/dynamics/Shape.html#volume" target="_self">volume</a> - </dd> - </dl><hr></hr> -<a name="I"></a><dl> - <dt> - - <code></code> - <code>val</code> - <em>I</em> : <a href="http://www.scala-lang.org/docu/files/api/scala/Double.html" target="_self">Double</a> - </dt> - <dd></dd> - </dl> - <dl><dd>Moment of inertia for a rotation about this shape's COM.</dd></dl> - <dl></dl> - <dl> - <dt style="margin:10px 0 0 20px;"> - <b>Overrides</b> - </dt> - <dd> - <a href="../../sims/dynamics/Shape.html" target="_self">Shape</a>.<a href="../../sims/dynamics/Shape.html#I" target="_self">I</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="halfDiags"></a><dl> - <dt> - - <code></code> - <code>def</code> - <em>halfDiags</em> : <a href="" target="contentFrame" class="scala/Array">scala.Array</a>[<a href="../../sims/geometry/Vector2D.html" target="_self">Vector2D</a>] - </dt> - <dd></dd> - </dl><hr></hr> -<a name="vertices"></a><dl> - <dt> - - <code></code> - <code>def</code> - <em>vertices</em> : <a href="" target="contentFrame" class="scala/Array">scala.Array</a>[<a href="../../sims/geometry/Vector2D.html" target="_self">Vector2D</a>] - </dt> - <dd></dd> - </dl> - <dl><dd>Returns positions of all vertices of this Polygon. Vertices are ordered counter-clockwise.</dd></dl> - <dl><dt style="margin:10px 0 0 20px;"> - <b>Returns</b></dt><dd>position vectors of the vertices</dd></dl> - <dl> - <dt style="margin:10px 0 0 20px;"> - <b>Overrides</b> - </dt> - <dd> - <a href="../../sims/geometry/ConvexPolygon.html" target="_self">ConvexPolygon</a>.<a href="../../sims/geometry/ConvexPolygon.html#vertices" target="_self">vertices</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> - <hr></hr> -<a name="toString%28%29"></a><dl> - <dt> + + <div class="block"> + known subclasses: <a href="../../graphyx/graphics/GraphicalRegularPolygon.html">GraphicalRegularPolygon</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="sims.geometry.ConvexPolygon">ConvexPolygon</li><li class="in" name="sims.dynamics.Shape">Shape</li><li class="in" name="scala.AnyRef">AnyRef</li><li class="in" name="scala.Any">Any</li></ol> + </div> + </div> - <code>override</code> - <code>def</code> - <em>toString</em> : <a href="" target="contentFrame" class="java/lang/String">java.lang.String</a> - </dt> - <dd></dd> - </dl> - <dl><dd>Returns a string representation of the object.
- <p>
- The default representation is platform dependent.</dd></dl> - <dl><dt style="margin:10px 0 0 20px;"> - <b>Returns</b></dt><dd>a string representation of the object. </p></dd></dl> - <hr></hr> -<a name="equals%28Any%29"></a><dl> - <dt> - <code>override</code> - <code>def</code> - <em>equals</em>(<em>arg0</em> : <a href="http://www.scala-lang.org/docu/files/api/scala/Any.html" target="_self">Any</a>) : <a href="http://www.scala-lang.org/docu/files/api/scala/Boolean.html" target="_self">Boolean</a> - </dt> - <dd></dd> - </dl> - <dl><dd>This method is used to compare the receiver object (<code>this</code>)
- with the argument object (<code>arg0</code>) for equivalence.
-
- <p>
- The default implementations of this method is an <a
- href="http://en.wikipedia.org/wiki/Equivalence_relation">equivalence
- relation</a>:
- <ul>
- <li>It is reflexive: for any instance <code>x</code> of type <code>Any</code>,
- <code>x.equals(x)</code> should return <code>true</code>.</li>
- <li>It is symmetric: for any instances <code>x</code> and <code>y</code> of type
- <code>Any</code>, <code>x.equals(y)</code> should return <code>true</code> if and only
- if <code>y.equals(x)</code> returns <code>true</code>.</li>
- <li>It is transitive: for any instances
- <code>x</code>, <code>y</code>, and <code>z</code> of type <code>AnyRef</code>
- if <code>x.equals(y)</code> returns <code>true</code> and
- <code>y.equals(z)</code> returns
- <code>true</code>, then <code>x.equals(z)</code> should return <code>true</code>.</li>
- </ul>
- </p>
- <p>
- If you override this method, you should verify that
- your implementation remains an equivalence relation.
- Additionally, when overriding this method it is often necessary to
- override <code>hashCode</code> to ensure that objects that are
- "equal" (<code>o1.equals(o2)</code> returns <code>true</code>)
- hash to the same <a href="Int.html"><code>Int</code></a>
- (<code>o1.hashCode.equals(o2.hashCode)</code>).</dd></dl> - <dl><dt style="margin:10px 0 0 20px;"> - <b>Parameters</b></dt><dd><code>arg0 - </code>the object to compare against this object for equality.</dd><dt style="margin:10px 0 0 20px;"> - <b>Returns</b></dt><dd><code>true</code> if the receiver object is equivalent to the argument; <code>false</code> otherwise. </p></dd></dl> - <hr></hr> -<a name="productPrefix"></a><dl> - <dt> - <code>override</code> - <code>def</code> - <em>productPrefix</em> : <a href="" target="contentFrame" class="java/lang/String">java.lang.String</a> - </dt> - <dd></dd> - </dl><dl> - <dt style="margin:10px 0 0 20px;"> - <b>Overrides</b> - </dt> - <dd> - <a href="" target="contentFrame" class="scala/Product">scala.Product</a>.<a href="#productPrefix" target="contentFrame" class="scala/Product">scala.Product.productPrefix</a> - </dd> - </dl><hr></hr> -<a name="productArity"></a><dl> - <dt> + <div class="members" id="values"> + <h3>Value Members</h3> + <ol><li name="sims.geometry.ConvexPolygon#AABB"> + <h4 class="signature"> + <span class="kind">def</span> + <span class="symbol"> + <span class="name">AABB</span><span class="result">: <a href="../collision/AABB.html" class="extype" name="sims.collision.AABB">AABB</a></span> + </span> + </h4> + <p class="shortcomment cmt">Returns this polygon's axis aligned bounding box</p><div class="fullcomment"> + <div class="comment cmt"><p>Returns this polygon's axis aligned bounding box.</p></div> + + + <div class="block"> + definition classes: <a href="../geometry/ConvexPolygon.html">ConvexPolygon</a> + </div> + + </div> + </li><li name="sims.dynamics.RegularPolygon#I"> + <h4 class="signature"> + <span class="kind">val</span> + <span class="symbol"> + <span class="name">I</span><span class="result">: <span class="extype" name="scala.Double">Double</span></span> + </span> + </h4> + <p class="shortcomment cmt">Moment of inertia for a rotation about this shape's COM</p><div class="fullcomment"> + <div class="comment cmt"><p>Moment of inertia for a rotation about this shape's COM.</p></div> + + + + + </div> + </li><li name="sims.dynamics.Shape#asBody"> + <h4 class="signature"> + <span class="kind">def</span> + <span class="symbol"> + <span class="name">asBody</span><span class="result">: <a href="Body.html" class="extype" name="sims.dynamics.Body">Body</a></span> + </span> + </h4> + <p class="shortcomment cmt">Creates a new body made out of tis shape</p><div class="fullcomment"> + <div class="comment cmt"><p>Creates a new body made out of tis shape.</p></div> + + + <div class="block"> + definition classes: <a href="Shape.html">Shape</a> + </div> + + </div> + </li><li name="sims.dynamics.Shape#body"> + <h4 class="signature"> + <span class="kind">def</span> + <span class="symbol"> + <span class="name">body</span><span class="result">: <a href="Body.html" class="extype" name="sims.dynamics.Body">Body</a></span> + </span> + </h4> + <p class="shortcomment cmt">Returns this shape's containing body</p><div class="fullcomment"> + <div class="comment cmt"><p>Returns this shape's containing body.</p></div> + + + <div class="block"> + definition classes: <a href="Shape.html">Shape</a> + </div> + + </div> + </li><li name="sims.dynamics.RegularPolygon#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.dynamics.Shape#collidable"> + <h4 class="signature"> + <span class="kind">var</span> + <span class="symbol"> + <span class="name">collidable</span><span class="result">: <span class="extype" name="scala.Boolean">Boolean</span></span> + </span> + </h4> + <p class="shortcomment cmt">Flag determining this shapes ability to collide with other shapes</p><div class="fullcomment"> + <div class="comment cmt"><p>Flag determining this shapes ability to collide with other shapes.</p></div> + + + <div class="block"> + definition classes: <a href="Shape.html">Shape</a> + </div> + + </div> + </li><li name="sims.geometry.ConvexPolygon#contains"> + <h4 class="signature"> + <span class="kind">def</span> + <span class="symbol"> + <span class="name">contains</span><span class="params">(<span name="point">point: <a href="../geometry/Vector2D.html" class="extype" name="sims.geometry.Vector2D">Vector2D</a></span>)</span><span class="result">: <span class="extype" name="scala.Boolean">Boolean</span></span> + </span> + </h4> + <p class="shortcomment cmt">Checks if the point <code>point</code> is contained in this polygon</p><div class="fullcomment"> + <div class="comment cmt"><p>Checks if the point <code>point</code> is contained in this polygon. +<p> +A ray is created, originating from the point and following an arbitrary direction (X-Axis was chosen). +The number of intersections between the ray and this polygon's sides (including vertices) is counted. +The amount of intersections with vertices is substracted form the previuos number. +If the latter number is odd, the point is contained in the polygon.</p></div> + + + <div class="block"> + definition classes: <a href="../geometry/ConvexPolygon.html">ConvexPolygon</a> + </div> + + </div> + </li><li name="sims.dynamics.RegularPolygon#density"> + <h4 class="signature"> + <span class="kind">val</span> + <span class="symbol"> + <span class="name">density</span><span class="result">: <span class="extype" name="scala.Double">Double</span></span> + </span> + </h4> + <p class="shortcomment cmt">Density</p><div class="fullcomment"> + <div class="comment cmt"><p>Density. (Mass per area)</p></div> + + + + + </div> + </li><li name="sims.dynamics.RegularPolygon#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.dynamics.Shape#friction"> + <h4 class="signature"> + <span class="kind">var</span> + <span class="symbol"> + <span class="name">friction</span><span class="result">: <span class="extype" name="scala.Double">Double</span></span> + </span> + </h4> + <p class="shortcomment cmt">Part of the coefficient of friction for a collision between this shape and another</p><div class="fullcomment"> + <div class="comment cmt"><p>Part of the coefficient of friction for a collision between this shape and another. +The coefficient of friction is calculated out of the product of this part and the other shape's part.</p></div> + + + <div class="block"> + definition classes: <a href="Shape.html">Shape</a> + </div> + + </div> + </li><li name="sims.dynamics.RegularPolygon#halfDiags"> + <h4 class="signature"> + <span class="kind">def</span> + <span class="symbol"> + <span class="name">halfDiags</span><span class="result">: <span class="extype" name="scala.Array">Array</span>[<a href="../geometry/Vector2D.html" class="extype" name="sims.geometry.Vector2D">Vector2D</a>]</span> + </span> + </h4> + + </li><li name="sims.dynamics.RegularPolygon#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.dynamics.Shape#mass"> + <h4 class="signature"> + <span class="kind">def</span> + <span class="symbol"> + <span class="name">mass</span><span class="result">: <span class="extype" name="scala.Double">Double</span></span> + </span> + </h4> + <p class="shortcomment cmt">Returns the mass of this shape</p><div class="fullcomment"> + <div class="comment cmt"><p>Returns the mass of this shape. The mass is given by volume times density.</p></div> + + + <div class="block"> + definition classes: <a href="Shape.html">Shape</a> + </div> + + </div> + </li><li name="sims.dynamics.RegularPolygon#n"> + <h4 class="signature"> + <span class="kind">val</span> + <span class="symbol"> + <span class="name">n</span><span class="result">: <span class="extype" name="scala.Int">Int</span></span> + </span> + </h4> + + </li><li name="sims.dynamics.Shape#pos"> + <h4 class="signature"> + <span class="kind">var</span> + <span class="symbol"> + <span class="name">pos</span><span class="result">: <a href="../geometry/Vector2D.html" class="extype" name="sims.geometry.Vector2D">Vector2D</a></span> + </span> + </h4> + <p class="shortcomment cmt">Position of this shape's COM (in world coordinates)</p><div class="fullcomment"> + <div class="comment cmt"><p>Position of this shape's COM (in world coordinates).</p></div> + + + <div class="block"> + definition classes: <a href="Shape.html">Shape</a> + </div> + + </div> + </li><li name="sims.dynamics.RegularPolygon#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.dynamics.RegularPolygon#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.dynamics.RegularPolygon#productPrefix"> + <h4 class="signature"> + <span class="kind">def</span> + <span class="symbol"> + <span class="name">productPrefix</span><span class="result">: <span class="extype" name="java.lang.String">String</span></span> + </span> + </h4> + + </li><li name="sims.geometry.ConvexPolygon#project"> + <h4 class="signature"> + <span class="kind">def</span> + <span class="symbol"> + <span class="name">project</span><span class="params">(<span name="axis">axis: <a href="../geometry/Vector2D.html" class="extype" name="sims.geometry.Vector2D">Vector2D</a></span>)</span><span class="result">: <a href="../geometry/Projection.html" class="extype" name="sims.geometry.Projection">Projection</a></span> + </span> + </h4> + <p class="shortcomment cmt">Returns the projection of this polygon onto the line given by the directional vector <code>axis</code></p><div class="fullcomment"> + <div class="comment cmt"><p>Returns the projection of this polygon onto the line given by the directional vector <code>axis</code>.</p></div> + <dl class="paramcmts block"><dt class="param">axis</dt><dd class="cmt"><p>directional vector of the line</p></dd><dt>returns</dt><dd class="cmt"><p>projection of this polygon</p></dd></dl> + + <div class="block"> + definition classes: <a href="../geometry/ConvexPolygon.html">ConvexPolygon</a> + </div> + + </div> + </li><li name="sims.dynamics.RegularPolygon#radius"> + <h4 class="signature"> + <span class="kind">val</span> + <span class="symbol"> + <span class="name">radius</span><span class="result">: <span class="extype" name="scala.Double">Double</span></span> + </span> + </h4> + + </li><li name="sims.dynamics.Shape#refLocalPos"> + <h4 class="signature"> + <span class="kind">var</span> + <span class="symbol"> + <span class="name">refLocalPos</span><span class="result">: <a href="../geometry/Vector2D.html" class="extype" name="sims.geometry.Vector2D">Vector2D</a></span> + </span> + </h4> + <p class="shortcomment cmt">Local position of this shape's body COM to its COM at a body rotation of zero</p><div class="fullcomment"> + <div class="comment cmt"><p>Local position of this shape's body COM to its COM at a body rotation of zero.</p></div> + + + <div class="block"> + definition classes: <a href="Shape.html">Shape</a> + </div> + + </div> + </li><li name="sims.dynamics.Shape#restitution"> + <h4 class="signature"> + <span class="kind">var</span> + <span class="symbol"> + <span class="name">restitution</span><span class="result">: <span class="extype" name="scala.Double">Double</span></span> + </span> + </h4> + <p class="shortcomment cmt">Part of the coefficient of restitution for a collision between this shape and another</p><div class="fullcomment"> + <div class="comment cmt"><p>Part of the coefficient of restitution for a collision between this shape and another. +The coefficient of restitution is calculated out of the product of this part and the other shape's part.</p></div> + + + <div class="block"> + definition classes: <a href="Shape.html">Shape</a> + </div> + + </div> + </li><li name="sims.dynamics.Shape#rotation"> + <h4 class="signature"> + <span class="kind">var</span> + <span class="symbol"> + <span class="name">rotation</span><span class="result">: <span class="extype" name="scala.Double">Double</span></span> + </span> + </h4> + <p class="shortcomment cmt">Rotation of this shape about its COM</p><div class="fullcomment"> + <div class="comment cmt"><p>Rotation of this shape about its COM.</p></div> + + + <div class="block"> + definition classes: <a href="Shape.html">Shape</a> + </div> + + </div> + </li><li name="sims.dynamics.Shape#rotation0"> + <h4 class="signature"> + <span class="kind">var</span> + <span class="symbol"> + <span class="name">rotation0</span><span class="result">: <span class="extype" name="scala.Double">Double</span></span> + </span> + </h4> + <p class="shortcomment cmt">Initial rotation</p><div class="fullcomment"> + <div class="comment cmt"><p>Initial rotation. Rotation of this shape before it was added to a body.</p></div> + + + <div class="block"> + definition classes: <a href="Shape.html">Shape</a> + </div> + + </div> + </li><li name="sims.geometry.ConvexPolygon#sides"> + <h4 class="signature"> + <span class="kind">def</span> + <span class="symbol"> + <span class="name">sides</span><span class="result">: <span class="extype" name="scala.Array">Array</span>[<a href="../geometry/Segment.html" class="extype" name="sims.geometry.Segment">Segment</a>]</span> + </span> + </h4> + <p class="shortcomment cmt">Returns all sides of this polygon</p><div class="fullcomment"> + <div class="comment cmt"><p>Returns all sides of this polygon. The sides are ordered counter-clockwise, the first vertex of the side +giving the side index.</p></div> + + + <div class="block"> + definition classes: <a href="../geometry/ConvexPolygon.html">ConvexPolygon</a> + </div> + + </div> + </li><li name="sims.dynamics.RegularPolygon#toString"> + <h4 class="signature"> + <span class="kind">def</span> + <span class="symbol"> + <span class="name">toString</span><span class="params">()</span><span class="result">: <span class="extype" name="java.lang.String">String</span></span> + </span> + </h4> + <p class="shortcomment cmt">Returns a string representation of the object</p><div class="fullcomment"> + <div class="comment cmt"><p>Returns a string representation of the object. +<p> +The default representation is platform dependent. +</p></div> + + + + + </div> + </li><li name="sims.dynamics.Shape#transientShapes"> + <h4 class="signature"> + <span class="kind">val</span> + <span class="symbol"> + <span class="name">transientShapes</span><span class="result">: <span class="extype" name="scala.collection.mutable.Set">Set</span>[<a href="Shape.html" class="extype" name="sims.dynamics.Shape">Shape</a>]</span> + </span> + </h4> + <p class="shortcomment cmt">Shapes with which this shape cannot collide</p><div class="fullcomment"> + <div class="comment cmt"><p>Shapes with which this shape cannot collide.</p></div> + + + <div class="block"> + definition classes: <a href="Shape.html">Shape</a> + </div> + + </div> + </li><li name="sims.dynamics.Shape#uid"> + <h4 class="signature"> + <span class="kind">val</span> + <span class="symbol"> + <span class="name">uid</span><span class="result">: <span class="extype" name="scala.Int">Int</span></span> + </span> + </h4> + <p class="shortcomment cmt">Unique identification number</p><div class="fullcomment"> + <div class="comment cmt"><p>Unique identification number.</p></div> + + + <div class="block"> + definition classes: <a href="Shape.html">Shape</a> + </div> + + </div> + </li><li name="sims.dynamics.RegularPolygon#vertices"> + <h4 class="signature"> + <span class="kind">def</span> + <span class="symbol"> + <span class="name">vertices</span><span class="result">: <span class="extype" name="scala.collection.Seq">Seq</span>[<a href="../geometry/Vector2D.html" class="extype" name="sims.geometry.Vector2D">Vector2D</a>]</span> + </span> + </h4> + <p class="shortcomment cmt">Returns positions of all vertices of this Polygon</p><div class="fullcomment"> + <div class="comment cmt"><p>Returns positions of all vertices of this Polygon. Vertices are ordered counter-clockwise.</p></div> + + + + + </div> + </li><li name="sims.dynamics.RegularPolygon#volume"> + <h4 class="signature"> + <span class="kind">val</span> + <span class="symbol"> + <span class="name">volume</span><span class="result">: <span class="extype" name="scala.Double">Double</span></span> + </span> + </h4> + <p class="shortcomment cmt">Volume</p><div class="fullcomment"> + <div class="comment cmt"><p>Volume. The volume is actually equivalent to this shape's area (SiMS is in 2D) +and is used with this shape's density to calculate its mass.</p></div> + + + + + </div> + </li><li name="sims.dynamics.Shape#~"> + <h4 class="signature"> + <span class="kind">def</span> + <span class="symbol"> + <span class="name">~</span><span class="params">(<span name="b">b: <a href="Body.html" class="extype" name="sims.dynamics.Body">Body</a></span>)</span><span class="result">: <a href="Body.html" class="extype" name="sims.dynamics.Body">Body</a></span> + </span> + </h4> + <p class="shortcomment cmt">Creates a new body out of this shape and the shapes of body <code>b</code></p><div class="fullcomment"> + <div class="comment cmt"><p>Creates a new body out of this shape and the shapes of body <code>b</code>.</p></div> + + + <div class="block"> + definition classes: <a href="Shape.html">Shape</a> + </div> + + </div> + </li><li name="sims.dynamics.Shape#~"> + <h4 class="signature"> + <span class="kind">def</span> + <span class="symbol"> + <span class="name">~</span><span class="params">(<span name="s">s: <a href="Shape.html" class="extype" name="sims.dynamics.Shape">Shape</a></span>)</span><span class="result">: <a href="Body.html" class="extype" name="sims.dynamics.Body">Body</a></span> + </span> + </h4> + <p class="shortcomment cmt">Creates a new body out of this shape and the shape <code>s</code></p><div class="fullcomment"> + <div class="comment cmt"><p>Creates a new body out of this shape and the shape <code>s</code>.</p></div> + + + <div class="block"> + definition classes: <a href="Shape.html">Shape</a> + </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.dynamics.RegularPolygon#this"> + <h4 class="signature"> + <span class="kind">new</span> + <span class="symbol"> + <span class="name">RegularPolygon</span><span class="params">(<span name="n">n: <span class="extype" name="scala.Int">Int</span></span>, <span name="radius">radius: <span class="extype" name="scala.Double">Double</span></span>, <span name="density">density: <span class="extype" name="scala.Double">Double</span></span>)</span> + </span> + </h4> + + </li><li name="sims.dynamics.Shape#this"> + <h4 class="signature"> + <span class="kind">new</span> + <span class="symbol"> + <span class="name">RegularPolygon</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/dynamics/Shape$.html b/doc/sims/dynamics/Shape$.html new file mode 100644 index 0000000..6cc92c5 --- /dev/null +++ b/doc/sims/dynamics/Shape$.html @@ -0,0 +1,148 @@ +<?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.dynamics.Shape</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">dynamics</a></p> + + <div id="definition"> + <img src="../../lib/object_big.png" /> + <h1>Shape</h1> + </div> + + <h4 class="signature"> + <span class="kind">object</span> + <span class="symbol"> + <span class="name">Shape</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="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/dynamics/Shape$object.html b/doc/sims/dynamics/Shape$object.html deleted file mode 100644 index a90e5ee..0000000 --- a/doc/sims/dynamics/Shape$object.html +++ /dev/null @@ -1,75 +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 Shape in sims.dynamics</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/dynamics$package.html" target="_self">sims.dynamics</a> - <br></br> - <span class="entity">object Shape</span> - </div><hr></hr> - <div class="source"> - [source: <a href="" class="sims/dynamics/Shape"><code>sims/dynamics/Shape.scala</code></a>] - </div><hr></hr> - <a name="Shape"></a><dl> - <dt> - - <code></code> - <code>object</code> - <em>Shape</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="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> - - - - - - - - - <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/dynamics/Shape.html b/doc/sims/dynamics/Shape.html index f769f9b..03db5e1 100644 --- a/doc/sims/dynamics/Shape.html +++ b/doc/sims/dynamics/Shape.html @@ -1,557 +1,458 @@ -<!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 Shape in sims.dynamics</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.dynamics.Shape</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/dynamics$package.html" target="_self">sims.dynamics</a> - <br></br> - <span class="entity">class Shape</span> - </div><hr></hr> - <div class="source"> - [source: <a href="" class="sims/dynamics/Shape"><code>sims/dynamics/Shape.scala</code></a>] - </div><hr></hr> - <a name="Shape"></a><dl> - <dt> - - <code>abstract</code> - <code>class</code> - <em>Shape</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>An abstract shape.</dd></dl> - <dl></dl> - <dl> - <dt style="margin:10px 0 0 20px;"><b>Direct Known Subclasses:</b></dt> - <dd><a href="../../graphyx/graphics/GraphicalShape.html" target="_self">GraphicalShape</a>, <a href="../../sims/dynamics/Circle.html" target="_self">Circle</a>, <a href="../../sims/dynamics/Rectangle.html" target="_self">Rectangle</a>, <a href="../../sims/dynamics/RegularPolygon.html" target="_self">RegularPolygon</a></dd> - </dl><hr></hr> + <body class="type"> + <p id="owner"><a href="../package.html">sims</a>.<a href="package.html">dynamics</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/dynamics/Shape.html#I" target="_self">I</a></em> - : <a href="http://www.scala-lang.org/docu/files/api/scala/Double.html" target="_self">Double</a> - - <div>Moment of inertia for a rotation about this shape's COM.</div> - </td> - </tr> -<tr> - <td class="modifiers" valign="top"> - <code> var</code> - </td> - <td class="signature"> - <em><a href="../../sims/dynamics/Shape.html#collidable" target="_self">collidable</a></em> - : <a href="http://www.scala-lang.org/docu/files/api/scala/Boolean.html" target="_self">Boolean</a> - - <div>Flag determining this shapes ability to collide with other shapes.</div> - </td> - </tr> -<tr> - <td class="modifiers" valign="top"> - <code>abstract val</code> - </td> - <td class="signature"> - <em><a href="../../sims/dynamics/Shape.html#density" target="_self">density</a></em> - : <a href="http://www.scala-lang.org/docu/files/api/scala/Double.html" target="_self">Double</a> - - <div>Density. (Mass per area)</div> - </td> - </tr> -<tr> - <td class="modifiers" valign="top"> - <code> var</code> - </td> - <td class="signature"> - <em><a href="../../sims/dynamics/Shape.html#friction" target="_self">friction</a></em> - : <a href="http://www.scala-lang.org/docu/files/api/scala/Double.html" target="_self">Double</a> - - <div>Part of the coefficient of friction for a collision between this shape and another.
- The coefficient of friction is calculated out of the product of this part and the other shape's part.</div> - </td> - </tr> -<tr> - <td class="modifiers" valign="top"> - <code> var</code> - </td> - <td class="signature"> - <em><a href="../../sims/dynamics/Shape.html#pos" target="_self">pos</a></em> - : <a href="../../sims/geometry/Vector2D.html" target="_self">Vector2D</a> - - <div>Position of this shape's COM (in world coordinates).</div> - </td> - </tr> -<tr> - <td class="modifiers" valign="top"> - <code> var</code> - </td> - <td class="signature"> - <em><a href="../../sims/dynamics/Shape.html#refLocalPos" target="_self">refLocalPos</a></em> - : <a href="../../sims/geometry/Vector2D.html" target="_self">Vector2D</a> - - <div>Local position of this shape's body COM to its COM at a body rotation of zero.</div> - </td> - </tr> -<tr> - <td class="modifiers" valign="top"> - <code> var</code> - </td> - <td class="signature"> - <em><a href="../../sims/dynamics/Shape.html#restitution" target="_self">restitution</a></em> - : <a href="http://www.scala-lang.org/docu/files/api/scala/Double.html" target="_self">Double</a> - - <div>Part of the coefficient of restitution for a collision between this shape and another.
- The coefficient of restitution is calculated out of the product of this part and the other shape's part.</div> - </td> - </tr> -<tr> - <td class="modifiers" valign="top"> - <code> var</code> - </td> - <td class="signature"> - <em><a href="../../sims/dynamics/Shape.html#rotation" target="_self">rotation</a></em> - : <a href="http://www.scala-lang.org/docu/files/api/scala/Double.html" target="_self">Double</a> - - <div>Rotation of this shape about its COM.</div> - </td> - </tr> -<tr> - <td class="modifiers" valign="top"> - <code> var</code> - </td> - <td class="signature"> - <em><a href="../../sims/dynamics/Shape.html#rotation0" target="_self">rotation0</a></em> - : <a href="http://www.scala-lang.org/docu/files/api/scala/Double.html" target="_self">Double</a> - - <div>Initial rotation. Rotation of this shape before it was added to a body.</div> - </td> - </tr> -<tr> - <td class="modifiers" valign="top"> - <code> val</code> - </td> - <td class="signature"> - <em><a href="../../sims/dynamics/Shape.html#transientShapes" target="_self">transientShapes</a></em> - : <a href="" target="contentFrame" class="scala/collection/mutable/Set">scala.collection.mutable.Set</a>[<a href="../../sims/dynamics/Shape.html" target="_self">Shape</a>] - - <div>Shapes with which this shape cannot collide.</div> - </td> - </tr> -<tr> - <td class="modifiers" valign="top"> - <code> val</code> - </td> - <td class="signature"> - <em><a href="../../sims/dynamics/Shape.html#uid" target="_self">uid</a></em> - : <a href="http://www.scala-lang.org/docu/files/api/scala/Int.html" target="_self">Int</a> - - <div>Unique identification number.</div> - </td> - </tr> -<tr> - <td class="modifiers" valign="top"> - <code>abstract val</code> - </td> - <td class="signature"> - <em><a href="../../sims/dynamics/Shape.html#volume" target="_self">volume</a></em> - : <a href="http://www.scala-lang.org/docu/files/api/scala/Double.html" target="_self">Double</a> - - <div>Volume. The volume is actually equivalent to this shape's area (SiMS is in 2D)
- and is used with this shape's density to calculate its mass.</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/dynamics/Shape.html#AABB" target="_self">AABB</a></em> - : <a href="../../sims/collision/AABB.html" target="_self">AABB</a> - - <div>Returns this shape's axis aligned bounding box.</div> - </td> - </tr> -<tr> - <td class="modifiers" valign="top"> - <code> def</code> - </td> - <td class="signature"> - <em><a href="../../sims/dynamics/Shape.html#asBody" target="_self">asBody</a></em> - : <a href="../../sims/dynamics/Body.html" target="_self">Body</a> - - <div>Creates a new body made out of tis shape.</div> - </td> - </tr> -<tr> - <td class="modifiers" valign="top"> - <code> def</code> - </td> - <td class="signature"> - <em><a href="../../sims/dynamics/Shape.html#body" target="_self">body</a></em> - : <a href="../../sims/dynamics/Body.html" target="_self">Body</a> - - <div>Returns this shape's containing body.</div> - </td> - </tr> -<tr> - <td class="modifiers" valign="top"> - <code>abstract def</code> - </td> - <td class="signature"> - <em><a href="../../sims/dynamics/Shape.html#contains%28sims.geometry.Vector2D%29" target="_self">contains</a></em> - (<em>point</em> : <a href="../../sims/geometry/Vector2D.html" target="_self">Vector2D</a>) : <a href="http://www.scala-lang.org/docu/files/api/scala/Boolean.html" target="_self">Boolean</a> - - <div>Checks if the point <code>point</code> is contained in this shape.</div> - </td> - </tr> -<tr> - <td class="modifiers" valign="top"> - <code> def</code> - </td> - <td class="signature"> - <em><a href="../../sims/dynamics/Shape.html#mass" target="_self">mass</a></em> - : <a href="http://www.scala-lang.org/docu/files/api/scala/Double.html" target="_self">Double</a> - - <div>Returns the mass of this shape. The mass is given by volume times density.</div> - </td> - </tr> -<tr> - <td class="modifiers" valign="top"> - <code>abstract def</code> - </td> - <td class="signature"> - <em><a href="../../sims/dynamics/Shape.html#project%28sims.geometry.Vector2D%29" target="_self">project</a></em> - (<em>axis</em> : <a href="../../sims/geometry/Vector2D.html" target="_self">Vector2D</a>) : <a href="../../sims/geometry/Projection.html" target="_self">Projection</a> - - <div>Returns the projection of this shape onto the line given by the directional vector <code>axis</code>.</div> - </td> - </tr> -<tr> - <td class="modifiers" valign="top"> - <code> def</code> - </td> - <td class="signature"> - <em><a href="../../sims/dynamics/Shape.html#%7E%28sims.dynamics.Body%29" target="_self">~</a></em> - (<em>b</em> : <a href="../../sims/dynamics/Body.html" target="_self">Body</a>) : <a href="../../sims/dynamics/Body.html" target="_self">Body</a> - - <div>Creates a new body out of this shape and the shapes of body <code>b</code>.</div> - </td> - </tr> -<tr> - <td class="modifiers" valign="top"> - <code> def</code> - </td> - <td class="signature"> - <em><a href="../../sims/dynamics/Shape.html#%7E%28sims.dynamics.Shape%29" target="_self">~</a></em> - (<em>s</em> : <a href="../../sims/dynamics/Shape.html" target="_self">Shape</a>) : <a href="../../sims/dynamics/Body.html" target="_self">Body</a> - - <div>Creates a new body out of this shape and the shape <code>s</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 id="definition"> + <img src="../../lib/class_big.png" /> + <h1>Shape</h1> + </div> + <h4 class="signature"> + <span class="kind">class</span> + <span class="symbol"> + <span class="name">Shape</span><span class="result"> extends AnyRef</span> + </span> + </h4> + <div class="fullcomment" id="comment"> + <div class="comment cmt"><p>An abstract shape.</p></div> - -<table summary="" cellpadding="3" class="member-detail"> - <tr><td class="title">Value Details</td></tr> - </table><div><a name="uid"></a><dl> - <dt> - - <code></code> - <code>val</code> - <em>uid</em> : <a href="http://www.scala-lang.org/docu/files/api/scala/Int.html" target="_self">Int</a> - </dt> - <dd></dd> - </dl> - <dl><dd>Unique identification number.</dd></dl> - <dl></dl> - <hr></hr> -<a name="collidable"></a><dl> - <dt> - - <code></code> - <code>var</code> - <em>collidable</em> : <a href="http://www.scala-lang.org/docu/files/api/scala/Boolean.html" target="_self">Boolean</a> - </dt> - <dd></dd> - </dl> - <dl><dd>Flag determining this shapes ability to collide with other shapes.</dd></dl> - <dl></dl> - <hr></hr> -<a name="restitution"></a><dl> - <dt> - - <code></code> - <code>var</code> - <em>restitution</em> : <a href="http://www.scala-lang.org/docu/files/api/scala/Double.html" target="_self">Double</a> - </dt> - <dd></dd> - </dl> - <dl><dd>Part of the coefficient of restitution for a collision between this shape and another.
- The coefficient of restitution is calculated out of the product of this part and the other shape's part.</dd></dl> - <dl></dl> - <hr></hr> -<a name="friction"></a><dl> - <dt> - - <code></code> - <code>var</code> - <em>friction</em> : <a href="http://www.scala-lang.org/docu/files/api/scala/Double.html" target="_self">Double</a> - </dt> - <dd></dd> - </dl> - <dl><dd>Part of the coefficient of friction for a collision between this shape and another.
- The coefficient of friction is calculated out of the product of this part and the other shape's part.</dd></dl> - <dl></dl> - <hr></hr> -<a name="pos"></a><dl> - <dt> - - <code></code> - <code>var</code> - <em>pos</em> : <a href="../../sims/geometry/Vector2D.html" target="_self">Vector2D</a> - </dt> - <dd></dd> - </dl> - <dl><dd>Position of this shape's COM (in world coordinates).</dd></dl> - <dl></dl> - <hr></hr> -<a name="rotation"></a><dl> - <dt> - - <code></code> - <code>var</code> - <em>rotation</em> : <a href="http://www.scala-lang.org/docu/files/api/scala/Double.html" target="_self">Double</a> - </dt> - <dd></dd> - </dl> - <dl><dd>Rotation of this shape about its COM.</dd></dl> - <dl></dl> - <hr></hr> -<a name="rotation0"></a><dl> - <dt> - - <code></code> - <code>var</code> - <em>rotation0</em> : <a href="http://www.scala-lang.org/docu/files/api/scala/Double.html" target="_self">Double</a> - </dt> - <dd></dd> - </dl> - <dl><dd>Initial rotation. Rotation of this shape before it was added to a body.</dd></dl> - <dl></dl> - <hr></hr> -<a name="refLocalPos"></a><dl> - <dt> - - <code></code> - <code>var</code> - <em>refLocalPos</em> : <a href="../../sims/geometry/Vector2D.html" target="_self">Vector2D</a> - </dt> - <dd></dd> - </dl> - <dl><dd>Local position of this shape's body COM to its COM at a body rotation of zero.</dd></dl> - <dl></dl> - <hr></hr> -<a name="density"></a><dl> - <dt> - - <code>abstract</code> - <code>val</code> - <em>density</em> : <a href="http://www.scala-lang.org/docu/files/api/scala/Double.html" target="_self">Double</a> - </dt> - <dd></dd> - </dl> - <dl><dd>Density. (Mass per area)</dd></dl> - <dl></dl> - <hr></hr> -<a name="volume"></a><dl> - <dt> - - <code>abstract</code> - <code>val</code> - <em>volume</em> : <a href="http://www.scala-lang.org/docu/files/api/scala/Double.html" target="_self">Double</a> - </dt> - <dd></dd> - </dl> - <dl><dd>Volume. The volume is actually equivalent to this shape's area (SiMS is in 2D)
- and is used with this shape's density to calculate its mass.</dd></dl> - <dl></dl> - <hr></hr> -<a name="I"></a><dl> - <dt> - - <code>abstract</code> - <code>val</code> - <em>I</em> : <a href="http://www.scala-lang.org/docu/files/api/scala/Double.html" target="_self">Double</a> - </dt> - <dd></dd> - </dl> - <dl><dd>Moment of inertia for a rotation about this shape's COM.</dd></dl> - <dl></dl> - <hr></hr> -<a name="transientShapes"></a><dl> - <dt> - - <code></code> - <code>val</code> - <em>transientShapes</em> : <a href="" target="contentFrame" class="scala/collection/mutable/Set">scala.collection.mutable.Set</a>[<a href="../../sims/dynamics/Shape.html" target="_self">Shape</a>] - </dt> - <dd></dd> - </dl> - <dl><dd>Shapes with which this shape cannot collide.</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="mass"></a><dl> - <dt> - - <code></code> - <code>def</code> - <em>mass</em> : <a href="http://www.scala-lang.org/docu/files/api/scala/Double.html" target="_self">Double</a> - </dt> - <dd></dd> - </dl> - <dl><dd>Returns the mass of this shape. The mass is given by volume times density.</dd></dl> - <dl><dt style="margin:10px 0 0 20px;"> - <b>Returns</b></dt><dd>mass of this shape</dd></dl> - <hr></hr> -<a name="body"></a><dl> - <dt> - - <code></code> - <code>def</code> - <em>body</em> : <a href="../../sims/dynamics/Body.html" target="_self">Body</a> - </dt> - <dd></dd> - </dl> - <dl><dd>Returns this shape's containing body.</dd></dl> - <dl></dl> - <hr></hr> -<a name="AABB"></a><dl> - <dt> - - <code>abstract</code> - <code>def</code> - <em>AABB</em> : <a href="../../sims/collision/AABB.html" target="_self">AABB</a> - </dt> - <dd></dd> - </dl> - <dl><dd>Returns this shape's axis aligned bounding box.</dd></dl> - <dl></dl> - <hr></hr> -<a name="project%28sims.geometry.Vector2D%29"></a><dl> - <dt> - - <code>abstract</code> - <code>def</code> - <em>project</em>(<em>axis</em> : <a href="../../sims/geometry/Vector2D.html" target="_self">Vector2D</a>) : <a href="../../sims/geometry/Projection.html" target="_self">Projection</a> - </dt> - <dd></dd> - </dl> - <dl><dd>Returns the projection of this shape onto the line given by the directional vector <code>axis</code>.</dd></dl> - <dl><dt style="margin:10px 0 0 20px;"> - <b>Parameters</b></dt><dd><code>axis - </code>directional vector of the line</dd><dt style="margin:10px 0 0 20px;"> - <b>Returns</b></dt><dd>projection of this shape</dd></dl> - <hr></hr> -<a name="contains%28sims.geometry.Vector2D%29"></a><dl> - <dt> - - <code>abstract</code> - <code>def</code> - <em>contains</em>(<em>point</em> : <a href="../../sims/geometry/Vector2D.html" target="_self">Vector2D</a>) : <a href="http://www.scala-lang.org/docu/files/api/scala/Boolean.html" target="_self">Boolean</a> - </dt> - <dd></dd> - </dl> - <dl><dd>Checks if the point <code>point</code> is contained in this shape.</dd></dl> - <dl></dl> - <hr></hr> -<a name="asBody"></a><dl> - <dt> - - <code></code> - <code>def</code> - <em>asBody</em> : <a href="../../sims/dynamics/Body.html" target="_self">Body</a> - </dt> - <dd></dd> - </dl> - <dl><dd>Creates a new body made out of tis shape.</dd></dl> - <dl><dt style="margin:10px 0 0 20px;"> - <b>Returns</b></dt><dd>a body made out of tis shape</dd></dl> - <hr></hr> -<a name="%7E%28sims.dynamics.Shape%29"></a><dl> - <dt> - - <code></code> - <code>def</code> - <em>~</em>(<em>s</em> : <a href="../../sims/dynamics/Shape.html" target="_self">Shape</a>) : <a href="../../sims/dynamics/Body.html" target="_self">Body</a> - </dt> - <dd></dd> - </dl> - <dl><dd>Creates a new body out of this shape and the shape <code>s</code>.</dd></dl> - <dl></dl> - <hr></hr> -<a name="%7E%28sims.dynamics.Body%29"></a><dl> - <dt> + <div class="block"> + attributes: abstract + </div> + + <div class="block"> + known subclasses: <a href="RegularPolygon.html">RegularPolygon</a>, <a href="Rectangle.html">Rectangle</a>, <a href="Circle.html">Circle</a>, <a href="../../graphyx/graphics/GraphicalShape.html">GraphicalShape</a> + </div> + </div> + + <div id="template"> + + <div id="mbrsel"> + <div id="ancestors"> + <h3>Inherits</h3> + <ol><li class="in" name="scala.AnyRef">AnyRef</li><li class="in" name="scala.Any">Any</li></ol> + </div> + </div> + + + + <div class="members" id="values"> + <h3>Value Members</h3> + <ol><li name="sims.dynamics.Shape#AABB"> + <h4 class="signature"> + <span class="kind">def</span> + <span class="symbol"> + <span class="name">AABB</span><span class="result">: <a href="../collision/AABB.html" class="extype" name="sims.collision.AABB">AABB</a></span> + </span> + </h4> + <p class="shortcomment cmt">Returns this shape's axis aligned bounding box</p><div class="fullcomment"> + <div class="comment cmt"><p>Returns this shape's axis aligned bounding box.</p></div> + + <div class="block"> + attributes: abstract + </div> + + + </div> + </li><li name="sims.dynamics.Shape#I"> + <h4 class="signature"> + <span class="kind">val</span> + <span class="symbol"> + <span class="name">I</span><span class="result">: <span class="extype" name="scala.Double">Double</span></span> + </span> + </h4> + <p class="shortcomment cmt">Moment of inertia for a rotation about this shape's COM</p><div class="fullcomment"> + <div class="comment cmt"><p>Moment of inertia for a rotation about this shape's COM.</p></div> + + <div class="block"> + attributes: abstract + </div> + + + </div> + </li><li name="sims.dynamics.Shape#asBody"> + <h4 class="signature"> + <span class="kind">def</span> + <span class="symbol"> + <span class="name">asBody</span><span class="result">: <a href="Body.html" class="extype" name="sims.dynamics.Body">Body</a></span> + </span> + </h4> + <p class="shortcomment cmt">Creates a new body made out of tis shape</p><div class="fullcomment"> + <div class="comment cmt"><p>Creates a new body made out of tis shape.</p></div> + + + + + </div> + </li><li name="sims.dynamics.Shape#body"> + <h4 class="signature"> + <span class="kind">def</span> + <span class="symbol"> + <span class="name">body</span><span class="result">: <a href="Body.html" class="extype" name="sims.dynamics.Body">Body</a></span> + </span> + </h4> + <p class="shortcomment cmt">Returns this shape's containing body</p><div class="fullcomment"> + <div class="comment cmt"><p>Returns this shape's containing body.</p></div> + + + + + </div> + </li><li name="sims.dynamics.Shape#collidable"> + <h4 class="signature"> + <span class="kind">var</span> + <span class="symbol"> + <span class="name">collidable</span><span class="result">: <span class="extype" name="scala.Boolean">Boolean</span></span> + </span> + </h4> + <p class="shortcomment cmt">Flag determining this shapes ability to collide with other shapes</p><div class="fullcomment"> + <div class="comment cmt"><p>Flag determining this shapes ability to collide with other shapes.</p></div> + + + + + </div> + </li><li name="sims.dynamics.Shape#contains"> + <h4 class="signature"> + <span class="kind">def</span> + <span class="symbol"> + <span class="name">contains</span><span class="params">(<span name="point">point: <a href="../geometry/Vector2D.html" class="extype" name="sims.geometry.Vector2D">Vector2D</a></span>)</span><span class="result">: <span class="extype" name="scala.Boolean">Boolean</span></span> + </span> + </h4> + <p class="shortcomment cmt">Checks if the point <code>point</code> is contained in this shape</p><div class="fullcomment"> + <div class="comment cmt"><p>Checks if the point <code>point</code> is contained in this shape.</p></div> + + <div class="block"> + attributes: abstract + </div> + + + </div> + </li><li name="sims.dynamics.Shape#density"> + <h4 class="signature"> + <span class="kind">val</span> + <span class="symbol"> + <span class="name">density</span><span class="result">: <span class="extype" name="scala.Double">Double</span></span> + </span> + </h4> + <p class="shortcomment cmt">Density</p><div class="fullcomment"> + <div class="comment cmt"><p>Density. (Mass per area)</p></div> + + <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="sims.dynamics.Shape#friction"> + <h4 class="signature"> + <span class="kind">var</span> + <span class="symbol"> + <span class="name">friction</span><span class="result">: <span class="extype" name="scala.Double">Double</span></span> + </span> + </h4> + <p class="shortcomment cmt">Part of the coefficient of friction for a collision between this shape and another</p><div class="fullcomment"> + <div class="comment cmt"><p>Part of the coefficient of friction for a collision between this shape and another. +The coefficient of friction is calculated out of the product of this part and the other shape's part.</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.dynamics.Shape#mass"> + <h4 class="signature"> + <span class="kind">def</span> + <span class="symbol"> + <span class="name">mass</span><span class="result">: <span class="extype" name="scala.Double">Double</span></span> + </span> + </h4> + <p class="shortcomment cmt">Returns the mass of this shape</p><div class="fullcomment"> + <div class="comment cmt"><p>Returns the mass of this shape. The mass is given by volume times density.</p></div> + + + + + </div> + </li><li name="sims.dynamics.Shape#pos"> + <h4 class="signature"> + <span class="kind">var</span> + <span class="symbol"> + <span class="name">pos</span><span class="result">: <a href="../geometry/Vector2D.html" class="extype" name="sims.geometry.Vector2D">Vector2D</a></span> + </span> + </h4> + <p class="shortcomment cmt">Position of this shape's COM (in world coordinates)</p><div class="fullcomment"> + <div class="comment cmt"><p>Position of this shape's COM (in world coordinates).</p></div> + + + + + </div> + </li><li name="sims.dynamics.Shape#project"> + <h4 class="signature"> + <span class="kind">def</span> + <span class="symbol"> + <span class="name">project</span><span class="params">(<span name="axis">axis: <a href="../geometry/Vector2D.html" class="extype" name="sims.geometry.Vector2D">Vector2D</a></span>)</span><span class="result">: <a href="../geometry/Projection.html" class="extype" name="sims.geometry.Projection">Projection</a></span> + </span> + </h4> + <p class="shortcomment cmt">Returns the projection of this shape onto the line given by the directional vector <code>axis</code></p><div class="fullcomment"> + <div class="comment cmt"><p>Returns the projection of this shape onto the line given by the directional vector <code>axis</code>.</p></div> + <dl class="paramcmts block"><dt class="param">axis</dt><dd class="cmt"><p>directional vector of the line</p></dd><dt>returns</dt><dd class="cmt"><p>projection of this shape</p></dd></dl> + <div class="block"> + attributes: abstract + </div> + + + </div> + </li><li name="sims.dynamics.Shape#refLocalPos"> + <h4 class="signature"> + <span class="kind">var</span> + <span class="symbol"> + <span class="name">refLocalPos</span><span class="result">: <a href="../geometry/Vector2D.html" class="extype" name="sims.geometry.Vector2D">Vector2D</a></span> + </span> + </h4> + <p class="shortcomment cmt">Local position of this shape's body COM to its COM at a body rotation of zero</p><div class="fullcomment"> + <div class="comment cmt"><p>Local position of this shape's body COM to its COM at a body rotation of zero.</p></div> + + + + + </div> + </li><li name="sims.dynamics.Shape#restitution"> + <h4 class="signature"> + <span class="kind">var</span> + <span class="symbol"> + <span class="name">restitution</span><span class="result">: <span class="extype" name="scala.Double">Double</span></span> + </span> + </h4> + <p class="shortcomment cmt">Part of the coefficient of restitution for a collision between this shape and another</p><div class="fullcomment"> + <div class="comment cmt"><p>Part of the coefficient of restitution for a collision between this shape and another. +The coefficient of restitution is calculated out of the product of this part and the other shape's part.</p></div> + + + + + </div> + </li><li name="sims.dynamics.Shape#rotation"> + <h4 class="signature"> + <span class="kind">var</span> + <span class="symbol"> + <span class="name">rotation</span><span class="result">: <span class="extype" name="scala.Double">Double</span></span> + </span> + </h4> + <p class="shortcomment cmt">Rotation of this shape about its COM</p><div class="fullcomment"> + <div class="comment cmt"><p>Rotation of this shape about its COM.</p></div> + + + + + </div> + </li><li name="sims.dynamics.Shape#rotation0"> + <h4 class="signature"> + <span class="kind">var</span> + <span class="symbol"> + <span class="name">rotation0</span><span class="result">: <span class="extype" name="scala.Double">Double</span></span> + </span> + </h4> + <p class="shortcomment cmt">Initial rotation</p><div class="fullcomment"> + <div class="comment cmt"><p>Initial rotation. Rotation of this shape before it was added to a body.</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.dynamics.Shape#transientShapes"> + <h4 class="signature"> + <span class="kind">val</span> + <span class="symbol"> + <span class="name">transientShapes</span><span class="result">: <span class="extype" name="scala.collection.mutable.Set">Set</span>[<a href="" class="extype" name="sims.dynamics.Shape">Shape</a>]</span> + </span> + </h4> + <p class="shortcomment cmt">Shapes with which this shape cannot collide</p><div class="fullcomment"> + <div class="comment cmt"><p>Shapes with which this shape cannot collide.</p></div> + + + + + </div> + </li><li name="sims.dynamics.Shape#uid"> + <h4 class="signature"> + <span class="kind">val</span> + <span class="symbol"> + <span class="name">uid</span><span class="result">: <span class="extype" name="scala.Int">Int</span></span> + </span> + </h4> + <p class="shortcomment cmt">Unique identification number</p><div class="fullcomment"> + <div class="comment cmt"><p>Unique identification number.</p></div> + + + + + </div> + </li><li name="sims.dynamics.Shape#volume"> + <h4 class="signature"> + <span class="kind">val</span> + <span class="symbol"> + <span class="name">volume</span><span class="result">: <span class="extype" name="scala.Double">Double</span></span> + </span> + </h4> + <p class="shortcomment cmt">Volume</p><div class="fullcomment"> + <div class="comment cmt"><p>Volume. The volume is actually equivalent to this shape's area (SiMS is in 2D) +and is used with this shape's density to calculate its mass.</p></div> + + <div class="block"> + attributes: abstract + </div> + + + </div> + </li><li name="sims.dynamics.Shape#~"> + <h4 class="signature"> + <span class="kind">def</span> + <span class="symbol"> + <span class="name">~</span><span class="params">(<span name="b">b: <a href="Body.html" class="extype" name="sims.dynamics.Body">Body</a></span>)</span><span class="result">: <a href="Body.html" class="extype" name="sims.dynamics.Body">Body</a></span> + </span> + </h4> + <p class="shortcomment cmt">Creates a new body out of this shape and the shapes of body <code>b</code></p><div class="fullcomment"> + <div class="comment cmt"><p>Creates a new body out of this shape and the shapes of body <code>b</code>.</p></div> + + + + + </div> + </li><li name="sims.dynamics.Shape#~"> + <h4 class="signature"> + <span class="kind">def</span> + <span class="symbol"> + <span class="name">~</span><span class="params">(<span name="s">s: <a href="" class="extype" name="sims.dynamics.Shape">Shape</a></span>)</span><span class="result">: <a href="Body.html" class="extype" name="sims.dynamics.Body">Body</a></span> + </span> + </h4> + <p class="shortcomment cmt">Creates a new body out of this shape and the shape <code>s</code></p><div class="fullcomment"> + <div class="comment cmt"><p>Creates a new body out of this shape and the shape <code>s</code>.</p></div> + + + + + </div> + </li></ol> + </div> + + <div class="members" id="constructors"> + <h3>Instance constructors</h3> + <ol><li name="sims.dynamics.Shape#this"> + <h4 class="signature"> + <span class="kind">new</span> + <span class="symbol"> + <span class="name">Shape</span><span class="params">()</span> + </span> + </h4> + + </li></ol> + </div> - <code></code> - <code>def</code> - <em>~</em>(<em>b</em> : <a href="../../sims/dynamics/Body.html" target="_self">Body</a>) : <a href="../../sims/dynamics/Body.html" target="_self">Body</a> - </dt> - <dd></dd> - </dl> - <dl><dd>Creates a new body out of this shape and the shapes of body <code>b</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/dynamics/World.html b/doc/sims/dynamics/World.html index d089cd9..336852c 100644 --- a/doc/sims/dynamics/World.html +++ b/doc/sims/dynamics/World.html @@ -1,699 +1,539 @@ -<!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 World in sims.dynamics</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/dynamics$package.html" target="_self">sims.dynamics</a> - <br></br> - <span class="entity">class World</span> - </div><hr></hr> - <div class="source"> - [source: <a href="" class="sims/dynamics/World"><code>sims/dynamics/World.scala</code></a>] - </div><hr></hr> - <a name="World"></a><dl> - <dt> - - <code></code> - <code>class</code> - <em>World</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 contains and simulates a system of rigid bodies and joints.</dd></dl> - <dl></dl> + <head> + <title>Scaladoc for sims.dynamics.World</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">dynamics</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/dynamics/World.html#bodies" target="_self">bodies</a></em> - : <a href="" target="contentFrame" class="scala/collection/mutable/ArrayBuffer">scala.collection.mutable.ArrayBuffer</a>[<a href="../../sims/dynamics/Body.html" target="_self">Body</a>] - - <div>Bodies contained in this world.</div> - </td> - </tr> -<tr> - <td class="modifiers" valign="top"> - <code> val</code> - </td> - <td class="signature"> - <em><a href="../../sims/dynamics/World.html#detector" target="_self">detector</a></em> - : <a href="../../sims/collision/Detector.html" target="_self">Detector</a> - - <div>Collsion detector who manages collision detection in this world.</div> - </td> - </tr> -<tr> - <td class="modifiers" valign="top"> - <code> var</code> - </td> - <td class="signature"> - <em><a href="../../sims/dynamics/World.html#enableCollisionDetection" target="_self">enableCollisionDetection</a></em> - : <a href="http://www.scala-lang.org/docu/files/api/scala/Boolean.html" target="_self">Boolean</a> - - <div>Flag to enable collision detection.</div> - </td> - </tr> -<tr> - <td class="modifiers" valign="top"> - <code> var</code> - </td> - <td class="signature"> - <em><a href="../../sims/dynamics/World.html#enablePositionCorrection" target="_self">enablePositionCorrection</a></em> - : <a href="http://www.scala-lang.org/docu/files/api/scala/Boolean.html" target="_self">Boolean</a> - - <div>Flag to enable position correction for constraints.</div> - </td> - </tr> -<tr> - <td class="modifiers" valign="top"> - <code> var</code> - </td> - <td class="signature"> - <em><a href="../../sims/dynamics/World.html#gravity" target="_self">gravity</a></em> - : <a href="../../sims/geometry/Vector2D.html" target="_self">Vector2D</a> - - <div>Gravity in this world.</div> - </td> - </tr> -<tr> - <td class="modifiers" valign="top"> - <code> var</code> - </td> - <td class="signature"> - <em><a href="../../sims/dynamics/World.html#iterations" target="_self">iterations</a></em> - : <a href="http://www.scala-lang.org/docu/files/api/scala/Int.html" target="_self">Int</a> - - <div>Number of constraint corrections per time step.</div> - </td> - </tr> -<tr> - <td class="modifiers" valign="top"> - <code> val</code> - </td> - <td class="signature"> - <em><a href="../../sims/dynamics/World.html#joints" target="_self">joints</a></em> - : <a href="" target="contentFrame" class="scala/collection/mutable/ArrayBuffer">scala.collection.mutable.ArrayBuffer</a>[<a href="../../sims/dynamics/joints/Joint.html" target="_self">Joint</a>] - - <div>Joints contained in this world.</div> - </td> - </tr> -<tr> - <td class="modifiers" valign="top"> - <code> var</code> - </td> - <td class="signature"> - <em><a href="../../sims/dynamics/World.html#minAngularVelocity" target="_self">minAngularVelocity</a></em> - : <a href="http://www.scala-lang.org/docu/files/api/scala/Double.html" target="_self">Double</a> - - <div>Minimal, non-zero angular velocity.</div> - </td> - </tr> -<tr> - <td class="modifiers" valign="top"> - <code> var</code> - </td> - <td class="signature"> - <em><a href="../../sims/dynamics/World.html#minLinearVelocity" target="_self">minLinearVelocity</a></em> - : <a href="http://www.scala-lang.org/docu/files/api/scala/Double.html" target="_self">Double</a> - - <div>Minimal, non-zero linear velocity.</div> - </td> - </tr> -<tr> - <td class="modifiers" valign="top"> - <code> val</code> - </td> - <td class="signature"> - <em><a href="../../sims/dynamics/World.html#monitors" target="_self">monitors</a></em> - : <a href="" target="contentFrame" class="scala/collection/mutable/ArrayBuffer">scala.collection.mutable.ArrayBuffer</a>[(<a href="" target="contentFrame" class="java/lang/String">java.lang.String</a>, (<a href="../../sims/dynamics/Body.html" target="_self">Body</a>) => <a href="" target="contentFrame" class="java/lang/String">java.lang.String</a>)] - - <div>Monitoring methods for bodies.</div> - </td> - </tr> -<tr> - <td class="modifiers" valign="top"> - <code> var</code> - </td> - <td class="signature"> - <em><a href="../../sims/dynamics/World.html#overCWarning" target="_self">overCWarning</a></em> - : <a href="http://www.scala-lang.org/docu/files/api/scala/Boolean.html" target="_self">Boolean</a> - - <div>Warning if a body's velocity exceeds the speed of light.</div> - </td> - </tr> -<tr> - <td class="modifiers" valign="top"> - <code> var</code> - </td> - <td class="signature"> - <em><a href="../../sims/dynamics/World.html#time" target="_self">time</a></em> - : <a href="http://www.scala-lang.org/docu/files/api/scala/Double.html" target="_self">Double</a> - - <div>Current time in this world.</div> - </td> - </tr> -<tr> - <td class="modifiers" valign="top"> - <code> var</code> - </td> - <td class="signature"> - <em><a href="../../sims/dynamics/World.html#timeStep" target="_self">timeStep</a></em> - : <a href="http://www.scala-lang.org/docu/files/api/scala/Double.html" target="_self">Double</a> - - <div>Time intervals in which this world simulates.</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/dynamics/World.html#%2B%2B%3D%28Seq%5Bsims.dynamics.Body%5D%29" target="_self">++=</a></em> - (<em>bs</em> : <a href="" target="contentFrame" class="scala/Seq">scala.Seq</a>[<a href="../../sims/dynamics/Body.html" target="_self">Body</a>]) : <a href="http://www.scala-lang.org/docu/files/api/scala/Unit.html" target="_self">Unit</a> - - <div>Adds the given sequence of bodies to this world.</div> - </td> - </tr> -<tr> - <td class="modifiers" valign="top"> - <code> def</code> - </td> - <td class="signature"> - <em><a href="../../sims/dynamics/World.html#%2B%3D%28sims.dynamics.Body%29" target="_self">+=</a></em> - (<em>body</em> : <a href="../../sims/dynamics/Body.html" target="_self">Body</a>) : <a href="http://www.scala-lang.org/docu/files/api/scala/Unit.html" target="_self">Unit</a> - - <div>Adds the given body to this world.</div> - </td> - </tr> -<tr> - <td class="modifiers" valign="top"> - <code> def</code> - </td> - <td class="signature"> - <em><a href="../../sims/dynamics/World.html#%2B%3D%28sims.prefabs.Prefab%29" target="_self">+=</a></em> - (<em>p</em> : <a href="../../sims/prefabs/Prefab.html" target="_self">Prefab</a>) : <a href="http://www.scala-lang.org/docu/files/api/scala/Unit.html" target="_self">Unit</a> - - <div>Adds the given prefabricated system of bodies and joints to this world.</div> - </td> - </tr> -<tr> - <td class="modifiers" valign="top"> - <code> def</code> - </td> - <td class="signature"> - <em><a href="../../sims/dynamics/World.html#%2B%3D%28sims.dynamics.joints.Joint%29" target="_self">+=</a></em> - (<em>joint</em> : <a href="../../sims/dynamics/joints/Joint.html" target="_self">Joint</a>) : <a href="http://www.scala-lang.org/docu/files/api/scala/Unit.html" target="_self">Unit</a> - - <div>Adds the given joint to this world.</div> - </td> - </tr> -<tr> - <td class="modifiers" valign="top"> - <code> def</code> - </td> - <td class="signature"> - <em><a href="../../sims/dynamics/World.html#--%3D%28Seq%5Bsims.dynamics.Body%5D%29" target="_self">--=</a></em> - (<em>bs</em> : <a href="" target="contentFrame" class="scala/Seq">scala.Seq</a>[<a href="../../sims/dynamics/Body.html" target="_self">Body</a>]) : <a href="http://www.scala-lang.org/docu/files/api/scala/Unit.html" target="_self">Unit</a> - - <div>Removes the given sequence of bodies from this world.</div> - </td> - </tr> -<tr> - <td class="modifiers" valign="top"> - <code> def</code> - </td> - <td class="signature"> - <em><a href="../../sims/dynamics/World.html#-%3D%28sims.prefabs.Prefab%29" target="_self">-=</a></em> - (<em>p</em> : <a href="../../sims/prefabs/Prefab.html" target="_self">Prefab</a>) : <a href="http://www.scala-lang.org/docu/files/api/scala/Unit.html" target="_self">Unit</a> - - <div>Removes the given prefabricated system of bodies and joints from this world.</div> - </td> - </tr> -<tr> - <td class="modifiers" valign="top"> - <code> def</code> - </td> - <td class="signature"> - <em><a href="../../sims/dynamics/World.html#-%3D%28sims.dynamics.Body%29" target="_self">-=</a></em> - (<em>body</em> : <a href="../../sims/dynamics/Body.html" target="_self">Body</a>) : <a href="http://www.scala-lang.org/docu/files/api/scala/Unit.html" target="_self">Unit</a> - - <div>Removes the given body from this world.</div> - </td> - </tr> -<tr> - <td class="modifiers" valign="top"> - <code> def</code> - </td> - <td class="signature"> - <em><a href="../../sims/dynamics/World.html#-%3D%28sims.dynamics.joints.Joint%29" target="_self">-=</a></em> - (<em>joint</em> : <a href="../../sims/dynamics/joints/Joint.html" target="_self">Joint</a>) : <a href="http://www.scala-lang.org/docu/files/api/scala/Unit.html" target="_self">Unit</a> - - <div>Removes the given joint from this world.</div> - </td> - </tr> -<tr> - <td class="modifiers" valign="top"> - <code> def</code> - </td> - <td class="signature"> - <em><a href="../../sims/dynamics/World.html#clear%28%29" target="_self">clear</a></em> - : <a href="http://www.scala-lang.org/docu/files/api/scala/Unit.html" target="_self">Unit</a> - - <div>Removes all bodies, joints and monitoring methods from this world.</div> - </td> - </tr> -<tr> - <td class="modifiers" valign="top"> - <code> def</code> - </td> - <td class="signature"> - <em><a href="../../sims/dynamics/World.html#info" target="_self">info</a></em> - : <a href="" target="contentFrame" class="java/lang/String">java.lang.String</a> - - <div>Returns information about this world.</div> - </td> - </tr> -<tr> - <td class="modifiers" valign="top"> - <code> def</code> - </td> - <td class="signature"> - <em><a href="../../sims/dynamics/World.html#postStep%28%29" target="_self">postStep</a></em> - : <a href="http://www.scala-lang.org/docu/files/api/scala/Unit.html" target="_self">Unit</a> - - <div>Initially empty method that is executed after each time step. This method
- may be overriden to create custom behaviour in a world.</div> - </td> - </tr> -<tr> - <td class="modifiers" valign="top"> - <code> def</code> - </td> - <td class="signature"> - <em><a href="../../sims/dynamics/World.html#shapes" target="_self">shapes</a></em> - : <a href="" target="contentFrame" class="scala/Seq">scala.Seq</a>[<a href="../../sims/dynamics/Shape.html" target="_self">Shape</a>] - - <div>Returns all shapes of all bodies in this world.</div> - </td> - </tr> -<tr> - <td class="modifiers" valign="top"> - <code> def</code> - </td> - <td class="signature"> - <em><a href="../../sims/dynamics/World.html#step%28%29" target="_self">step</a></em> - : <a href="http://www.scala-lang.org/docu/files/api/scala/Unit.html" target="_self">Unit</a> - - <div>Simulates a time step of the duration <code>timeStep</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 id="definition"> + <img src="../../lib/class_big.png" /> + <h1>World</h1> + </div> + <h4 class="signature"> + <span class="kind">class</span> + <span class="symbol"> + <span class="name">World</span><span class="result"> extends AnyRef</span> + </span> + </h4> + <div class="fullcomment" id="comment"> + <div class="comment cmt"><p>A world contains and simulates a system of rigid bodies and joints.</p></div> - -<table summary="" cellpadding="3" class="member-detail"> - <tr><td class="title">Value Details</td></tr> - </table><div><a name="timeStep"></a><dl> - <dt> - - <code></code> - <code>var</code> - <em>timeStep</em> : <a href="http://www.scala-lang.org/docu/files/api/scala/Double.html" target="_self">Double</a> - </dt> - <dd></dd> - </dl> - <dl><dd>Time intervals in which this world simulates.</dd></dl> - <dl></dl> - <hr></hr> -<a name="iterations"></a><dl> - <dt> - - <code></code> - <code>var</code> - <em>iterations</em> : <a href="http://www.scala-lang.org/docu/files/api/scala/Int.html" target="_self">Int</a> - </dt> - <dd></dd> - </dl> - <dl><dd>Number of constraint corrections per time step.</dd></dl> - <dl></dl> - <hr></hr> -<a name="gravity"></a><dl> - <dt> - - <code></code> - <code>var</code> - <em>gravity</em> : <a href="../../sims/geometry/Vector2D.html" target="_self">Vector2D</a> - </dt> - <dd></dd> - </dl> - <dl><dd>Gravity in this world.</dd></dl> - <dl></dl> - <hr></hr> -<a name="bodies"></a><dl> - <dt> - - <code></code> - <code>val</code> - <em>bodies</em> : <a href="" target="contentFrame" class="scala/collection/mutable/ArrayBuffer">scala.collection.mutable.ArrayBuffer</a>[<a href="../../sims/dynamics/Body.html" target="_self">Body</a>] - </dt> - <dd></dd> - </dl> - <dl><dd>Bodies contained in this world.</dd></dl> - <dl></dl> - <hr></hr> -<a name="joints"></a><dl> - <dt> - - <code></code> - <code>val</code> - <em>joints</em> : <a href="" target="contentFrame" class="scala/collection/mutable/ArrayBuffer">scala.collection.mutable.ArrayBuffer</a>[<a href="../../sims/dynamics/joints/Joint.html" target="_self">Joint</a>] - </dt> - <dd></dd> - </dl> - <dl><dd>Joints contained in this world.</dd></dl> - <dl></dl> - <hr></hr> -<a name="monitors"></a><dl> - <dt> - - <code></code> - <code>val</code> - <em>monitors</em> : <a href="" target="contentFrame" class="scala/collection/mutable/ArrayBuffer">scala.collection.mutable.ArrayBuffer</a>[(<a href="" target="contentFrame" class="java/lang/String">java.lang.String</a>, (<a href="../../sims/dynamics/Body.html" target="_self">Body</a>) => <a href="" target="contentFrame" class="java/lang/String">java.lang.String</a>)] - </dt> - <dd></dd> - </dl> - <dl><dd>Monitoring methods for bodies.
- <p>
- The first element of the tuple is the method's title and the second the method.
- Example usage: monitors += ("Y-Position", _.pos.y.toString)
- This will calculate all bodies - whose <code>monitor</code> field is set to
- <code>true</code> - second position components.</dd></dl> - <dl></dl> - <hr></hr> -<a name="detector"></a><dl> - <dt> - - <code></code> - <code>val</code> - <em>detector</em> : <a href="../../sims/collision/Detector.html" target="_self">Detector</a> - </dt> - <dd></dd> - </dl> - <dl><dd>Collsion detector who manages collision detection in this world.</dd></dl> - <dl></dl> - <hr></hr> -<a name="overCWarning"></a><dl> - <dt> - - <code></code> - <code>var</code> - <em>overCWarning</em> : <a href="http://www.scala-lang.org/docu/files/api/scala/Boolean.html" target="_self">Boolean</a> - </dt> - <dd></dd> - </dl> - <dl><dd>Warning if a body's velocity exceeds the speed of light.</dd></dl> - <dl></dl> - <hr></hr> -<a name="enableCollisionDetection"></a><dl> - <dt> - - <code></code> - <code>var</code> - <em>enableCollisionDetection</em> : <a href="http://www.scala-lang.org/docu/files/api/scala/Boolean.html" target="_self">Boolean</a> - </dt> - <dd></dd> - </dl> - <dl><dd>Flag to enable collision detection.</dd></dl> - <dl></dl> - <hr></hr> -<a name="enablePositionCorrection"></a><dl> - <dt> - - <code></code> - <code>var</code> - <em>enablePositionCorrection</em> : <a href="http://www.scala-lang.org/docu/files/api/scala/Boolean.html" target="_self">Boolean</a> - </dt> - <dd></dd> - </dl> - <dl><dd>Flag to enable position correction for constraints.</dd></dl> - <dl></dl> - <hr></hr> -<a name="minLinearVelocity"></a><dl> - <dt> - - <code></code> - <code>var</code> - <em>minLinearVelocity</em> : <a href="http://www.scala-lang.org/docu/files/api/scala/Double.html" target="_self">Double</a> - </dt> - <dd></dd> - </dl> - <dl><dd>Minimal, non-zero linear velocity.</dd></dl> - <dl></dl> - <hr></hr> -<a name="minAngularVelocity"></a><dl> - <dt> - - <code></code> - <code>var</code> - <em>minAngularVelocity</em> : <a href="http://www.scala-lang.org/docu/files/api/scala/Double.html" target="_self">Double</a> - </dt> - <dd></dd> - </dl> - <dl><dd>Minimal, non-zero angular velocity.</dd></dl> - <dl></dl> - <hr></hr> -<a name="time"></a><dl> - <dt> - - <code></code> - <code>var</code> - <em>time</em> : <a href="http://www.scala-lang.org/docu/files/api/scala/Double.html" target="_self">Double</a> - </dt> - <dd></dd> - </dl> - <dl><dd>Current time in this world.</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="shapes"></a><dl> - <dt> - - <code></code> - <code>def</code> - <em>shapes</em> : <a href="" target="contentFrame" class="scala/Seq">scala.Seq</a>[<a href="../../sims/dynamics/Shape.html" target="_self">Shape</a>] - </dt> - <dd></dd> - </dl> - <dl><dd>Returns all shapes of all bodies in this world.</dd></dl> - <dl></dl> - <hr></hr> -<a name="%2B%3D%28sims.dynamics.Body%29"></a><dl> - <dt> - - <code></code> - <code>def</code> - <em>+=</em>(<em>body</em> : <a href="../../sims/dynamics/Body.html" target="_self">Body</a>) : <a href="http://www.scala-lang.org/docu/files/api/scala/Unit.html" target="_self">Unit</a> - </dt> - <dd></dd> - </dl> - <dl><dd>Adds the given body to this world.</dd></dl> - <dl></dl> - <hr></hr> -<a name="%2B%3D%28sims.dynamics.joints.Joint%29"></a><dl> - <dt> - - <code></code> - <code>def</code> - <em>+=</em>(<em>joint</em> : <a href="../../sims/dynamics/joints/Joint.html" target="_self">Joint</a>) : <a href="http://www.scala-lang.org/docu/files/api/scala/Unit.html" target="_self">Unit</a> - </dt> - <dd></dd> - </dl> - <dl><dd>Adds the given joint to this world.</dd></dl> - <dl></dl> - <hr></hr> -<a name="%2B%3D%28sims.prefabs.Prefab%29"></a><dl> - <dt> - - <code></code> - <code>def</code> - <em>+=</em>(<em>p</em> : <a href="../../sims/prefabs/Prefab.html" target="_self">Prefab</a>) : <a href="http://www.scala-lang.org/docu/files/api/scala/Unit.html" target="_self">Unit</a> - </dt> - <dd></dd> - </dl> - <dl><dd>Adds the given prefabricated system of bodies and joints to this world.</dd></dl> - <dl></dl> - <hr></hr> -<a name="%2B%2B%3D%28Seq%5Bsims.dynamics.Body%5D%29"></a><dl> - <dt> - - <code></code> - <code>def</code> - <em>++=</em>(<em>bs</em> : <a href="" target="contentFrame" class="scala/Seq">scala.Seq</a>[<a href="../../sims/dynamics/Body.html" target="_self">Body</a>]) : <a href="http://www.scala-lang.org/docu/files/api/scala/Unit.html" target="_self">Unit</a> - </dt> - <dd></dd> - </dl> - <dl><dd>Adds the given sequence of bodies to this world.</dd></dl> - <dl></dl> - <hr></hr> -<a name="-%3D%28sims.dynamics.Body%29"></a><dl> - <dt> - - <code></code> - <code>def</code> - <em>-=</em>(<em>body</em> : <a href="../../sims/dynamics/Body.html" target="_self">Body</a>) : <a href="http://www.scala-lang.org/docu/files/api/scala/Unit.html" target="_self">Unit</a> - </dt> - <dd></dd> - </dl> - <dl><dd>Removes the given body from this world.</dd></dl> - <dl></dl> - <hr></hr> -<a name="-%3D%28sims.dynamics.joints.Joint%29"></a><dl> - <dt> - - <code></code> - <code>def</code> - <em>-=</em>(<em>joint</em> : <a href="../../sims/dynamics/joints/Joint.html" target="_self">Joint</a>) : <a href="http://www.scala-lang.org/docu/files/api/scala/Unit.html" target="_self">Unit</a> - </dt> - <dd></dd> - </dl> - <dl><dd>Removes the given joint from this world.</dd></dl> - <dl></dl> - <hr></hr> -<a name="-%3D%28sims.prefabs.Prefab%29"></a><dl> - <dt> - - <code></code> - <code>def</code> - <em>-=</em>(<em>p</em> : <a href="../../sims/prefabs/Prefab.html" target="_self">Prefab</a>) : <a href="http://www.scala-lang.org/docu/files/api/scala/Unit.html" target="_self">Unit</a> - </dt> - <dd></dd> - </dl> - <dl><dd>Removes the given prefabricated system of bodies and joints from this world.</dd></dl> - <dl></dl> - <hr></hr> -<a name="--%3D%28Seq%5Bsims.dynamics.Body%5D%29"></a><dl> - <dt> - - <code></code> - <code>def</code> - <em>--=</em>(<em>bs</em> : <a href="" target="contentFrame" class="scala/Seq">scala.Seq</a>[<a href="../../sims/dynamics/Body.html" target="_self">Body</a>]) : <a href="http://www.scala-lang.org/docu/files/api/scala/Unit.html" target="_self">Unit</a> - </dt> - <dd></dd> - </dl> - <dl><dd>Removes the given sequence of bodies from this world.</dd></dl> - <dl></dl> - <hr></hr> -<a name="clear%28%29"></a><dl> - <dt> - - <code></code> - <code>def</code> - <em>clear</em> : <a href="http://www.scala-lang.org/docu/files/api/scala/Unit.html" target="_self">Unit</a> - </dt> - <dd></dd> - </dl> - <dl><dd>Removes all bodies, joints and monitoring methods from this world.</dd></dl> - <dl></dl> - <hr></hr> -<a name="step%28%29"></a><dl> - <dt> - - <code></code> - <code>def</code> - <em>step</em> : <a href="http://www.scala-lang.org/docu/files/api/scala/Unit.html" target="_self">Unit</a> - </dt> - <dd></dd> - </dl> - <dl><dd>Simulates a time step of the duration <code>timeStep</code>.
- <p>
- The time step is simulated in the following phases:
- <ol>
- <li>Forces are applied to bodies.</li>
- <li>Accelerations are integrated.</li>
- <li>Velocities are corrected.</li>
- <li>Velocities are integrated.</li>
- <li>Postions are corrected.</li>
- <li>The method <code>postStep()</code> is executed.</li>
- </ol></dd></dl> - <dl></dl> - <hr></hr> -<a name="postStep%28%29"></a><dl> - <dt> - - <code></code> - <code>def</code> - <em>postStep</em> : <a href="http://www.scala-lang.org/docu/files/api/scala/Unit.html" target="_self">Unit</a> - </dt> - <dd></dd> - </dl> - <dl><dd>Initially empty method that is executed after each time step. This method
- may be overriden to create custom behaviour in a world.</dd></dl> - <dl></dl> - <hr></hr> -<a name="info"></a><dl> - <dt> + + + + </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.dynamics.World#++="> + <h4 class="signature"> + <span class="kind">def</span> + <span class="symbol"> + <span class="name">++=</span><span class="params">(<span name="bs">bs: <span class="extype" name="scala.collection.Seq">Seq</span>[<a href="Body.html" class="extype" name="sims.dynamics.Body">Body</a>]</span>)</span><span class="result">: <span class="extype" name="scala.Unit">Unit</span></span> + </span> + </h4> + <p class="shortcomment cmt">Adds the given sequence of bodies to this world</p><div class="fullcomment"> + <div class="comment cmt"><p>Adds the given sequence of bodies to this world.</p></div> + + + + + </div> + </li><li name="sims.dynamics.World#+="> + <h4 class="signature"> + <span class="kind">def</span> + <span class="symbol"> + <span class="name">+=</span><span class="params">(<span name="p">p: <a href="../prefabs/Prefab.html" class="extype" name="sims.prefabs.Prefab">Prefab</a></span>)</span><span class="result">: <span class="extype" name="scala.Unit">Unit</span></span> + </span> + </h4> + <p class="shortcomment cmt">Adds the given prefabricated system of bodies and joints to this world</p><div class="fullcomment"> + <div class="comment cmt"><p>Adds the given prefabricated system of bodies and joints to this world.</p></div> + + + + + </div> + </li><li name="sims.dynamics.World#+="> + <h4 class="signature"> + <span class="kind">def</span> + <span class="symbol"> + <span class="name">+=</span><span class="params">(<span name="joint">joint: <a href="joints/Joint.html" class="extype" name="sims.dynamics.joints.Joint">Joint</a></span>)</span><span class="result">: <span class="extype" name="scala.Unit">Unit</span></span> + </span> + </h4> + <p class="shortcomment cmt">Adds the given joint to this world</p><div class="fullcomment"> + <div class="comment cmt"><p>Adds the given joint to this world.</p></div> + + + + + </div> + </li><li name="sims.dynamics.World#+="> + <h4 class="signature"> + <span class="kind">def</span> + <span class="symbol"> + <span class="name">+=</span><span class="params">(<span name="body">body: <a href="Body.html" class="extype" name="sims.dynamics.Body">Body</a></span>)</span><span class="result">: <span class="extype" name="scala.collection.mutable.ArrayBuffer">ArrayBuffer</span>[<a href="Body.html" class="extype" name="sims.dynamics.Body">Body</a>]</span> + </span> + </h4> + <p class="shortcomment cmt">Adds the given body to this world</p><div class="fullcomment"> + <div class="comment cmt"><p>Adds the given body to this world.</p></div> + + + + + </div> + </li><li name="sims.dynamics.World#--="> + <h4 class="signature"> + <span class="kind">def</span> + <span class="symbol"> + <span class="name">--=</span><span class="params">(<span name="bs">bs: <span class="extype" name="scala.collection.Seq">Seq</span>[<a href="Body.html" class="extype" name="sims.dynamics.Body">Body</a>]</span>)</span><span class="result">: <span class="extype" name="scala.Unit">Unit</span></span> + </span> + </h4> + <p class="shortcomment cmt">Removes the given sequence of bodies from this world</p><div class="fullcomment"> + <div class="comment cmt"><p>Removes the given sequence of bodies from this world.</p></div> + + + + + </div> + </li><li name="sims.dynamics.World#-="> + <h4 class="signature"> + <span class="kind">def</span> + <span class="symbol"> + <span class="name">-=</span><span class="params">(<span name="p">p: <a href="../prefabs/Prefab.html" class="extype" name="sims.prefabs.Prefab">Prefab</a></span>)</span><span class="result">: <span class="extype" name="scala.Unit">Unit</span></span> + </span> + </h4> + <p class="shortcomment cmt">Removes the given prefabricated system of bodies and joints from this world</p><div class="fullcomment"> + <div class="comment cmt"><p>Removes the given prefabricated system of bodies and joints from this world.</p></div> + + + + + </div> + </li><li name="sims.dynamics.World#-="> + <h4 class="signature"> + <span class="kind">def</span> + <span class="symbol"> + <span class="name">-=</span><span class="params">(<span name="joint">joint: <a href="joints/Joint.html" class="extype" name="sims.dynamics.joints.Joint">Joint</a></span>)</span><span class="result">: <span class="extype" name="scala.Unit">Unit</span></span> + </span> + </h4> + <p class="shortcomment cmt">Removes the given joint from this world</p><div class="fullcomment"> + <div class="comment cmt"><p>Removes the given joint from this world.</p></div> + + + + + </div> + </li><li name="sims.dynamics.World#-="> + <h4 class="signature"> + <span class="kind">def</span> + <span class="symbol"> + <span class="name">-=</span><span class="params">(<span name="body">body: <a href="Body.html" class="extype" name="sims.dynamics.Body">Body</a></span>)</span><span class="result">: <span class="extype" name="scala.Unit">Unit</span></span> + </span> + </h4> + <p class="shortcomment cmt">Removes the given body from this world</p><div class="fullcomment"> + <div class="comment cmt"><p>Removes the given body from this world.</p></div> + + + + + </div> + </li><li name="sims.dynamics.World#bodies"> + <h4 class="signature"> + <span class="kind">val</span> + <span class="symbol"> + <span class="name">bodies</span><span class="result">: <span class="extype" name="scala.collection.mutable.ArrayBuffer">ArrayBuffer</span>[<a href="Body.html" class="extype" name="sims.dynamics.Body">Body</a>]</span> + </span> + </h4> + <p class="shortcomment cmt">Bodies contained in this world</p><div class="fullcomment"> + <div class="comment cmt"><p>Bodies contained in this world.</p></div> + + + + + </div> + </li><li name="sims.dynamics.World#clear"> + <h4 class="signature"> + <span class="kind">def</span> + <span class="symbol"> + <span class="name">clear</span><span class="params">()</span><span class="result">: <span class="extype" name="scala.Unit">Unit</span></span> + </span> + </h4> + <p class="shortcomment cmt">Removes all bodies, joints and monitoring methods from this world</p><div class="fullcomment"> + <div class="comment cmt"><p>Removes all bodies, joints and monitoring methods from this world.</p></div> + + + + + </div> + </li><li name="sims.dynamics.World#detector"> + <h4 class="signature"> + <span class="kind">val</span> + <span class="symbol"> + <span class="name">detector</span><span class="result">: <a href="../collision/Detector.html" class="extype" name="sims.collision.Detector">Detector</a></span> + </span> + </h4> + <p class="shortcomment cmt">Collsion detector who manages collision detection in this world</p><div class="fullcomment"> + <div class="comment cmt"><p>Collsion detector who manages collision detection in this world.</p></div> + + + + + </div> + </li><li name="sims.dynamics.World#enableCollisionDetection"> + <h4 class="signature"> + <span class="kind">var</span> + <span class="symbol"> + <span class="name">enableCollisionDetection</span><span class="result">: <span class="extype" name="scala.Boolean">Boolean</span></span> + </span> + </h4> + <p class="shortcomment cmt">Flag to enable collision detection</p><div class="fullcomment"> + <div class="comment cmt"><p>Flag to enable collision detection.</p></div> + + + + + </div> + </li><li name="sims.dynamics.World#enablePositionCorrection"> + <h4 class="signature"> + <span class="kind">var</span> + <span class="symbol"> + <span class="name">enablePositionCorrection</span><span class="result">: <span class="extype" name="scala.Boolean">Boolean</span></span> + </span> + </h4> + <p class="shortcomment cmt">Flag to enable position correction for constraints</p><div class="fullcomment"> + <div class="comment cmt"><p>Flag to enable position correction for constraints.</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.dynamics.World#gravity"> + <h4 class="signature"> + <span class="kind">var</span> + <span class="symbol"> + <span class="name">gravity</span><span class="result">: <a href="../geometry/Vector2D.html" class="extype" name="sims.geometry.Vector2D">Vector2D</a></span> + </span> + </h4> + <p class="shortcomment cmt">Gravity in this world</p><div class="fullcomment"> + <div class="comment cmt"><p>Gravity in this world.</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.dynamics.World#info"> + <h4 class="signature"> + <span class="kind">def</span> + <span class="symbol"> + <span class="name">info</span><span class="result">: <span class="extype" name="java.lang.String">String</span></span> + </span> + </h4> + <p class="shortcomment cmt">Returns information about this world</p><div class="fullcomment"> + <div class="comment cmt"><p>Returns information about this world.</p></div> + + + + + </div> + </li><li name="sims.dynamics.World#iterations"> + <h4 class="signature"> + <span class="kind">var</span> + <span class="symbol"> + <span class="name">iterations</span><span class="result">: <span class="extype" name="scala.Int">Int</span></span> + </span> + </h4> + <p class="shortcomment cmt">Number of constraint corrections per time step</p><div class="fullcomment"> + <div class="comment cmt"><p>Number of constraint corrections per time step.</p></div> + + + + + </div> + </li><li name="sims.dynamics.World#joints"> + <h4 class="signature"> + <span class="kind">val</span> + <span class="symbol"> + <span class="name">joints</span><span class="result">: <span class="extype" name="scala.collection.mutable.ArrayBuffer">ArrayBuffer</span>[<a href="joints/Joint.html" class="extype" name="sims.dynamics.joints.Joint">Joint</a>]</span> + </span> + </h4> + <p class="shortcomment cmt">Joints contained in this world</p><div class="fullcomment"> + <div class="comment cmt"><p>Joints contained in this world.</p></div> + + + + + </div> + </li><li name="sims.dynamics.World#minAngularVelocity"> + <h4 class="signature"> + <span class="kind">var</span> + <span class="symbol"> + <span class="name">minAngularVelocity</span><span class="result">: <span class="extype" name="scala.Double">Double</span></span> + </span> + </h4> + <p class="shortcomment cmt">Minimal, non-zero angular velocity</p><div class="fullcomment"> + <div class="comment cmt"><p>Minimal, non-zero angular velocity.</p></div> + + + + + </div> + </li><li name="sims.dynamics.World#minLinearVelocity"> + <h4 class="signature"> + <span class="kind">var</span> + <span class="symbol"> + <span class="name">minLinearVelocity</span><span class="result">: <span class="extype" name="scala.Double">Double</span></span> + </span> + </h4> + <p class="shortcomment cmt">Minimal, non-zero linear velocity</p><div class="fullcomment"> + <div class="comment cmt"><p>Minimal, non-zero linear velocity.</p></div> + + + + + </div> + </li><li name="sims.dynamics.World#monitors"> + <h4 class="signature"> + <span class="kind">val</span> + <span class="symbol"> + <span class="name">monitors</span><span class="result">: <span class="extype" name="scala.collection.mutable.ArrayBuffer">ArrayBuffer</span>[(<span class="extype" name="java.lang.String">String</span>, (<a href="Body.html" class="extype" name="sims.dynamics.Body">Body</a>) ⇒ <span class="extype" name="scala.Any">Any</span>)]</span> + </span> + </h4> + <p class="shortcomment cmt">Monitoring methods for bodies</p><div class="fullcomment"> + <div class="comment cmt"><p>Monitoring methods for bodies. +<p> +The first element of the tuple is the method's title and the second the method. +Example usage: monitors += ("Y-Position", _.pos.y.toString) +This will calculate all bodies - whose <code>monitor</code> field is set to +<code>true</code> - second position components.</p></div> + + + + + </div> + </li><li name="sims.dynamics.World#overCWarning"> + <h4 class="signature"> + <span class="kind">var</span> + <span class="symbol"> + <span class="name">overCWarning</span><span class="result">: <span class="extype" name="scala.Boolean">Boolean</span></span> + </span> + </h4> + <p class="shortcomment cmt">Warning if a body's velocity exceeds the speed of light</p><div class="fullcomment"> + <div class="comment cmt"><p>Warning if a body's velocity exceeds the speed of light.</p></div> + + + + + </div> + </li><li name="sims.dynamics.World#postStep"> + <h4 class="signature"> + <span class="kind">def</span> + <span class="symbol"> + <span class="name">postStep</span><span class="params">()</span><span class="result">: <span class="extype" name="scala.Unit">Unit</span></span> + </span> + </h4> + <p class="shortcomment cmt">Initially empty method that is executed after each time step</p><div class="fullcomment"> + <div class="comment cmt"><p>Initially empty method that is executed after each time step. This method +may be overriden to create custom behaviour in a world.</p></div> + + + + + </div> + </li><li name="sims.dynamics.World#shapes"> + <h4 class="signature"> + <span class="kind">def</span> + <span class="symbol"> + <span class="name">shapes</span><span class="result">: <span class="extype" name="scala.collection.mutable.ArrayBuffer">ArrayBuffer</span>[<a href="Shape.html" class="extype" name="sims.dynamics.Shape">Shape</a>]</span> + </span> + </h4> + <p class="shortcomment cmt">Returns all shapes of all bodies in this world</p><div class="fullcomment"> + <div class="comment cmt"><p>Returns all shapes of all bodies in this world.</p></div> + + + + + </div> + </li><li name="sims.dynamics.World#step"> + <h4 class="signature"> + <span class="kind">def</span> + <span class="symbol"> + <span class="name">step</span><span class="params">()</span><span class="result">: <span class="extype" name="scala.Unit">Unit</span></span> + </span> + </h4> + <p class="shortcomment cmt">Simulates a time step of the duration <code>timeStep</code></p><div class="fullcomment"> + <div class="comment cmt"><p>Simulates a time step of the duration <code>timeStep</code>. +<p> +The time step is simulated in the following phases: +<ol> +<li>Forces are applied to bodies.</li> +<li>Accelerations are integrated.</li> +<li>Velocities are corrected.</li> +<li>Velocities are integrated.</li> +<li>Postions are corrected.</li> +<li>The method <code>postStep()</code> is executed.</li> +</ol></p></div> + + + + + </div> + </li><li name="sims.dynamics.World#time"> + <h4 class="signature"> + <span class="kind">var</span> + <span class="symbol"> + <span class="name">time</span><span class="result">: <span class="extype" name="scala.Double">Double</span></span> + </span> + </h4> + <p class="shortcomment cmt">Current time in this world</p><div class="fullcomment"> + <div class="comment cmt"><p>Current time in this world.</p></div> + + + + + </div> + </li><li name="sims.dynamics.World#timeStep"> + <h4 class="signature"> + <span class="kind">var</span> + <span class="symbol"> + <span class="name">timeStep</span><span class="result">: <span class="extype" name="scala.Double">Double</span></span> + </span> + </h4> + <p class="shortcomment cmt">Time intervals in which this world simulates</p><div class="fullcomment"> + <div class="comment cmt"><p>Time intervals in which this world simulates.</p></div> + + + + + </div> + </li><li name="scala.AnyRef#toString"> + <h4 class="signature"> + <span class="kind">def</span> + <span class="symbol"> + <span class="name">toString</span><span class="params">()</span><span class="result">: <span class="extype" name="java.lang.String">String</span></span> + </span> + </h4> + <p class="shortcomment cmt">Returns a string representation of the object</p><div class="fullcomment"> + <div class="comment cmt"><p>Returns a string representation of the object. +<p> +The default representation is platform dependent. +</p></div> + + + <div class="block"> + definition classes: AnyRef ⇐ Any + </div> + + </div> + </li></ol> + </div> + + <div class="members" id="constructors"> + <h3>Instance constructors</h3> + <ol><li name="sims.dynamics.World#this"> + <h4 class="signature"> + <span class="kind">new</span> + <span class="symbol"> + <span class="name">World</span><span class="params">()</span> + </span> + </h4> + + </li></ol> + </div> - <code></code> - <code>def</code> - <em>info</em> : <a href="" target="contentFrame" class="java/lang/String">java.lang.String</a> - </dt> - <dd></dd> - </dl> - <dl><dd>Returns information about this world.</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/dynamics/joints$content.html b/doc/sims/dynamics/joints$content.html deleted file mode 100644 index 141c3e3..0000000 --- a/doc/sims/dynamics/joints$content.html +++ /dev/null @@ -1,103 +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>All classes and objects in sims.dynamics.joints</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()"><div class="page-title"><div>Simple Mechanics Simulator (SiMS) API</div></div><p><div>This document is the API specification for SiMS</div></p><table summary="" cellpadding="3" class="member"> - <tr><td class="title" colspan="2">Class Summary</td></tr> - <tr> - <td class="modifiers" valign="top"> - <code>case class</code> - </td> - <td class="signature"> - <em><a href="../../sims/dynamics/joints/DistanceJoint.html" target="_self">DistanceJoint</a></em> - (<code>val </code><em>node1</em> : <a href="../../sims/dynamics/Body.html" target="_self">Body</a>, <code>val </code><em>anchor1</em> : <a href="../../sims/geometry/Vector2D.html" target="_self">Vector2D</a>, <code>val </code><em>node2</em> : <a href="../../sims/dynamics/Body.html" target="_self">Body</a>, <code>val </code><em>anchor2</em> : <a href="../../sims/geometry/Vector2D.html" target="_self">Vector2D</a>)<code> extends </code><a href="../../sims/dynamics/joints/Joint.html" target="_self">Joint</a><code> with </code><a href="" target="contentFrame" class="scala/Product">scala.Product</a> - - <div>DistanceJoints keep their connection points at a constant distance.</div> - </td> - </tr> -<tr> - <td class="modifiers" valign="top"> - <code> trait</code> - </td> - <td class="signature"> - <em><a href="../../sims/dynamics/joints/ForceJoint.html" target="_self">ForceJoint</a></em> - <code> extends </code><a href="http://www.scala-lang.org/docu/files/api/scala/AnyRef.html" target="_self">AnyRef</a> - - <div>A joint which can apply a force to its anchor bodies, thus adding or removing energy to the system.</div> - </td> - </tr> -<tr> - <td class="modifiers" valign="top"> - <code>abstract class</code> - </td> - <td class="signature"> - <em><a href="../../sims/dynamics/joints/Joint.html" target="_self">Joint</a></em> - <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> - - <div>Joints constrain the movement of two bodies.
- Their implementation was inspired by Erin Catto's box2d.</div> - </td> - </tr> -<tr> - <td class="modifiers" valign="top"> - <code>case class</code> - </td> - <td class="signature"> - <em><a href="../../sims/dynamics/joints/RevoluteJoint.html" target="_self">RevoluteJoint</a></em> - (<code>val </code><em>node1</em> : <a href="../../sims/dynamics/Body.html" target="_self">Body</a>, <code>val </code><em>node2</em> : <a href="../../sims/dynamics/Body.html" target="_self">Body</a>, <code>val </code><em>anchor</em> : <a href="../../sims/geometry/Vector2D.html" target="_self">Vector2D</a>)<code> extends </code><a href="../../sims/dynamics/joints/Joint.html" target="_self">Joint</a><code> with </code><a href="" target="contentFrame" class="scala/Product">scala.Product</a> - - <div>A revolute joint that connects two bodies at a singe point. Inspired from JBox2D.
- <b>Warning:</b> there are still several bugs with revolute joints, if they are between two free
- bodies and not connected at their respective COMs.</div> - </td> - </tr> -<tr> - <td class="modifiers" valign="top"> - <code>case class</code> - </td> - <td class="signature"> - <em><a href="../../sims/dynamics/joints/SpringJoint.html" target="_self">SpringJoint</a></em> - (<code>val </code><em>node1</em> : <a href="../../sims/dynamics/Body.html" target="_self">Body</a>, <code>val </code><em>anchor1</em> : <a href="../../sims/geometry/Vector2D.html" target="_self">Vector2D</a>, <code>val </code><em>node2</em> : <a href="../../sims/dynamics/Body.html" target="_self">Body</a>, <code>val </code><em>anchor2</em> : <a href="../../sims/geometry/Vector2D.html" target="_self">Vector2D</a>, <code>val </code><em>springConstant</em> : <a href="http://www.scala-lang.org/docu/files/api/scala/Double.html" target="_self">Double</a>, <code>val </code><em>initialLength</em> : <a href="http://www.scala-lang.org/docu/files/api/scala/Double.html" target="_self">Double</a>)<code> extends </code><a href="../../sims/dynamics/joints/Joint.html" target="_self">Joint</a><code> with </code><a href="../../sims/dynamics/joints/ForceJoint.html" target="_self">ForceJoint</a><code> with </code><a href="" target="contentFrame" class="scala/Product">scala.Product</a> - - <div>A spring obeying Hooke's law.</div> - </td> - </tr> - </table> -<table summary="" cellpadding="3" class="member"> - <tr><td class="title" colspan="2">Object Summary</td></tr> - <tr> - <td class="modifiers" valign="top"> - <code> object</code> - </td> - <td class="signature"> - <em><a href="../../sims/dynamics/joints/DistanceJoint$object.html" target="_self">DistanceJoint</a></em> - <code> extends </code>(<a href="../../sims/dynamics/Body.html" target="_self">Body</a>, <a href="../../sims/geometry/Vector2D.html" target="_self">Vector2D</a>, <a href="../../sims/dynamics/Body.html" target="_self">Body</a>, <a href="../../sims/geometry/Vector2D.html" target="_self">Vector2D</a>) => <a href="../../sims/dynamics/joints/DistanceJoint.html" target="_self">DistanceJoint</a> - - - </td> - </tr> -<tr> - <td class="modifiers" valign="top"> - <code> object</code> - </td> - <td class="signature"> - <em><a href="../../sims/dynamics/joints/RevoluteJoint$object.html" target="_self">RevoluteJoint</a></em> - <code> extends </code>(<a href="../../sims/dynamics/Body.html" target="_self">Body</a>, <a href="../../sims/dynamics/Body.html" target="_self">Body</a>, <a href="../../sims/geometry/Vector2D.html" target="_self">Vector2D</a>) => <a href="../../sims/dynamics/joints/RevoluteJoint.html" target="_self">RevoluteJoint</a> - - - </td> - </tr> -<tr> - <td class="modifiers" valign="top"> - <code> object</code> - </td> - <td class="signature"> - <em><a href="../../sims/dynamics/joints/SpringJoint$object.html" target="_self">SpringJoint</a></em> - <code> extends </code>(<a href="../../sims/dynamics/Body.html" target="_self">Body</a>, <a href="../../sims/geometry/Vector2D.html" target="_self">Vector2D</a>, <a href="../../sims/dynamics/Body.html" target="_self">Body</a>, <a href="../../sims/geometry/Vector2D.html" target="_self">Vector2D</a>, <a href="http://www.scala-lang.org/docu/files/api/scala/Double.html" target="_self">Double</a>, <a href="http://www.scala-lang.org/docu/files/api/scala/Double.html" target="_self">Double</a>) => <a href="../../sims/dynamics/joints/SpringJoint.html" target="_self">SpringJoint</a> - - - </td> - </tr> - </table></body> - </html>
\ No newline at end of file diff --git a/doc/sims/dynamics/joints$package.html b/doc/sims/dynamics/joints$package.html deleted file mode 100644 index dde0590..0000000 --- a/doc/sims/dynamics/joints$package.html +++ /dev/null @@ -1,22 +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>List of classes and objects in package sims.dynamics.joints</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"> - <a href="../../sims/dynamics/joints$content.html" target="contentFrame">sims.dynamics.joints</a> - </td></tr> - </table><div><div class="kinds" id="Classes">Classes</div><ul class="list"> - <li id="Classes_D"><a href="../../sims/dynamics/joints/DistanceJoint.html" target="contentFrame">DistanceJoint</a></li> -<li id="Classes_F"><a href="../../sims/dynamics/joints/ForceJoint.html" target="contentFrame">ForceJoint</a></li> -<li id="Classes_J"><a href="../../sims/dynamics/joints/Joint.html" target="contentFrame">Joint</a></li> -<li id="Classes_R"><a href="../../sims/dynamics/joints/RevoluteJoint.html" target="contentFrame">RevoluteJoint</a></li> -<li id="Classes_S"><a href="../../sims/dynamics/joints/SpringJoint.html" target="contentFrame">SpringJoint</a></li> - </ul> -<div class="kinds" id="Objects">Objects</div><ul class="list"> - <li id="Objects_D"><a href="../../sims/dynamics/joints/DistanceJoint$object.html" target="contentFrame">DistanceJoint</a></li> -<li id="Objects_R"><a href="../../sims/dynamics/joints/RevoluteJoint$object.html" target="contentFrame">RevoluteJoint</a></li> -<li id="Objects_S"><a href="../../sims/dynamics/joints/SpringJoint$object.html" target="contentFrame">SpringJoint</a></li> - </ul></div></body> - </html>
\ No newline at end of file diff --git a/doc/sims/dynamics/joints/DistanceJoint$object.html b/doc/sims/dynamics/joints/DistanceJoint$object.html deleted file mode 100644 index e4121b3..0000000 --- a/doc/sims/dynamics/joints/DistanceJoint$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 DistanceJoint in sims.dynamics.joints</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/dynamics/joints$package.html" target="_self">sims.dynamics.joints</a> - <br></br> - <span class="entity">object DistanceJoint</span> - </div><hr></hr> - <div class="source"> - [source: <a href="" class="sims/dynamics/joints/DistanceJoint"><code>sims/dynamics/joints/DistanceJoint.scala</code></a>] - </div><hr></hr> - <a name="DistanceJoint"></a><dl> - <dt> - - <code></code> - <code>object</code> - <em>DistanceJoint</em> - </dt> - <dd><code> extends </code>(<a href="../../../sims/dynamics/Body.html" target="_self">Body</a>, <a href="../../../sims/geometry/Vector2D.html" target="_self">Vector2D</a>, <a href="../../../sims/dynamics/Body.html" target="_self">Body</a>, <a href="../../../sims/geometry/Vector2D.html" target="_self">Vector2D</a>) => <a href="../../../sims/dynamics/joints/DistanceJoint.html" target="_self">DistanceJoint</a></dd> - </dl> - - - -<table summary="" cellpadding="3" class="inherited"> - <tr><td class="title" colspan="2"> - Methods inherited from <a href="" target="contentFrame" class="scala/Function4">scala.Function4</a> - </td></tr> - <tr><td class="signature" colspan="2"> - <a href="#toString" target="contentFrame" class="scala/Function4">scala.Function4.toString</a>, <a href="#curry" target="contentFrame" class="scala/Function4">scala.Function4.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/dynamics/joints/DistanceJoint.html b/doc/sims/dynamics/joints/DistanceJoint.html index bae5f5d..27e4e5c 100644 --- a/doc/sims/dynamics/joints/DistanceJoint.html +++ b/doc/sims/dynamics/joints/DistanceJoint.html @@ -1,481 +1,359 @@ -<!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 DistanceJoint in sims.dynamics.joints</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/dynamics/joints$package.html" target="_self">sims.dynamics.joints</a> - <br></br> - <span class="entity">class DistanceJoint</span> - </div><hr></hr> - <div class="source"> - [source: <a href="" class="sims/dynamics/joints/DistanceJoint"><code>sims/dynamics/joints/DistanceJoint.scala</code></a>] - </div><hr></hr> - <a name="DistanceJoint"></a><dl> - <dt> - - <code>case</code> - <code>class</code> - <em>DistanceJoint</em>(<code>val </code><em>node1</em> : <a href="../../../sims/dynamics/Body.html" target="_self">Body</a>, <code>val </code><em>anchor1</em> : <a href="../../../sims/geometry/Vector2D.html" target="_self">Vector2D</a>, <code>val </code><em>node2</em> : <a href="../../../sims/dynamics/Body.html" target="_self">Body</a>, <code>val </code><em>anchor2</em> : <a href="../../../sims/geometry/Vector2D.html" target="_self">Vector2D</a>) - </dt> - <dd><code> extends </code><a href="../../../sims/dynamics/joints/Joint.html" target="_self">Joint</a><code> with </code><a href="" target="contentFrame" class="scala/Product">scala.Product</a></dd> - </dl> - <dl><dd>DistanceJoints keep their connection points at a constant distance.</dd></dl> - <dl><dt style="margin:10px 0 0 20px;"> - <b>Parameters</b></dt><dd><code>node1 - </code>first associated body</dd><dd><code>anchor1 - </code>first connection point</dd><dd><code>node2 - </code>second associated body</dd><dd><code>anchor2 - </code>second connection point</dd></dl> + <head> + <title>Scaladoc for sims.dynamics.joints.DistanceJoint</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/dynamics/joints/DistanceJoint.html#this%28sims.dynamics.Body%2Csims.dynamics.Body%29" target="_self">this</a></em> - (<em>node1</em> : <a href="../../../sims/dynamics/Body.html" target="_self">Body</a>, <em>node2</em> : <a href="../../../sims/dynamics/Body.html" target="_self">Body</a>) : <a href="../../../sims/dynamics/joints/DistanceJoint.html" target="_self">DistanceJoint</a> - - - </td> - </tr> - </table> - -<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/dynamics/joints/DistanceJoint.html#distance" target="_self">distance</a></em> - : <a href="http://www.scala-lang.org/docu/files/api/scala/Double.html" target="_self">Double</a> - - <div>Distance between the two connection points at initialisation (the desired distance).</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/dynamics/joints/DistanceJoint.html#connection1" target="_self">connection1</a></em> - : <a href="../../../sims/geometry/Vector2D.html" target="_self">Vector2D</a> - - <div>Returns the connection point on body one (in world coordinates).</div> - </td> - </tr> -<tr> - <td class="modifiers" valign="top"> - <code> def</code> - </td> - <td class="signature"> - <em><a href="../../../sims/dynamics/joints/DistanceJoint.html#connection2" target="_self">connection2</a></em> - : <a href="../../../sims/geometry/Vector2D.html" target="_self">Vector2D</a> - - <div>Returns the connection point on body two (in world coordinates).</div> - </td> - </tr> -<tr> - <td class="modifiers" valign="top"> - <code>override def</code> - </td> - <td class="signature"> - <em><a href="../../../sims/dynamics/joints/DistanceJoint.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 this joint's associated bodies.</div> - </td> - </tr> -<tr> - <td class="modifiers" valign="top"> - <code>override def</code> - </td> - <td class="signature"> - <em><a href="../../../sims/dynamics/joints/DistanceJoint.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 this joint's associated bodies.</div> - </td> - </tr> -<tr> - <td class="modifiers" valign="top"> - <code>override def</code> - </td> - <td class="signature"> - <em><a href="../../../sims/dynamics/joints/DistanceJoint.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/dynamics/joints/DistanceJoint.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/dynamics/joints/DistanceJoint.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/dynamics/joints/DistanceJoint.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/dynamics/joints/DistanceJoint.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/dynamics/joints/DistanceJoint.html#toString%28%29" target="_self">toString</a></em> - : <a href="" target="contentFrame" class="java/lang/String">java.lang.String</a> - - <div>Returns a string representation of the object.</div> - </td> - </tr> -<tr> - <td class="modifiers" valign="top"> - <code> def</code> - </td> - <td class="signature"> - <em><a href="../../../sims/dynamics/joints/DistanceJoint.html#v" target="_self">v</a></em> - : <a href="../../../sims/geometry/Vector2D.html" target="_self">Vector2D</a> - - <div>Relative velocity of the connection points.</div> - </td> - </tr> -<tr> - <td class="modifiers" valign="top"> - <code> def</code> - </td> - <td class="signature"> - <em><a href="../../../sims/dynamics/joints/DistanceJoint.html#x" target="_self">x</a></em> - : <a href="../../../sims/geometry/Vector2D.html" target="_self">Vector2D</a> - - <div>Relative position of the connection points.</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> - - - <table summary="" cellpadding="3" class="member-detail"> - <tr><td class="title">Additional Constructor Details</td></tr> - </table><div><a name="this%28sims.dynamics.Body%2Csims.dynamics.Body%29"></a><dl> - <dt> - - <code></code> - <code>def</code> - <em>this</em>(<em>node1</em> : <a href="../../../sims/dynamics/Body.html" target="_self">Body</a>, <em>node2</em> : <a href="../../../sims/dynamics/Body.html" target="_self">Body</a>) : <a href="../../../sims/dynamics/joints/DistanceJoint.html" target="_self">DistanceJoint</a> - </dt> - <dd></dd> - </dl><hr></hr></div> - -<table summary="" cellpadding="3" class="member-detail"> - <tr><td class="title">Value Details</td></tr> - </table><div><a name="distance"></a><dl> - <dt> - - <code></code> - <code>val</code> - <em>distance</em> : <a href="http://www.scala-lang.org/docu/files/api/scala/Double.html" target="_self">Double</a> - </dt> - <dd></dd> - </dl> - <dl><dd>Distance between the two connection points at initialisation (the desired distance).</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="connection1"></a><dl> - <dt> - - <code></code> - <code>def</code> - <em>connection1</em> : <a href="../../../sims/geometry/Vector2D.html" target="_self">Vector2D</a> - </dt> - <dd></dd> - </dl> - <dl><dd>Returns the connection point on body one (in world coordinates).</dd></dl> - <dl></dl> - <hr></hr> -<a name="connection2"></a><dl> - <dt> - - <code></code> - <code>def</code> - <em>connection2</em> : <a href="../../../sims/geometry/Vector2D.html" target="_self">Vector2D</a> - </dt> - <dd></dd> - </dl> - <dl><dd>Returns the connection point on body two (in world coordinates).</dd></dl> - <dl></dl> - <hr></hr> -<a name="x"></a><dl> - <dt> - - <code></code> - <code>def</code> - <em>x</em> : <a href="../../../sims/geometry/Vector2D.html" target="_self">Vector2D</a> - </dt> - <dd></dd> - </dl> - <dl><dd>Relative position of the connection points.</dd></dl> - <dl></dl> - <hr></hr> -<a name="v"></a><dl> - <dt> - - <code></code> - <code>def</code> - <em>v</em> : <a href="../../../sims/geometry/Vector2D.html" target="_self">Vector2D</a> - </dt> - <dd></dd> - </dl> - <dl><dd>Relative velocity of the connection points.</dd></dl> - <dl></dl> - <hr></hr> -<a name="correctVelocity%28Double%29"></a><dl> - <dt> - - <code>override</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 this joint's associated bodies.</dd></dl> - <dl></dl> - <dl> - <dt style="margin:10px 0 0 20px;"> - <b>Overrides</b> - </dt> - <dd> - <a href="../../../sims/dynamics/joints/Joint.html" target="_self">Joint</a>.<a href="../../../sims/dynamics/joints/Joint.html#correctVelocity%28Double%29" target="_self">correctVelocity</a> - </dd> - </dl><hr></hr> -<a name="correctPosition%28Double%29"></a><dl> - <dt> - - <code>override</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 this joint's associated bodies.</dd></dl> - <dl></dl> - <dl> - <dt style="margin:10px 0 0 20px;"> - <b>Overrides</b> - </dt> - <dd> - <a href="../../../sims/dynamics/joints/Joint.html" target="_self">Joint</a>.<a href="../../../sims/dynamics/joints/Joint.html#correctPosition%28Double%29" target="_self">correctPosition</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> - <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> - - <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> + </head> + <body class="type"> + + <p id="owner"><a href="../../package.html">sims</a>.<a href="../package.html">dynamics</a>.<a href="package.html">joints</a></p> + <div id="definition"> + <img src="../../../lib/class_big.png" /> + <h1>DistanceJoint</h1> + </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> + <h4 class="signature"> + <span class="kind">class</span> + <span class="symbol"> + <span class="name">DistanceJoint</span><span class="params">(<span name="node1">node1: <a href="../Body.html" class="extype" name="sims.dynamics.Body">Body</a></span>, <span name="anchor1">anchor1: <a href="../../geometry/Vector2D.html" class="extype" name="sims.geometry.Vector2D">Vector2D</a></span>, <span name="node2">node2: <a href="../Body.html" class="extype" name="sims.dynamics.Body">Body</a></span>, <span name="anchor2">anchor2: <a href="../../geometry/Vector2D.html" class="extype" name="sims.geometry.Vector2D">Vector2D</a></span>)</span><span class="result"> extends <a href="Joint.html" class="extype" name="sims.dynamics.joints.Joint">Joint</a> with <span class="extype" name="scala.Product">Product</span></span> + </span> + </h4> + <div class="fullcomment" id="comment"> + <div class="comment cmt"><p>DistanceJoints keep their connection points at a constant distance.</p></div> + <dl class="paramcmts block"><dt class="param">node1</dt><dd class="cmt"><p>first associated body</p></dd><dt class="param">anchor1</dt><dd class="cmt"><p>first connection point</p></dd><dt class="param">node2</dt><dd class="cmt"><p>second associated body</p></dd><dt class="param">anchor2</dt><dd class="cmt"><p>second connection point</p></dd></dl> + + + + </div> + + <div id="template"> + + <div id="mbrsel"> + <div id="ancestors"> + <h3>Inherits</h3> + <ol><li class="in" name="scala.Product">Product</li><li class="in" name="scala.Equals">Equals</li><li class="in" name="sims.dynamics.joints.Joint">Joint</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.dynamics.joints.DistanceJoint#anchor1"> + <h4 class="signature"> + <span class="kind">val</span> + <span class="symbol"> + <span class="name">anchor1</span><span class="result">: <a href="../../geometry/Vector2D.html" class="extype" name="sims.geometry.Vector2D">Vector2D</a></span> + </span> + </h4> + + </li><li name="sims.dynamics.joints.DistanceJoint#anchor2"> + <h4 class="signature"> + <span class="kind">val</span> + <span class="symbol"> + <span class="name">anchor2</span><span class="result">: <a href="../../geometry/Vector2D.html" class="extype" name="sims.geometry.Vector2D">Vector2D</a></span> + </span> + </h4> + + </li><li name="sims.dynamics.joints.DistanceJoint#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.dynamics.joints.DistanceJoint#connection1"> + <h4 class="signature"> + <span class="kind">def</span> + <span class="symbol"> + <span class="name">connection1</span><span class="result">: <a href="../../geometry/Vector2D.html" class="extype" name="sims.geometry.Vector2D">Vector2D</a></span> + </span> + </h4> + <p class="shortcomment cmt">Returns the connection point on body one (in world coordinates)</p><div class="fullcomment"> + <div class="comment cmt"><p>Returns the connection point on body one (in world coordinates).</p></div> + + + + + </div> + </li><li name="sims.dynamics.joints.DistanceJoint#connection2"> + <h4 class="signature"> + <span class="kind">def</span> + <span class="symbol"> + <span class="name">connection2</span><span class="result">: <a href="../../geometry/Vector2D.html" class="extype" name="sims.geometry.Vector2D">Vector2D</a></span> + </span> + </h4> + <p class="shortcomment cmt">Returns the connection point on body two (in world coordinates)</p><div class="fullcomment"> + <div class="comment cmt"><p>Returns the connection point on body two (in world coordinates).</p></div> + + + + + </div> + </li><li name="sims.dynamics.joints.DistanceJoint#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 this joint's associated bodies</p><div class="fullcomment"> + <div class="comment cmt"><p>Corrects the positions of this joint's associated bodies.@param h a time interval, used for converting forces and impulses</p></div> + + + + + </div> + </li><li name="sims.dynamics.joints.DistanceJoint#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 this joint's associated bodies</p><div class="fullcomment"> + <div class="comment cmt"><p>Corrects the velocities of this joint's associated bodies.@param h a time interval, used for converting forces and impulses</p></div> + + + + + </div> + </li><li name="sims.dynamics.joints.DistanceJoint#distance"> + <h4 class="signature"> + <span class="kind">val</span> + <span class="symbol"> + <span class="name">distance</span><span class="result">: <span class="extype" name="scala.Double">Double</span></span> + </span> + </h4> + <p class="shortcomment cmt">Distance between the two connection points at initialisation (the desired distance)</p><div class="fullcomment"> + <div class="comment cmt"><p>Distance between the two connection points at initialisation (the desired distance).</p></div> + + + + + </div> + </li><li name="sims.dynamics.joints.DistanceJoint#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.dynamics.joints.DistanceJoint#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.dynamics.joints.DistanceJoint#node1"> + <h4 class="signature"> + <span class="kind">val</span> + <span class="symbol"> + <span class="name">node1</span><span class="result">: <a href="../Body.html" class="extype" name="sims.dynamics.Body">Body</a></span> + </span> + </h4> + <p class="shortcomment cmt">First body of the joint</p><div class="fullcomment"> + <div class="comment cmt"><p>First body of the joint.</p></div> + + + + + </div> + </li><li name="sims.dynamics.joints.DistanceJoint#node2"> + <h4 class="signature"> + <span class="kind">val</span> + <span class="symbol"> + <span class="name">node2</span><span class="result">: <a href="../Body.html" class="extype" name="sims.dynamics.Body">Body</a></span> + </span> + </h4> + <p class="shortcomment cmt">Second body of the joint</p><div class="fullcomment"> + <div class="comment cmt"><p>Second body of the joint.</p></div> + + + + + </div> + </li><li name="sims.dynamics.joints.DistanceJoint#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.dynamics.joints.DistanceJoint#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.dynamics.joints.DistanceJoint#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.dynamics.joints.DistanceJoint#toString"> + <h4 class="signature"> + <span class="kind">def</span> + <span class="symbol"> + <span class="name">toString</span><span class="params">()</span><span class="result">: <span class="extype" name="java.lang.String">String</span></span> + </span> + </h4> + <p class="shortcomment cmt">Returns a string representation of the object</p><div class="fullcomment"> + <div class="comment cmt"><p>Returns a string representation of the object. +<p> +The default representation is platform dependent. +</p></div> + + + + + </div> + </li><li name="sims.dynamics.joints.DistanceJoint#v"> + <h4 class="signature"> + <span class="kind">def</span> + <span class="symbol"> + <span class="name">v</span><span class="result">: <a href="../../geometry/Vector2D.html" class="extype" name="sims.geometry.Vector2D">Vector2D</a></span> + </span> + </h4> + <p class="shortcomment cmt">Relative velocity of the connection points</p><div class="fullcomment"> + <div class="comment cmt"><p>Relative velocity of the connection points.</p></div> + + + + + </div> + </li><li name="sims.dynamics.joints.DistanceJoint#x"> + <h4 class="signature"> + <span class="kind">def</span> + <span class="symbol"> + <span class="name">x</span><span class="result">: <a href="../../geometry/Vector2D.html" class="extype" name="sims.geometry.Vector2D">Vector2D</a></span> + </span> + </h4> + <p class="shortcomment cmt">Relative position of the connection points</p><div class="fullcomment"> + <div class="comment cmt"><p>Relative position of the connection points.</p></div> + + + + + </div> + </li></ol> + </div> + + <div class="members" id="constructors"> + <h3>Instance constructors</h3> + <ol><li name="sims.dynamics.joints.DistanceJoint#this"> + <h4 class="signature"> + <span class="kind">new</span> + <span class="symbol"> + <span class="name">DistanceJoint</span><span class="params">(<span name="node1">node1: <a href="../Body.html" class="extype" name="sims.dynamics.Body">Body</a></span>, <span name="node2">node2: <a href="../Body.html" class="extype" name="sims.dynamics.Body">Body</a></span>)</span> + </span> + </h4> + + </li><li name="sims.dynamics.joints.DistanceJoint#this"> + <h4 class="signature"> + <span class="kind">new</span> + <span class="symbol"> + <span class="name">DistanceJoint</span><span class="params">(<span name="node1">node1: <a href="../Body.html" class="extype" name="sims.dynamics.Body">Body</a></span>, <span name="anchor1">anchor1: <a href="../../geometry/Vector2D.html" class="extype" name="sims.geometry.Vector2D">Vector2D</a></span>, <span name="node2">node2: <a href="../Body.html" class="extype" name="sims.dynamics.Body">Body</a></span>, <span name="anchor2">anchor2: <a href="../../geometry/Vector2D.html" class="extype" name="sims.geometry.Vector2D">Vector2D</a></span>)</span> + </span> + </h4> + + </li><li name="sims.dynamics.joints.Joint#this"> + <h4 class="signature"> + <span class="kind">new</span> + <span class="symbol"> + <span class="name">DistanceJoint</span><span class="params">()</span> + </span> + </h4> + + </li></ol> + </div> + + </div> + + </body> </html>
\ No newline at end of file diff --git a/doc/sims/dynamics/joints/ForceJoint.html b/doc/sims/dynamics/joints/ForceJoint.html index 58215b4..76bfe45 100644 --- a/doc/sims/dynamics/joints/ForceJoint.html +++ b/doc/sims/dynamics/joints/ForceJoint.html @@ -1,107 +1,166 @@ -<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
+<?xml version='1.0' encoding='UTF-8'?> +<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.1//EN" "http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd"> <html> - <head><title>trait ForceJoint in sims.dynamics.joints</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.dynamics.joints.ForceJoint</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/dynamics/joints$package.html" target="_self">sims.dynamics.joints</a> - <br></br> - <span class="entity">trait ForceJoint</span> - </div><hr></hr> - <div class="source"> - [source: <a href="" class="sims/dynamics/joints/ForceJoint"><code>sims/dynamics/joints/ForceJoint.scala</code></a>] - </div><hr></hr> - <a name="ForceJoint"></a><dl> - <dt> - - <code></code> - <code>trait</code> - <em>ForceJoint</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 joint which can apply a force to its anchor bodies, thus adding or removing energy to the system.</dd></dl> - <dl></dl> - <dl> - <dt style="margin:10px 0 0 20px;"><b>Direct Known Subclasses:</b></dt> - <dd><a href="../../../sims/dynamics/joints/SpringJoint.html" target="_self">SpringJoint</a></dd> - </dl><hr></hr> + <body class="type"> + <p id="owner"><a href="../../package.html">sims</a>.<a href="../package.html">dynamics</a>.<a href="package.html">joints</a></p> + <div id="definition"> + <img src="../../../lib/trait_big.png" /> + <h1>ForceJoint</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>abstract def</code> - </td> - <td class="signature"> - <em><a href="../../../sims/dynamics/joints/ForceJoint.html#applyForce%28%29" target="_self">applyForce</a></em> - : <a href="http://www.scala-lang.org/docu/files/api/scala/Unit.html" target="_self">Unit</a> + <h4 class="signature"> + <span class="kind">trait</span> + <span class="symbol"> + <span class="name">ForceJoint</span><span class="result"> extends AnyRef</span> + </span> + </h4> + <div class="fullcomment" id="comment"> + <div class="comment cmt"><p>A joint which can apply a force to its anchor bodies, thus adding or removing energy to the system.</p></div> + + + + <div class="block"> + known subclasses: <a href="SpringJoint.html">SpringJoint</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>Applies a force on the achor bodies.</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.dynamics.joints.ForceJoint#applyForce"> + <h4 class="signature"> + <span class="kind">def</span> + <span class="symbol"> + <span class="name">applyForce</span><span class="params">()</span><span class="result">: <span class="extype" name="scala.Unit">Unit</span></span> + </span> + </h4> + <p class="shortcomment cmt">Applies a force on the achor bodies</p><div class="fullcomment"> + <div class="comment cmt"><p>Applies a force on the achor bodies.</p></div> - - -<table summary="" cellpadding="3" class="member-detail"> - <tr><td class="title">Method Details</td></tr> - </table><div><a name="applyForce%28%29"></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></ol> + </div> - <code>abstract</code> - <code>def</code> - <em>applyForce</em> : <a href="http://www.scala-lang.org/docu/files/api/scala/Unit.html" target="_self">Unit</a> - </dt> - <dd></dd> - </dl> - <dl><dd>Applies a force on the achor bodies.</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/dynamics/joints/Joint.html b/doc/sims/dynamics/joints/Joint.html index 0e6908f..4874434 100644 --- a/doc/sims/dynamics/joints/Joint.html +++ b/doc/sims/dynamics/joints/Joint.html @@ -1,194 +1,228 @@ -<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
+<?xml version='1.0' encoding='UTF-8'?> +<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.1//EN" "http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd"> <html> - <head><title>class Joint in sims.dynamics.joints</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.dynamics.joints.Joint</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/dynamics/joints$package.html" target="_self">sims.dynamics.joints</a> - <br></br> - <span class="entity">class Joint</span> - </div><hr></hr> - <div class="source"> - [source: <a href="" class="sims/dynamics/joints/Joint"><code>sims/dynamics/joints/Joint.scala</code></a>] - </div><hr></hr> - <a name="Joint"></a><dl> - <dt> - - <code>abstract</code> - <code>class</code> - <em>Joint</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>Joints constrain the movement of two bodies.
- Their implementation was inspired by Erin Catto's box2d.</dd></dl> - <dl></dl> - <dl> - <dt style="margin:10px 0 0 20px;"><b>Direct Known Subclasses:</b></dt> - <dd><a href="../../../sims/dynamics/joints/DistanceJoint.html" target="_self">DistanceJoint</a>, <a href="../../../sims/dynamics/joints/RevoluteJoint.html" target="_self">RevoluteJoint</a>, <a href="../../../sims/dynamics/joints/SpringJoint.html" target="_self">SpringJoint</a>, <a href="../../../sims/dynamics/joints/test/PrismaticJoint.html" target="_self">PrismaticJoint</a>, <a href="../../../sims/dynamics/joints/test/UnitCircleJoint.html" target="_self">UnitCircleJoint</a></dd> - </dl><hr></hr> + <body class="type"> + <p id="owner"><a href="../../package.html">sims</a>.<a href="../package.html">dynamics</a>.<a href="package.html">joints</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/dynamics/joints/Joint.html#node1" target="_self">node1</a></em> - : <a href="../../../sims/dynamics/Body.html" target="_self">Body</a> - - <div>First body of the joint.</div> - </td> - </tr> -<tr> - <td class="modifiers" valign="top"> - <code>abstract val</code> - </td> - <td class="signature"> - <em><a href="../../../sims/dynamics/joints/Joint.html#node2" target="_self">node2</a></em> - : <a href="../../../sims/dynamics/Body.html" target="_self">Body</a> - - <div>Second body of the joint.</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/dynamics/joints/Joint.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 this joint's associated bodies.</div> - </td> - </tr> -<tr> - <td class="modifiers" valign="top"> - <code>abstract def</code> - </td> - <td class="signature"> - <em><a href="../../../sims/dynamics/joints/Joint.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 this joint's associated bodies.</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>Joint</h1> + </div> + <h4 class="signature"> + <span class="kind">class</span> + <span class="symbol"> + <span class="name">Joint</span><span class="result"> extends <a href="../Constraint.html" class="extype" name="sims.dynamics.Constraint">Constraint</a></span> + </span> + </h4> + <div class="fullcomment" id="comment"> + <div class="comment cmt"><p>Joints constrain the movement of two bodies. +Their implementation was inspired by Erin Catto's box2d.</p></div> - -<table summary="" cellpadding="3" class="member-detail"> - <tr><td class="title">Value Details</td></tr> - </table><div><a name="node1"></a><dl> - <dt> + <div class="block"> + attributes: abstract + </div> + + <div class="block"> + known subclasses: <a href="test/UnitCircleJoint.html">UnitCircleJoint</a>, <a href="test/PrismaticJoint.html">PrismaticJoint</a>, <a href="SpringJoint.html">SpringJoint</a>, <a href="RevoluteJoint.html">RevoluteJoint</a>, <a href="DistanceJoint.html">DistanceJoint</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>node1</em> : <a href="../../../sims/dynamics/Body.html" target="_self">Body</a> - </dt> - <dd></dd> - </dl> - <dl><dd>First body of the joint.</dd></dl> - <dl></dl> - <hr></hr> -<a name="node2"></a><dl> - <dt> - <code>abstract</code> - <code>val</code> - <em>node2</em> : <a href="../../../sims/dynamics/Body.html" target="_self">Body</a> - </dt> - <dd></dd> - </dl> - <dl><dd>Second body of the joint.</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> + <div class="members" id="values"> + <h3>Value Members</h3> + <ol><li name="sims.dynamics.joints.Joint#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 this joint's associated bodies</p><div class="fullcomment"> + <div class="comment cmt"><p>Corrects the positions of this joint's associated bodies.@param h a time interval, used for converting forces and impulses</p></div> + + <div class="block"> + attributes: abstract + </div> + + + </div> + </li><li name="sims.dynamics.joints.Joint#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 this joint's associated bodies</p><div class="fullcomment"> + <div class="comment cmt"><p>Corrects the velocities of this joint's associated bodies.@param h a time interval, used for converting forces and impulses</p></div> + + <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="sims.dynamics.joints.Joint#node1"> + <h4 class="signature"> + <span class="kind">val</span> + <span class="symbol"> + <span class="name">node1</span><span class="result">: <a href="../Body.html" class="extype" name="sims.dynamics.Body">Body</a></span> + </span> + </h4> + <p class="shortcomment cmt">First body of the joint</p><div class="fullcomment"> + <div class="comment cmt"><p>First body of the joint.</p></div> + + <div class="block"> + attributes: abstract + </div> + + + </div> + </li><li name="sims.dynamics.joints.Joint#node2"> + <h4 class="signature"> + <span class="kind">val</span> + <span class="symbol"> + <span class="name">node2</span><span class="result">: <a href="../Body.html" class="extype" name="sims.dynamics.Body">Body</a></span> + </span> + </h4> + <p class="shortcomment cmt">Second body of the joint</p><div class="fullcomment"> + <div class="comment cmt"><p>Second body of the joint.</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>abstract</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 this joint's associated bodies.</dd></dl> - <dl></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="correctPosition%28Double%29"></a><dl> - <dt> + <div class="members" id="constructors"> + <h3>Instance constructors</h3> + <ol><li name="sims.dynamics.joints.Joint#this"> + <h4 class="signature"> + <span class="kind">new</span> + <span class="symbol"> + <span class="name">Joint</span><span class="params">()</span> + </span> + </h4> + + </li></ol> + </div> - <code>abstract</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 this joint's associated bodies.</dd></dl> - <dl></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/dynamics/joints/RevoluteJoint$object.html b/doc/sims/dynamics/joints/RevoluteJoint$object.html deleted file mode 100644 index c8a5d71..0000000 --- a/doc/sims/dynamics/joints/RevoluteJoint$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 RevoluteJoint in sims.dynamics.joints</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/dynamics/joints$package.html" target="_self">sims.dynamics.joints</a> - <br></br> - <span class="entity">object RevoluteJoint</span> - </div><hr></hr> - <div class="source"> - [source: <a href="" class="sims/dynamics/joints/RevoluteJoint"><code>sims/dynamics/joints/RevoluteJoint.scala</code></a>] - </div><hr></hr> - <a name="RevoluteJoint"></a><dl> - <dt> - - <code></code> - <code>object</code> - <em>RevoluteJoint</em> - </dt> - <dd><code> extends </code>(<a href="../../../sims/dynamics/Body.html" target="_self">Body</a>, <a href="../../../sims/dynamics/Body.html" target="_self">Body</a>, <a href="../../../sims/geometry/Vector2D.html" target="_self">Vector2D</a>) => <a href="../../../sims/dynamics/joints/RevoluteJoint.html" target="_self">RevoluteJoint</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/dynamics/joints/RevoluteJoint.html b/doc/sims/dynamics/joints/RevoluteJoint.html index 5184b29..921025a 100644 --- a/doc/sims/dynamics/joints/RevoluteJoint.html +++ b/doc/sims/dynamics/joints/RevoluteJoint.html @@ -1,421 +1,307 @@ -<!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 RevoluteJoint in sims.dynamics.joints</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/dynamics/joints$package.html" target="_self">sims.dynamics.joints</a> - <br></br> - <span class="entity">class RevoluteJoint</span> - </div><hr></hr> - <div class="source"> - [source: <a href="" class="sims/dynamics/joints/RevoluteJoint"><code>sims/dynamics/joints/RevoluteJoint.scala</code></a>] - </div><hr></hr> - <a name="RevoluteJoint"></a><dl> - <dt> - - <code>case</code> - <code>class</code> - <em>RevoluteJoint</em>(<code>val </code><em>node1</em> : <a href="../../../sims/dynamics/Body.html" target="_self">Body</a>, <code>val </code><em>node2</em> : <a href="../../../sims/dynamics/Body.html" target="_self">Body</a>, <code>val </code><em>anchor</em> : <a href="../../../sims/geometry/Vector2D.html" target="_self">Vector2D</a>) - </dt> - <dd><code> extends </code><a href="../../../sims/dynamics/joints/Joint.html" target="_self">Joint</a><code> with </code><a href="" target="contentFrame" class="scala/Product">scala.Product</a></dd> - </dl> - <dl><dd>A revolute joint that connects two bodies at a singe point. Inspired from JBox2D.
- <b>Warning:</b> there are still several bugs with revolute joints, if they are between two free
- bodies and not connected at their respective COMs.</dd></dl> - <dl></dl> + <head> + <title>Scaladoc for sims.dynamics.joints.RevoluteJoint</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">dynamics</a>.<a href="package.html">joints</a></p> + <div id="definition"> + <img src="../../../lib/class_big.png" /> + <h1>RevoluteJoint</h1> + </div> -<table summary="" cellpadding="3" class="member"> - <tr><td class="title" colspan="2">Method Summary</td></tr> - <tr> - <td class="modifiers" valign="top"> - <code> def</code> - </td> - <td class="signature"> - <em><a href="../../../sims/dynamics/joints/RevoluteJoint.html#connection1" target="_self">connection1</a></em> - : <a href="../../../sims/geometry/Vector2D.html" target="_self">Vector2D</a> - - - </td> - </tr> -<tr> - <td class="modifiers" valign="top"> - <code> def</code> - </td> - <td class="signature"> - <em><a href="../../../sims/dynamics/joints/RevoluteJoint.html#connection2" target="_self">connection2</a></em> - : <a href="../../../sims/geometry/Vector2D.html" target="_self">Vector2D</a> - - - </td> - </tr> -<tr> - <td class="modifiers" valign="top"> - <code> def</code> - </td> - <td class="signature"> - <em><a href="../../../sims/dynamics/joints/RevoluteJoint.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 this joint's associated bodies.</div> - </td> - </tr> -<tr> - <td class="modifiers" valign="top"> - <code> def</code> - </td> - <td class="signature"> - <em><a href="../../../sims/dynamics/joints/RevoluteJoint.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 this joint's associated bodies.</div> - </td> - </tr> -<tr> - <td class="modifiers" valign="top"> - <code>override def</code> - </td> - <td class="signature"> - <em><a href="../../../sims/dynamics/joints/RevoluteJoint.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/dynamics/joints/RevoluteJoint.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/dynamics/joints/RevoluteJoint.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/dynamics/joints/RevoluteJoint.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/dynamics/joints/RevoluteJoint.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/dynamics/joints/RevoluteJoint.html#toString%28%29" target="_self">toString</a></em> - : <a href="" target="contentFrame" class="java/lang/String">java.lang.String</a> - - <div>Returns a string representation of the object.</div> - </td> - </tr> -<tr> - <td class="modifiers" valign="top"> - <code> def</code> - </td> - <td class="signature"> - <em><a href="../../../sims/dynamics/joints/RevoluteJoint.html#v" target="_self">v</a></em> - : <a href="../../../sims/geometry/Vector2D.html" target="_self">Vector2D</a> - - - </td> - </tr> -<tr> - <td class="modifiers" valign="top"> - <code> def</code> - </td> - <td class="signature"> - <em><a href="../../../sims/dynamics/joints/RevoluteJoint.html#x" target="_self">x</a></em> - : <a href="../../../sims/geometry/Vector2D.html" target="_self">Vector2D</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> - - + <h4 class="signature"> + <span class="kind">class</span> + <span class="symbol"> + <span class="name">RevoluteJoint</span><span class="params">(<span name="node1">node1: <a href="../Body.html" class="extype" name="sims.dynamics.Body">Body</a></span>, <span name="node2">node2: <a href="../Body.html" class="extype" name="sims.dynamics.Body">Body</a></span>, <span name="anchor">anchor: <a href="../../geometry/Vector2D.html" class="extype" name="sims.geometry.Vector2D">Vector2D</a></span>)</span><span class="result"> extends <a href="Joint.html" class="extype" name="sims.dynamics.joints.Joint">Joint</a> with <span class="extype" name="scala.Product">Product</span></span> + </span> + </h4> + <div class="fullcomment" id="comment"> + <div class="comment cmt"><p>A revolute joint that connects two bodies at a singe point. Inspired from JBox2D. +<b>Warning:</b> there are still several bugs with revolute joints, if they are between two free +bodies and not connected at their respective COMs.</p></div> - - -<table summary="" cellpadding="3" class="member-detail"> - <tr><td class="title">Method Details</td></tr> - </table><div><a name="connection1"></a><dl> - <dt> - - <code></code> - <code>def</code> - <em>connection1</em> : <a href="../../../sims/geometry/Vector2D.html" target="_self">Vector2D</a> - </dt> - <dd></dd> - </dl><hr></hr> -<a name="connection2"></a><dl> - <dt> - - <code></code> - <code>def</code> - <em>connection2</em> : <a href="../../../sims/geometry/Vector2D.html" target="_self">Vector2D</a> - </dt> - <dd></dd> - </dl><hr></hr> -<a name="x"></a><dl> - <dt> - - <code></code> - <code>def</code> - <em>x</em> : <a href="../../../sims/geometry/Vector2D.html" target="_self">Vector2D</a> - </dt> - <dd></dd> - </dl><hr></hr> -<a name="v"></a><dl> - <dt> - - <code></code> - <code>def</code> - <em>v</em> : <a href="../../../sims/geometry/Vector2D.html" target="_self">Vector2D</a> - </dt> - <dd></dd> - </dl><hr></hr> -<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 this joint's associated bodies.</dd></dl> - <dl></dl> - <dl> - <dt style="margin:10px 0 0 20px;"> - <b>Overrides</b> - </dt> - <dd> - <a href="../../../sims/dynamics/joints/Joint.html" target="_self">Joint</a>.<a href="../../../sims/dynamics/joints/Joint.html#correctVelocity%28Double%29" target="_self">correctVelocity</a> - </dd> - </dl><hr></hr> -<a name="correctPosition%28Double%29"></a><dl> - <dt> - - <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 this joint's associated bodies.</dd></dl> - <dl></dl> - <dl> - <dt style="margin:10px 0 0 20px;"> - <b>Overrides</b> - </dt> - <dd> - <a href="../../../sims/dynamics/joints/Joint.html" target="_self">Joint</a>.<a href="../../../sims/dynamics/joints/Joint.html#correctPosition%28Double%29" target="_self">correctPosition</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> - <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.dynamics.joints.Joint">Joint</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.dynamics.joints.RevoluteJoint#anchor"> + <h4 class="signature"> + <span class="kind">val</span> + <span class="symbol"> + <span class="name">anchor</span><span class="result">: <a href="../../geometry/Vector2D.html" class="extype" name="sims.geometry.Vector2D">Vector2D</a></span> + </span> + </h4> + + </li><li name="sims.dynamics.joints.RevoluteJoint#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.dynamics.joints.RevoluteJoint#connection1"> + <h4 class="signature"> + <span class="kind">def</span> + <span class="symbol"> + <span class="name">connection1</span><span class="result">: <a href="../../geometry/Vector2D.html" class="extype" name="sims.geometry.Vector2D">Vector2D</a></span> + </span> + </h4> + + </li><li name="sims.dynamics.joints.RevoluteJoint#connection2"> + <h4 class="signature"> + <span class="kind">def</span> + <span class="symbol"> + <span class="name">connection2</span><span class="result">: <a href="../../geometry/Vector2D.html" class="extype" name="sims.geometry.Vector2D">Vector2D</a></span> + </span> + </h4> + + </li><li name="sims.dynamics.joints.RevoluteJoint#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 this joint's associated bodies</p><div class="fullcomment"> + <div class="comment cmt"><p>Corrects the positions of this joint's associated bodies.@param h a time interval, used for converting forces and impulses</p></div> + + + + + </div> + </li><li name="sims.dynamics.joints.RevoluteJoint#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 this joint's associated bodies</p><div class="fullcomment"> + <div class="comment cmt"><p>Corrects the velocities of this joint's associated bodies.@param h a time interval, used for converting forces and impulses</p></div> + + + + + </div> + </li><li name="sims.dynamics.joints.RevoluteJoint#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.dynamics.joints.RevoluteJoint#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.dynamics.joints.RevoluteJoint#node1"> + <h4 class="signature"> + <span class="kind">val</span> + <span class="symbol"> + <span class="name">node1</span><span class="result">: <a href="../Body.html" class="extype" name="sims.dynamics.Body">Body</a></span> + </span> + </h4> + <p class="shortcomment cmt">First body of the joint</p><div class="fullcomment"> + <div class="comment cmt"><p>First body of the joint.</p></div> + + + + + </div> + </li><li name="sims.dynamics.joints.RevoluteJoint#node2"> + <h4 class="signature"> + <span class="kind">val</span> + <span class="symbol"> + <span class="name">node2</span><span class="result">: <a href="../Body.html" class="extype" name="sims.dynamics.Body">Body</a></span> + </span> + </h4> + <p class="shortcomment cmt">Second body of the joint</p><div class="fullcomment"> + <div class="comment cmt"><p>Second body of the joint.</p></div> + + + + + </div> + </li><li name="sims.dynamics.joints.RevoluteJoint#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.dynamics.joints.RevoluteJoint#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.dynamics.joints.RevoluteJoint#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.dynamics.joints.RevoluteJoint#toString"> + <h4 class="signature"> + <span class="kind">def</span> + <span class="symbol"> + <span class="name">toString</span><span class="params">()</span><span class="result">: <span class="extype" name="java.lang.String">String</span></span> + </span> + </h4> + <p class="shortcomment cmt">Returns a string representation of the object</p><div class="fullcomment"> + <div class="comment cmt"><p>Returns a string representation of the object. +<p> +The default representation is platform dependent. +</p></div> + + + + + </div> + </li><li name="sims.dynamics.joints.RevoluteJoint#v"> + <h4 class="signature"> + <span class="kind">def</span> + <span class="symbol"> + <span class="name">v</span><span class="result">: <a href="../../geometry/Vector2D.html" class="extype" name="sims.geometry.Vector2D">Vector2D</a></span> + </span> + </h4> + + </li><li name="sims.dynamics.joints.RevoluteJoint#x"> + <h4 class="signature"> + <span class="kind">def</span> + <span class="symbol"> + <span class="name">x</span><span class="result">: <a href="../../geometry/Vector2D.html" class="extype" name="sims.geometry.Vector2D">Vector2D</a></span> + </span> + </h4> + + </li></ol> + </div> + + <div class="members" id="constructors"> + <h3>Instance constructors</h3> + <ol><li name="sims.dynamics.joints.RevoluteJoint#this"> + <h4 class="signature"> + <span class="kind">new</span> + <span class="symbol"> + <span class="name">RevoluteJoint</span><span class="params">(<span name="node1">node1: <a href="../Body.html" class="extype" name="sims.dynamics.Body">Body</a></span>, <span name="node2">node2: <a href="../Body.html" class="extype" name="sims.dynamics.Body">Body</a></span>, <span name="anchor">anchor: <a href="../../geometry/Vector2D.html" class="extype" name="sims.geometry.Vector2D">Vector2D</a></span>)</span> + </span> + </h4> + + </li><li name="sims.dynamics.joints.Joint#this"> + <h4 class="signature"> + <span class="kind">new</span> + <span class="symbol"> + <span class="name">RevoluteJoint</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/dynamics/joints/SpringJoint$object.html b/doc/sims/dynamics/joints/SpringJoint$object.html deleted file mode 100644 index 7730d19..0000000 --- a/doc/sims/dynamics/joints/SpringJoint$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 SpringJoint in sims.dynamics.joints</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/dynamics/joints$package.html" target="_self">sims.dynamics.joints</a> - <br></br> - <span class="entity">object SpringJoint</span> - </div><hr></hr> - <div class="source"> - [source: <a href="" class="sims/dynamics/joints/SpringJoint"><code>sims/dynamics/joints/SpringJoint.scala</code></a>] - </div><hr></hr> - <a name="SpringJoint"></a><dl> - <dt> - - <code></code> - <code>object</code> - <em>SpringJoint</em> - </dt> - <dd><code> extends </code>(<a href="../../../sims/dynamics/Body.html" target="_self">Body</a>, <a href="../../../sims/geometry/Vector2D.html" target="_self">Vector2D</a>, <a href="../../../sims/dynamics/Body.html" target="_self">Body</a>, <a href="../../../sims/geometry/Vector2D.html" target="_self">Vector2D</a>, <a href="http://www.scala-lang.org/docu/files/api/scala/Double.html" target="_self">Double</a>, <a href="http://www.scala-lang.org/docu/files/api/scala/Double.html" target="_self">Double</a>) => <a href="../../../sims/dynamics/joints/SpringJoint.html" target="_self">SpringJoint</a></dd> - </dl> - - - -<table summary="" cellpadding="3" class="inherited"> - <tr><td class="title" colspan="2"> - Methods inherited from <a href="" target="contentFrame" class="scala/Function6">scala.Function6</a> - </td></tr> - <tr><td class="signature" colspan="2"> - <a href="#toString" target="contentFrame" class="scala/Function6">scala.Function6.toString</a>, <a href="#curry" target="contentFrame" class="scala/Function6">scala.Function6.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/dynamics/joints/SpringJoint.html b/doc/sims/dynamics/joints/SpringJoint.html index 4819b16..699f2e0 100644 --- a/doc/sims/dynamics/joints/SpringJoint.html +++ b/doc/sims/dynamics/joints/SpringJoint.html @@ -1,574 +1,419 @@ -<!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 SpringJoint in sims.dynamics.joints</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/dynamics/joints$package.html" target="_self">sims.dynamics.joints</a> - <br></br> - <span class="entity">class SpringJoint</span> - </div><hr></hr> - <div class="source"> - [source: <a href="" class="sims/dynamics/joints/SpringJoint"><code>sims/dynamics/joints/SpringJoint.scala</code></a>] - </div><hr></hr> - <a name="SpringJoint"></a><dl> - <dt> - - <code>case</code> - <code>class</code> - <em>SpringJoint</em>(<code>val </code><em>node1</em> : <a href="../../../sims/dynamics/Body.html" target="_self">Body</a>, <code>val </code><em>anchor1</em> : <a href="../../../sims/geometry/Vector2D.html" target="_self">Vector2D</a>, <code>val </code><em>node2</em> : <a href="../../../sims/dynamics/Body.html" target="_self">Body</a>, <code>val </code><em>anchor2</em> : <a href="../../../sims/geometry/Vector2D.html" target="_self">Vector2D</a>, <code>val </code><em>springConstant</em> : <a href="http://www.scala-lang.org/docu/files/api/scala/Double.html" target="_self">Double</a>, <code>val </code><em>initialLength</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="../../../sims/dynamics/joints/Joint.html" target="_self">Joint</a><code> with </code><a href="../../../sims/dynamics/joints/ForceJoint.html" target="_self">ForceJoint</a><code> with </code><a href="" target="contentFrame" class="scala/Product">scala.Product</a></dd> - </dl> - <dl><dd>A spring obeying Hooke's law.</dd></dl> - <dl><dt style="margin:10px 0 0 20px;"> - <b>Parameters</b></dt><dd><code>node1 - </code>first associated body</dd><dd><code>anchor1 - </code>first connection point</dd><dd><code>node2 - </code>second associated body</dd><dd><code>anchor2 - </code>second connection point</dd><dd><code>springConstant - </code>spring constant</dd><dd><code>initialLength - </code>initial length</dd></dl> + <head> + <title>Scaladoc for sims.dynamics.joints.SpringJoint</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/dynamics/joints/SpringJoint.html#this%28sims.dynamics.Body%2Csims.dynamics.Body%2CDouble%2CDouble%29" target="_self">this</a></em> - (<em>node1</em> : <a href="../../../sims/dynamics/Body.html" target="_self">Body</a>, <em>node2</em> : <a href="../../../sims/dynamics/Body.html" target="_self">Body</a>, <em>springConstant</em> : <a href="http://www.scala-lang.org/docu/files/api/scala/Double.html" target="_self">Double</a>, <em>initialLength</em> : <a href="http://www.scala-lang.org/docu/files/api/scala/Double.html" target="_self">Double</a>) : <a href="../../../sims/dynamics/joints/SpringJoint.html" target="_self">SpringJoint</a> - - - </td> - </tr> -<tr> - <td class="modifiers" valign="top"> - <code> def</code> - </td> - <td class="signature"> - <em><a href="../../../sims/dynamics/joints/SpringJoint.html#this%28sims.dynamics.Body%2Csims.geometry.Vector2D%2Csims.dynamics.Body%2Csims.geometry.Vector2D%2CDouble%29" target="_self">this</a></em> - (<em>node1</em> : <a href="../../../sims/dynamics/Body.html" target="_self">Body</a>, <em>anchor1</em> : <a href="../../../sims/geometry/Vector2D.html" target="_self">Vector2D</a>, <em>node2</em> : <a href="../../../sims/dynamics/Body.html" target="_self">Body</a>, <em>anchor2</em> : <a href="../../../sims/geometry/Vector2D.html" target="_self">Vector2D</a>, <em>springConstant</em> : <a href="http://www.scala-lang.org/docu/files/api/scala/Double.html" target="_self">Double</a>) : <a href="../../../sims/dynamics/joints/SpringJoint.html" target="_self">SpringJoint</a> - - - </td> - </tr> -<tr> - <td class="modifiers" valign="top"> - <code> def</code> - </td> - <td class="signature"> - <em><a href="../../../sims/dynamics/joints/SpringJoint.html#this%28sims.dynamics.Body%2Csims.dynamics.Body%2CDouble%29" target="_self">this</a></em> - (<em>node1</em> : <a href="../../../sims/dynamics/Body.html" target="_self">Body</a>, <em>node2</em> : <a href="../../../sims/dynamics/Body.html" target="_self">Body</a>, <em>springConstant</em> : <a href="http://www.scala-lang.org/docu/files/api/scala/Double.html" target="_self">Double</a>) : <a href="../../../sims/dynamics/joints/SpringJoint.html" target="_self">SpringJoint</a> - - - </td> - </tr> - </table> - -<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/dynamics/joints/SpringJoint.html#damping" target="_self">damping</a></em> - : <a href="http://www.scala-lang.org/docu/files/api/scala/Double.html" target="_self">Double</a> - - <div>Damping.</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/dynamics/joints/SpringJoint.html#applyForce%28%29" target="_self">applyForce</a></em> - : <a href="http://www.scala-lang.org/docu/files/api/scala/Unit.html" target="_self">Unit</a> - - <div>Applies the spring force to the connection points.</div> - </td> - </tr> -<tr> - <td class="modifiers" valign="top"> - <code> def</code> - </td> - <td class="signature"> - <em><a href="../../../sims/dynamics/joints/SpringJoint.html#connection1" target="_self">connection1</a></em> - : <a href="../../../sims/geometry/Vector2D.html" target="_self">Vector2D</a> - - <div>Returns the connection point on body one (in world coordinates).</div> - </td> - </tr> -<tr> - <td class="modifiers" valign="top"> - <code> def</code> - </td> - <td class="signature"> - <em><a href="../../../sims/dynamics/joints/SpringJoint.html#connection2" target="_self">connection2</a></em> - : <a href="../../../sims/geometry/Vector2D.html" target="_self">Vector2D</a> - - <div>Returns the connection point on body two (in world coordinates).</div> - </td> - </tr> -<tr> - <td class="modifiers" valign="top"> - <code> def</code> - </td> - <td class="signature"> - <em><a href="../../../sims/dynamics/joints/SpringJoint.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 this joint's associated bodies.</div> - </td> - </tr> -<tr> - <td class="modifiers" valign="top"> - <code> def</code> - </td> - <td class="signature"> - <em><a href="../../../sims/dynamics/joints/SpringJoint.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 this joint's associated bodies.</div> - </td> - </tr> -<tr> - <td class="modifiers" valign="top"> - <code>override def</code> - </td> - <td class="signature"> - <em><a href="../../../sims/dynamics/joints/SpringJoint.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> def</code> - </td> - <td class="signature"> - <em><a href="../../../sims/dynamics/joints/SpringJoint.html#force" target="_self">force</a></em> - : <a href="http://www.scala-lang.org/docu/files/api/scala/Double.html" target="_self">Double</a> - - <div>Returns the spring force.</div> - </td> - </tr> -<tr> - <td class="modifiers" valign="top"> - <code>override def</code> - </td> - <td class="signature"> - <em><a href="../../../sims/dynamics/joints/SpringJoint.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/dynamics/joints/SpringJoint.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/dynamics/joints/SpringJoint.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/dynamics/joints/SpringJoint.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/dynamics/joints/SpringJoint.html#toString%28%29" target="_self">toString</a></em> - : <a href="" target="contentFrame" class="java/lang/String">java.lang.String</a> - - <div>Returns a string representation of the object.</div> - </td> - </tr> -<tr> - <td class="modifiers" valign="top"> - <code> def</code> - </td> - <td class="signature"> - <em><a href="../../../sims/dynamics/joints/SpringJoint.html#v" target="_self">v</a></em> - : <a href="../../../sims/geometry/Vector2D.html" target="_self">Vector2D</a> - - <div>Relative velocity of the connection points.</div> - </td> - </tr> -<tr> - <td class="modifiers" valign="top"> - <code> def</code> - </td> - <td class="signature"> - <em><a href="../../../sims/dynamics/joints/SpringJoint.html#x" target="_self">x</a></em> - : <a href="../../../sims/geometry/Vector2D.html" target="_self">Vector2D</a> - - <div>Relative position of the connection points.</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> - - - <table summary="" cellpadding="3" class="member-detail"> - <tr><td class="title">Additional Constructor Details</td></tr> - </table><div><a name="this%28sims.dynamics.Body%2Csims.geometry.Vector2D%2Csims.dynamics.Body%2Csims.geometry.Vector2D%2CDouble%29"></a><dl> - <dt> - - <code></code> - <code>def</code> - <em>this</em>(<em>node1</em> : <a href="../../../sims/dynamics/Body.html" target="_self">Body</a>, <em>anchor1</em> : <a href="../../../sims/geometry/Vector2D.html" target="_self">Vector2D</a>, <em>node2</em> : <a href="../../../sims/dynamics/Body.html" target="_self">Body</a>, <em>anchor2</em> : <a href="../../../sims/geometry/Vector2D.html" target="_self">Vector2D</a>, <em>springConstant</em> : <a href="http://www.scala-lang.org/docu/files/api/scala/Double.html" target="_self">Double</a>) : <a href="../../../sims/dynamics/joints/SpringJoint.html" target="_self">SpringJoint</a> - </dt> - <dd></dd> - </dl><hr></hr> -<a name="this%28sims.dynamics.Body%2Csims.dynamics.Body%2CDouble%2CDouble%29"></a><dl> - <dt> - - <code></code> - <code>def</code> - <em>this</em>(<em>node1</em> : <a href="../../../sims/dynamics/Body.html" target="_self">Body</a>, <em>node2</em> : <a href="../../../sims/dynamics/Body.html" target="_self">Body</a>, <em>springConstant</em> : <a href="http://www.scala-lang.org/docu/files/api/scala/Double.html" target="_self">Double</a>, <em>initialLength</em> : <a href="http://www.scala-lang.org/docu/files/api/scala/Double.html" target="_self">Double</a>) : <a href="../../../sims/dynamics/joints/SpringJoint.html" target="_self">SpringJoint</a> - </dt> - <dd></dd> - </dl><hr></hr> -<a name="this%28sims.dynamics.Body%2Csims.dynamics.Body%2CDouble%29"></a><dl> - <dt> - - <code></code> - <code>def</code> - <em>this</em>(<em>node1</em> : <a href="../../../sims/dynamics/Body.html" target="_self">Body</a>, <em>node2</em> : <a href="../../../sims/dynamics/Body.html" target="_self">Body</a>, <em>springConstant</em> : <a href="http://www.scala-lang.org/docu/files/api/scala/Double.html" target="_self">Double</a>) : <a href="../../../sims/dynamics/joints/SpringJoint.html" target="_self">SpringJoint</a> - </dt> - <dd></dd> - </dl><hr></hr></div> - -<table summary="" cellpadding="3" class="member-detail"> - <tr><td class="title">Value Details</td></tr> - </table><div><a name="damping"></a><dl> - <dt> - - <code></code> - <code>var</code> - <em>damping</em> : <a href="http://www.scala-lang.org/docu/files/api/scala/Double.html" target="_self">Double</a> - </dt> - <dd></dd> - </dl> - <dl><dd>Damping.</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="connection1"></a><dl> - <dt> - - <code></code> - <code>def</code> - <em>connection1</em> : <a href="../../../sims/geometry/Vector2D.html" target="_self">Vector2D</a> - </dt> - <dd></dd> - </dl> - <dl><dd>Returns the connection point on body one (in world coordinates).</dd></dl> - <dl></dl> - <hr></hr> -<a name="connection2"></a><dl> - <dt> - - <code></code> - <code>def</code> - <em>connection2</em> : <a href="../../../sims/geometry/Vector2D.html" target="_self">Vector2D</a> - </dt> - <dd></dd> - </dl> - <dl><dd>Returns the connection point on body two (in world coordinates).</dd></dl> - <dl></dl> - <hr></hr> -<a name="x"></a><dl> - <dt> - - <code></code> - <code>def</code> - <em>x</em> : <a href="../../../sims/geometry/Vector2D.html" target="_self">Vector2D</a> - </dt> - <dd></dd> - </dl> - <dl><dd>Relative position of the connection points.</dd></dl> - <dl></dl> - <hr></hr> -<a name="v"></a><dl> - <dt> - - <code></code> - <code>def</code> - <em>v</em> : <a href="../../../sims/geometry/Vector2D.html" target="_self">Vector2D</a> - </dt> - <dd></dd> - </dl> - <dl><dd>Relative velocity of the connection points.</dd></dl> - <dl></dl> - <hr></hr> -<a name="force"></a><dl> - <dt> - - <code></code> - <code>def</code> - <em>force</em> : <a href="http://www.scala-lang.org/docu/files/api/scala/Double.html" target="_self">Double</a> - </dt> - <dd></dd> - </dl> - <dl><dd>Returns the spring force.</dd></dl> - <dl></dl> - <hr></hr> -<a name="applyForce%28%29"></a><dl> - <dt> - - <code></code> - <code>def</code> - <em>applyForce</em> : <a href="http://www.scala-lang.org/docu/files/api/scala/Unit.html" target="_self">Unit</a> - </dt> - <dd></dd> - </dl> - <dl><dd>Applies the spring force to the connection points.</dd></dl> - <dl></dl> - <dl> - <dt style="margin:10px 0 0 20px;"> - <b>Overrides</b> - </dt> - <dd> - <a href="../../../sims/dynamics/joints/ForceJoint.html" target="_self">ForceJoint</a>.<a href="../../../sims/dynamics/joints/ForceJoint.html#applyForce%28%29" target="_self">applyForce</a> - </dd> - </dl><hr></hr> -<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 this joint's associated bodies.</dd></dl> - <dl></dl> - <dl> - <dt style="margin:10px 0 0 20px;"> - <b>Overrides</b> - </dt> - <dd> - <a href="../../../sims/dynamics/joints/Joint.html" target="_self">Joint</a>.<a href="../../../sims/dynamics/joints/Joint.html#correctVelocity%28Double%29" target="_self">correctVelocity</a> - </dd> - </dl><hr></hr> -<a name="correctPosition%28Double%29"></a><dl> - <dt> - - <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 this joint's associated bodies.</dd></dl> - <dl></dl> - <dl> - <dt style="margin:10px 0 0 20px;"> - <b>Overrides</b> - </dt> - <dd> - <a href="../../../sims/dynamics/joints/Joint.html" target="_self">Joint</a>.<a href="../../../sims/dynamics/joints/Joint.html#correctPosition%28Double%29" target="_self">correctPosition</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> - <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> - - <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> + </head> + <body class="type"> + + <p id="owner"><a href="../../package.html">sims</a>.<a href="../package.html">dynamics</a>.<a href="package.html">joints</a></p> + <div id="definition"> + <img src="../../../lib/class_big.png" /> + <h1>SpringJoint</h1> + </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> + <h4 class="signature"> + <span class="kind">class</span> + <span class="symbol"> + <span class="name">SpringJoint</span><span class="params">(<span name="node1">node1: <a href="../Body.html" class="extype" name="sims.dynamics.Body">Body</a></span>, <span name="anchor1">anchor1: <a href="../../geometry/Vector2D.html" class="extype" name="sims.geometry.Vector2D">Vector2D</a></span>, <span name="node2">node2: <a href="../Body.html" class="extype" name="sims.dynamics.Body">Body</a></span>, <span name="anchor2">anchor2: <a href="../../geometry/Vector2D.html" class="extype" name="sims.geometry.Vector2D">Vector2D</a></span>, <span name="springConstant">springConstant: <span class="extype" name="scala.Double">Double</span></span>, <span name="initialLength">initialLength: <span class="extype" name="scala.Double">Double</span></span>)</span><span class="result"> extends <a href="Joint.html" class="extype" name="sims.dynamics.joints.Joint">Joint</a> with <a href="ForceJoint.html" class="extype" name="sims.dynamics.joints.ForceJoint">ForceJoint</a> with <span class="extype" name="scala.Product">Product</span></span> + </span> + </h4> + <div class="fullcomment" id="comment"> + <div class="comment cmt"><p>A spring obeying Hooke's law.</p></div> + <dl class="paramcmts block"><dt class="param">node1</dt><dd class="cmt"><p>first associated body</p></dd><dt class="param">anchor1</dt><dd class="cmt"><p>first connection point</p></dd><dt class="param">node2</dt><dd class="cmt"><p>second associated body</p></dd><dt class="param">anchor2</dt><dd class="cmt"><p>second connection point</p></dd><dt class="param">springConstant</dt><dd class="cmt"><p>spring constant</p></dd><dt class="param">initialLength</dt><dd class="cmt"><p>initial length</p></dd></dl> + + + + </div> + + <div id="template"> + + <div id="mbrsel"> + <div id="ancestors"> + <h3>Inherits</h3> + <ol><li class="in" name="scala.Product">Product</li><li class="in" name="scala.Equals">Equals</li><li class="in" name="sims.dynamics.joints.ForceJoint">ForceJoint</li><li class="in" name="sims.dynamics.joints.Joint">Joint</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.dynamics.joints.SpringJoint#anchor1"> + <h4 class="signature"> + <span class="kind">val</span> + <span class="symbol"> + <span class="name">anchor1</span><span class="result">: <a href="../../geometry/Vector2D.html" class="extype" name="sims.geometry.Vector2D">Vector2D</a></span> + </span> + </h4> + + </li><li name="sims.dynamics.joints.SpringJoint#anchor2"> + <h4 class="signature"> + <span class="kind">val</span> + <span class="symbol"> + <span class="name">anchor2</span><span class="result">: <a href="../../geometry/Vector2D.html" class="extype" name="sims.geometry.Vector2D">Vector2D</a></span> + </span> + </h4> + + </li><li name="sims.dynamics.joints.SpringJoint#applyForce"> + <h4 class="signature"> + <span class="kind">def</span> + <span class="symbol"> + <span class="name">applyForce</span><span class="params">()</span><span class="result">: <span class="extype" name="scala.Unit">Unit</span></span> + </span> + </h4> + <p class="shortcomment cmt">Applies the spring force to the connection points</p><div class="fullcomment"> + <div class="comment cmt"><p>Applies the spring force to the connection points.</p></div> + + + + + </div> + </li><li name="sims.dynamics.joints.SpringJoint#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.dynamics.joints.SpringJoint#connection1"> + <h4 class="signature"> + <span class="kind">def</span> + <span class="symbol"> + <span class="name">connection1</span><span class="result">: <a href="../../geometry/Vector2D.html" class="extype" name="sims.geometry.Vector2D">Vector2D</a></span> + </span> + </h4> + <p class="shortcomment cmt">Returns the connection point on body one (in world coordinates)</p><div class="fullcomment"> + <div class="comment cmt"><p>Returns the connection point on body one (in world coordinates).</p></div> + + + + + </div> + </li><li name="sims.dynamics.joints.SpringJoint#connection2"> + <h4 class="signature"> + <span class="kind">def</span> + <span class="symbol"> + <span class="name">connection2</span><span class="result">: <a href="../../geometry/Vector2D.html" class="extype" name="sims.geometry.Vector2D">Vector2D</a></span> + </span> + </h4> + <p class="shortcomment cmt">Returns the connection point on body two (in world coordinates)</p><div class="fullcomment"> + <div class="comment cmt"><p>Returns the connection point on body two (in world coordinates).</p></div> + + + + + </div> + </li><li name="sims.dynamics.joints.SpringJoint#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 this joint's associated bodies</p><div class="fullcomment"> + <div class="comment cmt"><p>Corrects the positions of this joint's associated bodies.@param h a time interval, used for converting forces and impulses</p></div> + + + + + </div> + </li><li name="sims.dynamics.joints.SpringJoint#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 this joint's associated bodies</p><div class="fullcomment"> + <div class="comment cmt"><p>Corrects the velocities of this joint's associated bodies.@param h a time interval, used for converting forces and impulses</p></div> + + + + + </div> + </li><li name="sims.dynamics.joints.SpringJoint#damping"> + <h4 class="signature"> + <span class="kind">var</span> + <span class="symbol"> + <span class="name">damping</span><span class="result">: <span class="extype" name="scala.Double">Double</span></span> + </span> + </h4> + <p class="shortcomment cmt">Damping</p><div class="fullcomment"> + <div class="comment cmt"><p>Damping.</p></div> + + + + + </div> + </li><li name="sims.dynamics.joints.SpringJoint#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.dynamics.joints.SpringJoint#force"> + <h4 class="signature"> + <span class="kind">def</span> + <span class="symbol"> + <span class="name">force</span><span class="result">: <span class="extype" name="scala.Double">Double</span></span> + </span> + </h4> + <p class="shortcomment cmt">Returns the spring force</p><div class="fullcomment"> + <div class="comment cmt"><p>Returns the spring force.</p></div> + + + + + </div> + </li><li name="sims.dynamics.joints.SpringJoint#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.dynamics.joints.SpringJoint#initialLength"> + <h4 class="signature"> + <span class="kind">val</span> + <span class="symbol"> + <span class="name">initialLength</span><span class="result">: <span class="extype" name="scala.Double">Double</span></span> + </span> + </h4> + + </li><li name="sims.dynamics.joints.SpringJoint#node1"> + <h4 class="signature"> + <span class="kind">val</span> + <span class="symbol"> + <span class="name">node1</span><span class="result">: <a href="../Body.html" class="extype" name="sims.dynamics.Body">Body</a></span> + </span> + </h4> + <p class="shortcomment cmt">First body of the joint</p><div class="fullcomment"> + <div class="comment cmt"><p>First body of the joint.</p></div> + + + + + </div> + </li><li name="sims.dynamics.joints.SpringJoint#node2"> + <h4 class="signature"> + <span class="kind">val</span> + <span class="symbol"> + <span class="name">node2</span><span class="result">: <a href="../Body.html" class="extype" name="sims.dynamics.Body">Body</a></span> + </span> + </h4> + <p class="shortcomment cmt">Second body of the joint</p><div class="fullcomment"> + <div class="comment cmt"><p>Second body of the joint.</p></div> + + + + + </div> + </li><li name="sims.dynamics.joints.SpringJoint#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.dynamics.joints.SpringJoint#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.dynamics.joints.SpringJoint#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.dynamics.joints.SpringJoint#springConstant"> + <h4 class="signature"> + <span class="kind">val</span> + <span class="symbol"> + <span class="name">springConstant</span><span class="result">: <span class="extype" name="scala.Double">Double</span></span> + </span> + </h4> + + </li><li name="sims.dynamics.joints.SpringJoint#toString"> + <h4 class="signature"> + <span class="kind">def</span> + <span class="symbol"> + <span class="name">toString</span><span class="params">()</span><span class="result">: <span class="extype" name="java.lang.String">String</span></span> + </span> + </h4> + <p class="shortcomment cmt">Returns a string representation of the object</p><div class="fullcomment"> + <div class="comment cmt"><p>Returns a string representation of the object. +<p> +The default representation is platform dependent. +</p></div> + + + + + </div> + </li><li name="sims.dynamics.joints.SpringJoint#v"> + <h4 class="signature"> + <span class="kind">def</span> + <span class="symbol"> + <span class="name">v</span><span class="result">: <a href="../../geometry/Vector2D.html" class="extype" name="sims.geometry.Vector2D">Vector2D</a></span> + </span> + </h4> + <p class="shortcomment cmt">Relative velocity of the connection points</p><div class="fullcomment"> + <div class="comment cmt"><p>Relative velocity of the connection points.</p></div> + + + + + </div> + </li><li name="sims.dynamics.joints.SpringJoint#x"> + <h4 class="signature"> + <span class="kind">def</span> + <span class="symbol"> + <span class="name">x</span><span class="result">: <a href="../../geometry/Vector2D.html" class="extype" name="sims.geometry.Vector2D">Vector2D</a></span> + </span> + </h4> + <p class="shortcomment cmt">Relative position of the connection points</p><div class="fullcomment"> + <div class="comment cmt"><p>Relative position of the connection points.</p></div> + + + + + </div> + </li></ol> + </div> + + <div class="members" id="constructors"> + <h3>Instance constructors</h3> + <ol><li name="sims.dynamics.joints.SpringJoint#this"> + <h4 class="signature"> + <span class="kind">new</span> + <span class="symbol"> + <span class="name">SpringJoint</span><span class="params">(<span name="node1">node1: <a href="../Body.html" class="extype" name="sims.dynamics.Body">Body</a></span>, <span name="node2">node2: <a href="../Body.html" class="extype" name="sims.dynamics.Body">Body</a></span>, <span name="springConstant">springConstant: <span class="extype" name="scala.Double">Double</span></span>)</span> + </span> + </h4> + + </li><li name="sims.dynamics.joints.SpringJoint#this"> + <h4 class="signature"> + <span class="kind">new</span> + <span class="symbol"> + <span class="name">SpringJoint</span><span class="params">(<span name="node1">node1: <a href="../Body.html" class="extype" name="sims.dynamics.Body">Body</a></span>, <span name="node2">node2: <a href="../Body.html" class="extype" name="sims.dynamics.Body">Body</a></span>, <span name="springConstant">springConstant: <span class="extype" name="scala.Double">Double</span></span>, <span name="initialLength">initialLength: <span class="extype" name="scala.Double">Double</span></span>)</span> + </span> + </h4> + + </li><li name="sims.dynamics.joints.SpringJoint#this"> + <h4 class="signature"> + <span class="kind">new</span> + <span class="symbol"> + <span class="name">SpringJoint</span><span class="params">(<span name="node1">node1: <a href="../Body.html" class="extype" name="sims.dynamics.Body">Body</a></span>, <span name="anchor1">anchor1: <a href="../../geometry/Vector2D.html" class="extype" name="sims.geometry.Vector2D">Vector2D</a></span>, <span name="node2">node2: <a href="../Body.html" class="extype" name="sims.dynamics.Body">Body</a></span>, <span name="anchor2">anchor2: <a href="../../geometry/Vector2D.html" class="extype" name="sims.geometry.Vector2D">Vector2D</a></span>, <span name="springConstant">springConstant: <span class="extype" name="scala.Double">Double</span></span>)</span> + </span> + </h4> + + </li><li name="sims.dynamics.joints.SpringJoint#this"> + <h4 class="signature"> + <span class="kind">new</span> + <span class="symbol"> + <span class="name">SpringJoint</span><span class="params">(<span name="node1">node1: <a href="../Body.html" class="extype" name="sims.dynamics.Body">Body</a></span>, <span name="anchor1">anchor1: <a href="../../geometry/Vector2D.html" class="extype" name="sims.geometry.Vector2D">Vector2D</a></span>, <span name="node2">node2: <a href="../Body.html" class="extype" name="sims.dynamics.Body">Body</a></span>, <span name="anchor2">anchor2: <a href="../../geometry/Vector2D.html" class="extype" name="sims.geometry.Vector2D">Vector2D</a></span>, <span name="springConstant">springConstant: <span class="extype" name="scala.Double">Double</span></span>, <span name="initialLength">initialLength: <span class="extype" name="scala.Double">Double</span></span>)</span> + </span> + </h4> + + </li><li name="sims.dynamics.joints.Joint#this"> + <h4 class="signature"> + <span class="kind">new</span> + <span class="symbol"> + <span class="name">SpringJoint</span><span class="params">()</span> + </span> + </h4> + + </li></ol> + </div> + + </div> + + </body> </html>
\ No newline at end of file diff --git a/doc/sims/dynamics/joints/package.html b/doc/sims/dynamics/joints/package.html new file mode 100644 index 0000000..bd320c3 --- /dev/null +++ b/doc/sims/dynamics/joints/package.html @@ -0,0 +1,105 @@ +<?xml version='1.0' encoding='UTF-8'?> +<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.1//EN" "http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd"> +<html> + <head> + <title>Scaladoc for sims.dynamics.joints</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">dynamics</a></p> + + <div id="definition"> + <img src="../../../lib/package_big.png" /> + <h1>joints</h1> + </div> + + <h4 class="signature"> + <span class="kind">package</span> + <span class="symbol"> + <span class="name">joints</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.dynamics.joints.DistanceJoint"> + <h4 class="signature"><a href="DistanceJoint.html"> + <span class="kind">class</span> + <span class="symbol"> + <span class="name">DistanceJoint</span><span class="params">(<span name="node1">node1: Body</span>, <span name="anchor1">anchor1: Vector2D</span>, <span name="node2">node2: Body</span>, <span name="anchor2">anchor2: Vector2D</span>)</span><span class="result"> extends Joint with Product</span> + </span> + </a></h4> + <p class="comment cmt">DistanceJoints keep their connection points at a constant distance</p> + </li><li name="sims.dynamics.joints.ForceJoint"> + <h4 class="signature"><a href="ForceJoint.html"> + <span class="kind">trait</span> + <span class="symbol"> + <span class="name">ForceJoint</span><span class="result"> extends AnyRef</span> + </span> + </a></h4> + <p class="comment cmt">A joint which can apply a force to its anchor bodies, thus adding or removing energy to the system</p> + </li><li name="sims.dynamics.joints.Joint"> + <h4 class="signature"><a href="Joint.html"> + <span class="kind">class</span> + <span class="symbol"> + <span class="name">Joint</span><span class="result"> extends Constraint</span> + </span> + </a></h4> + <p class="comment cmt">Joints constrain the movement of two bodies</p> + </li><li name="sims.dynamics.joints.RevoluteJoint"> + <h4 class="signature"><a href="RevoluteJoint.html"> + <span class="kind">class</span> + <span class="symbol"> + <span class="name">RevoluteJoint</span><span class="params">(<span name="node1">node1: Body</span>, <span name="node2">node2: Body</span>, <span name="anchor">anchor: Vector2D</span>)</span><span class="result"> extends Joint with Product</span> + </span> + </a></h4> + <p class="comment cmt">A revolute joint that connects two bodies at a singe point</p> + </li><li name="sims.dynamics.joints.SpringJoint"> + <h4 class="signature"><a href="SpringJoint.html"> + <span class="kind">class</span> + <span class="symbol"> + <span class="name">SpringJoint</span><span class="params">(<span name="node1">node1: Body</span>, <span name="anchor1">anchor1: Vector2D</span>, <span name="node2">node2: Body</span>, <span name="anchor2">anchor2: Vector2D</span>, <span name="springConstant">springConstant: Double</span>, <span name="initialLength">initialLength: Double</span>)</span><span class="result"> extends Joint with ForceJoint with Product</span> + </span> + </a></h4> + <p class="comment cmt">A spring obeying Hooke's law</p> + </li></ol> + </div> + + <div class="members" id="values"> + <h3>Value Members</h3> + <ol><li name="sims.dynamics.joints.test"> + <h4 class="signature"><a href="test/package.html"> + <span class="kind">package</span> + <span class="symbol"> + <span class="name">test</span> + </span> + </a></h4> + + </li></ol> + </div> + + + + </div> + + </body> + </html>
\ No newline at end of file diff --git a/doc/sims/dynamics/joints/test$content.html b/doc/sims/dynamics/joints/test$content.html deleted file mode 100644 index 6509725..0000000 --- a/doc/sims/dynamics/joints/test$content.html +++ /dev/null @@ -1,45 +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>All classes and objects in sims.dynamics.joints.test</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()"><div class="page-title"><div>Simple Mechanics Simulator (SiMS) API</div></div><p><div>This document is the API specification for SiMS</div></p><table summary="" cellpadding="3" class="member"> - <tr><td class="title" colspan="2">Class Summary</td></tr> - <tr> - <td class="modifiers" valign="top"> - <code>case class</code> - </td> - <td class="signature"> - <em><a href="../../../sims/dynamics/joints/test/PrismaticJoint.html" target="_self">PrismaticJoint</a></em> - (<code>val </code><em>node1</em> : <a href="../../../sims/dynamics/Body.html" target="_self">Body</a>, <code>val </code><em>anchor1</em> : <a href="../../../sims/geometry/Vector2D.html" target="_self">Vector2D</a>, <code>val </code><em>node2</em> : <a href="../../../sims/dynamics/Body.html" target="_self">Body</a>, <code>val </code><em>anchor2</em> : <a href="../../../sims/geometry/Vector2D.html" target="_self">Vector2D</a>)<code> extends </code><a href="../../../sims/dynamics/joints/Joint.html" target="_self">Joint</a><code> with </code><a href="" target="contentFrame" class="scala/Product">scala.Product</a> - - - </td> - </tr> -<tr> - <td class="modifiers" valign="top"> - <code> class</code> - </td> - <td class="signature"> - <em><a href="../../../sims/dynamics/joints/test/UnitCircleJoint.html" target="_self">UnitCircleJoint</a></em> - (<em>body</em> : <a href="../../../sims/dynamics/Body.html" target="_self">Body</a>, <em>anchor</em> : <a href="../../../sims/geometry/Vector2D.html" target="_self">Vector2D</a>)<code> extends </code><a href="../../../sims/dynamics/joints/Joint.html" target="_self">Joint</a> - - - </td> - </tr> - </table> -<table summary="" cellpadding="3" class="member"> - <tr><td class="title" colspan="2">Object Summary</td></tr> - <tr> - <td class="modifiers" valign="top"> - <code> object</code> - </td> - <td class="signature"> - <em><a href="../../../sims/dynamics/joints/test/PrismaticJoint$object.html" target="_self">PrismaticJoint</a></em> - <code> extends </code>(<a href="../../../sims/dynamics/Body.html" target="_self">Body</a>, <a href="../../../sims/geometry/Vector2D.html" target="_self">Vector2D</a>, <a href="../../../sims/dynamics/Body.html" target="_self">Body</a>, <a href="../../../sims/geometry/Vector2D.html" target="_self">Vector2D</a>) => <a href="../../../sims/dynamics/joints/test/PrismaticJoint.html" target="_self">PrismaticJoint</a> - - - </td> - </tr> - </table></body> - </html>
\ No newline at end of file diff --git a/doc/sims/dynamics/joints/test$package.html b/doc/sims/dynamics/joints/test$package.html deleted file mode 100644 index b34f98d..0000000 --- a/doc/sims/dynamics/joints/test$package.html +++ /dev/null @@ -1,17 +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>List of classes and objects in package sims.dynamics.joints.test</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"> - <a href="../../../sims/dynamics/joints/test$content.html" target="contentFrame">sims.dynamics.joints.test</a> - </td></tr> - </table><div><div class="kinds" id="Classes">Classes</div><ul class="list"> - <li id="Classes_P"><a href="../../../sims/dynamics/joints/test/PrismaticJoint.html" target="contentFrame">PrismaticJoint</a></li> -<li id="Classes_U"><a href="../../../sims/dynamics/joints/test/UnitCircleJoint.html" target="contentFrame">UnitCircleJoint</a></li> - </ul> -<div class="kinds" id="Objects">Objects</div><ul class="list"> - <li id="Objects_P"><a href="../../../sims/dynamics/joints/test/PrismaticJoint$object.html" target="contentFrame">PrismaticJoint</a></li> - </ul></div></body> - </html>
\ No newline at end of file diff --git a/doc/sims/dynamics/joints/test/PrismaticJoint$object.html b/doc/sims/dynamics/joints/test/PrismaticJoint$object.html deleted file mode 100644 index e460df7..0000000 --- a/doc/sims/dynamics/joints/test/PrismaticJoint$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 PrismaticJoint in sims.dynamics.joints.test</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/dynamics/joints/test$package.html" target="_self">sims.dynamics.joints.test</a> - <br></br> - <span class="entity">object PrismaticJoint</span> - </div><hr></hr> - <div class="source"> - [source: <a href="" class="sims/dynamics/joints/test/PrismaticJoint"><code>sims/dynamics/joints/test/PrismaticJoint.scala</code></a>] - </div><hr></hr> - <a name="PrismaticJoint"></a><dl> - <dt> - - <code></code> - <code>object</code> - <em>PrismaticJoint</em> - </dt> - <dd><code> extends </code>(<a href="../../../../sims/dynamics/Body.html" target="_self">Body</a>, <a href="../../../../sims/geometry/Vector2D.html" target="_self">Vector2D</a>, <a href="../../../../sims/dynamics/Body.html" target="_self">Body</a>, <a href="../../../../sims/geometry/Vector2D.html" target="_self">Vector2D</a>) => <a href="../../../../sims/dynamics/joints/test/PrismaticJoint.html" target="_self">PrismaticJoint</a></dd> - </dl> - - - -<table summary="" cellpadding="3" class="inherited"> - <tr><td class="title" colspan="2"> - Methods inherited from <a href="" target="contentFrame" class="scala/Function4">scala.Function4</a> - </td></tr> - <tr><td class="signature" colspan="2"> - <a href="#toString" target="contentFrame" class="scala/Function4">scala.Function4.toString</a>, <a href="#curry" target="contentFrame" class="scala/Function4">scala.Function4.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/dynamics/joints/test/PrismaticJoint.html b/doc/sims/dynamics/joints/test/PrismaticJoint.html index a5c5a94..2883427 100644 --- a/doc/sims/dynamics/joints/test/PrismaticJoint.html +++ b/doc/sims/dynamics/joints/test/PrismaticJoint.html @@ -1,502 +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 PrismaticJoint in sims.dynamics.joints.test</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.dynamics.joints.test.PrismaticJoint</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/dynamics/joints/test$package.html" target="_self">sims.dynamics.joints.test</a> - <br></br> - <span class="entity">class PrismaticJoint</span> - </div><hr></hr> - <div class="source"> - [source: <a href="" class="sims/dynamics/joints/test/PrismaticJoint"><code>sims/dynamics/joints/test/PrismaticJoint.scala</code></a>] - </div><hr></hr> - <a name="PrismaticJoint"></a><dl> - <dt> - - <code>case</code> - <code>class</code> - <em>PrismaticJoint</em>(<code>val </code><em>node1</em> : <a href="../../../../sims/dynamics/Body.html" target="_self">Body</a>, <code>val </code><em>anchor1</em> : <a href="../../../../sims/geometry/Vector2D.html" target="_self">Vector2D</a>, <code>val </code><em>node2</em> : <a href="../../../../sims/dynamics/Body.html" target="_self">Body</a>, <code>val </code><em>anchor2</em> : <a href="../../../../sims/geometry/Vector2D.html" target="_self">Vector2D</a>) - </dt> - <dd><code> extends </code><a href="../../../../sims/dynamics/joints/Joint.html" target="_self">Joint</a><code> with </code><a href="" target="contentFrame" class="scala/Product">scala.Product</a></dd> - </dl> - <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/dynamics/joints/test/PrismaticJoint.html#this%28sims.dynamics.Body%2Csims.dynamics.Body%29" target="_self">this</a></em> - (<em>node1</em> : <a href="../../../../sims/dynamics/Body.html" target="_self">Body</a>, <em>node2</em> : <a href="../../../../sims/dynamics/Body.html" target="_self">Body</a>) : <a href="../../../../sims/dynamics/joints/test/PrismaticJoint.html" target="_self">PrismaticJoint</a> - - - </td> - </tr> - </table> - -<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/dynamics/joints/test/PrismaticJoint.html#angle" target="_self">angle</a></em> - : <a href="http://www.scala-lang.org/docu/files/api/scala/Double.html" target="_self">Double</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> def</code> - </td> - <td class="signature"> - <em><a href="../../../../sims/dynamics/joints/test/PrismaticJoint.html#connection1" target="_self">connection1</a></em> - : <a href="../../../../sims/geometry/Vector2D.html" target="_self">Vector2D</a> - - - </td> - </tr> -<tr> - <td class="modifiers" valign="top"> - <code> def</code> - </td> - <td class="signature"> - <em><a href="../../../../sims/dynamics/joints/test/PrismaticJoint.html#connection2" target="_self">connection2</a></em> - : <a href="../../../../sims/geometry/Vector2D.html" target="_self">Vector2D</a> - - - </td> - </tr> -<tr> - <td class="modifiers" valign="top"> - <code> def</code> - </td> - <td class="signature"> - <em><a href="../../../../sims/dynamics/joints/test/PrismaticJoint.html#correctAngular%28Double%29" target="_self">correctAngular</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> - - - </td> - </tr> -<tr> - <td class="modifiers" valign="top"> - <code> def</code> - </td> - <td class="signature"> - <em><a href="../../../../sims/dynamics/joints/test/PrismaticJoint.html#correctLinear%28Double%29" target="_self">correctLinear</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> - - - </td> - </tr> -<tr> - <td class="modifiers" valign="top"> - <code> def</code> - </td> - <td class="signature"> - <em><a href="../../../../sims/dynamics/joints/test/PrismaticJoint.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 this joint's associated bodies.</div> - </td> - </tr> -<tr> - <td class="modifiers" valign="top"> - <code> def</code> - </td> - <td class="signature"> - <em><a href="../../../../sims/dynamics/joints/test/PrismaticJoint.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 this joint's associated bodies.</div> - </td> - </tr> -<tr> - <td class="modifiers" valign="top"> - <code>override def</code> - </td> - <td class="signature"> - <em><a href="../../../../sims/dynamics/joints/test/PrismaticJoint.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/dynamics/joints/test/PrismaticJoint.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/dynamics/joints/test/PrismaticJoint.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/dynamics/joints/test/PrismaticJoint.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/dynamics/joints/test/PrismaticJoint.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/dynamics/joints/test/PrismaticJoint.html#toString%28%29" target="_self">toString</a></em> - : <a href="" target="contentFrame" class="java/lang/String">java.lang.String</a> - - <div>Returns a string representation of the object.</div> - </td> - </tr> -<tr> - <td class="modifiers" valign="top"> - <code> def</code> - </td> - <td class="signature"> - <em><a href="../../../../sims/dynamics/joints/test/PrismaticJoint.html#v" target="_self">v</a></em> - : <a href="../../../../sims/geometry/Vector2D.html" target="_self">Vector2D</a> - - - </td> - </tr> -<tr> - <td class="modifiers" valign="top"> - <code> def</code> - </td> - <td class="signature"> - <em><a href="../../../../sims/dynamics/joints/test/PrismaticJoint.html#x" target="_self">x</a></em> - : <a href="../../../../sims/geometry/Vector2D.html" target="_self">Vector2D</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> - - - <table summary="" cellpadding="3" class="member-detail"> - <tr><td class="title">Additional Constructor Details</td></tr> - </table><div><a name="this%28sims.dynamics.Body%2Csims.dynamics.Body%29"></a><dl> - <dt> - - <code></code> - <code>def</code> - <em>this</em>(<em>node1</em> : <a href="../../../../sims/dynamics/Body.html" target="_self">Body</a>, <em>node2</em> : <a href="../../../../sims/dynamics/Body.html" target="_self">Body</a>) : <a href="../../../../sims/dynamics/joints/test/PrismaticJoint.html" target="_self">PrismaticJoint</a> - </dt> - <dd></dd> - </dl><hr></hr></div> - -<table summary="" cellpadding="3" class="member-detail"> - <tr><td class="title">Value Details</td></tr> - </table><div><a name="angle"></a><dl> - <dt> - - <code></code> - <code>val</code> - <em>angle</em> : <a href="http://www.scala-lang.org/docu/files/api/scala/Double.html" target="_self">Double</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="connection1"></a><dl> - <dt> - - <code></code> - <code>def</code> - <em>connection1</em> : <a href="../../../../sims/geometry/Vector2D.html" target="_self">Vector2D</a> - </dt> - <dd></dd> - </dl><hr></hr> -<a name="connection2"></a><dl> - <dt> - - <code></code> - <code>def</code> - <em>connection2</em> : <a href="../../../../sims/geometry/Vector2D.html" target="_self">Vector2D</a> - </dt> - <dd></dd> - </dl><hr></hr> -<a name="x"></a><dl> - <dt> - - <code></code> - <code>def</code> - <em>x</em> : <a href="../../../../sims/geometry/Vector2D.html" target="_self">Vector2D</a> - </dt> - <dd></dd> - </dl><hr></hr> -<a name="v"></a><dl> - <dt> - - <code></code> - <code>def</code> - <em>v</em> : <a href="../../../../sims/geometry/Vector2D.html" target="_self">Vector2D</a> - </dt> - <dd></dd> - </dl><hr></hr> -<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 this joint's associated bodies.</dd></dl> - <dl></dl> - <dl> - <dt style="margin:10px 0 0 20px;"> - <b>Overrides</b> - </dt> - <dd> - <a href="../../../../sims/dynamics/joints/Joint.html" target="_self">Joint</a>.<a href="../../../../sims/dynamics/joints/Joint.html#correctVelocity%28Double%29" target="_self">correctVelocity</a> - </dd> - </dl><hr></hr> -<a name="correctLinear%28Double%29"></a><dl> - <dt> - - <code></code> - <code>def</code> - <em>correctLinear</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><hr></hr> -<a name="correctAngular%28Double%29"></a><dl> - <dt> - - <code></code> - <code>def</code> - <em>correctAngular</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><hr></hr> -<a name="correctPosition%28Double%29"></a><dl> - <dt> - - <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 this joint's associated bodies.</dd></dl> - <dl></dl> - <dl> - <dt style="margin:10px 0 0 20px;"> - <b>Overrides</b> - </dt> - <dd> - <a href="../../../../sims/dynamics/joints/Joint.html" target="_self">Joint</a>.<a href="../../../../sims/dynamics/joints/Joint.html#correctPosition%28Double%29" target="_self">correctPosition</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> - <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> - - <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> + <body class="type"> + + <p id="owner"><a href="../../../package.html">sims</a>.<a href="../../package.html">dynamics</a>.<a href="../package.html">joints</a>.<a href="package.html">test</a></p> + <div id="definition"> + <img src="../../../../lib/class_big.png" /> + <h1>PrismaticJoint</h1> + </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> + <h4 class="signature"> + <span class="kind">class</span> + <span class="symbol"> + <span class="name">PrismaticJoint</span><span class="params">(<span name="node1">node1: <a href="../../Body.html" class="extype" name="sims.dynamics.Body">Body</a></span>, <span name="anchor1">anchor1: <a href="../../../geometry/Vector2D.html" class="extype" name="sims.geometry.Vector2D">Vector2D</a></span>, <span name="node2">node2: <a href="../../Body.html" class="extype" name="sims.dynamics.Body">Body</a></span>, <span name="anchor2">anchor2: <a href="../../../geometry/Vector2D.html" class="extype" name="sims.geometry.Vector2D">Vector2D</a></span>)</span><span class="result"> extends <a href="../Joint.html" class="extype" name="sims.dynamics.joints.Joint">Joint</a> with <span class="extype" name="scala.Product">Product</span></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.Product">Product</li><li class="in" name="scala.Equals">Equals</li><li class="in" name="sims.dynamics.joints.Joint">Joint</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.dynamics.joints.test.PrismaticJoint#anchor1"> + <h4 class="signature"> + <span class="kind">val</span> + <span class="symbol"> + <span class="name">anchor1</span><span class="result">: <a href="../../../geometry/Vector2D.html" class="extype" name="sims.geometry.Vector2D">Vector2D</a></span> + </span> + </h4> + + </li><li name="sims.dynamics.joints.test.PrismaticJoint#anchor2"> + <h4 class="signature"> + <span class="kind">val</span> + <span class="symbol"> + <span class="name">anchor2</span><span class="result">: <a href="../../../geometry/Vector2D.html" class="extype" name="sims.geometry.Vector2D">Vector2D</a></span> + </span> + </h4> + + </li><li name="sims.dynamics.joints.test.PrismaticJoint#angle"> + <h4 class="signature"> + <span class="kind">val</span> + <span class="symbol"> + <span class="name">angle</span><span class="result">: <span class="extype" name="scala.Double">Double</span></span> + </span> + </h4> + + </li><li name="sims.dynamics.joints.test.PrismaticJoint#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.dynamics.joints.test.PrismaticJoint#connection1"> + <h4 class="signature"> + <span class="kind">def</span> + <span class="symbol"> + <span class="name">connection1</span><span class="result">: <a href="../../../geometry/Vector2D.html" class="extype" name="sims.geometry.Vector2D">Vector2D</a></span> + </span> + </h4> + + </li><li name="sims.dynamics.joints.test.PrismaticJoint#connection2"> + <h4 class="signature"> + <span class="kind">def</span> + <span class="symbol"> + <span class="name">connection2</span><span class="result">: <a href="../../../geometry/Vector2D.html" class="extype" name="sims.geometry.Vector2D">Vector2D</a></span> + </span> + </h4> + + </li><li name="sims.dynamics.joints.test.PrismaticJoint#correctAngular"> + <h4 class="signature"> + <span class="kind">def</span> + <span class="symbol"> + <span class="name">correctAngular</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> + + </li><li name="sims.dynamics.joints.test.PrismaticJoint#correctLinear"> + <h4 class="signature"> + <span class="kind">def</span> + <span class="symbol"> + <span class="name">correctLinear</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> + + </li><li name="sims.dynamics.joints.test.PrismaticJoint#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 this joint's associated bodies</p><div class="fullcomment"> + <div class="comment cmt"><p>Corrects the positions of this joint's associated bodies.@param h a time interval, used for converting forces and impulses</p></div> + + + + + </div> + </li><li name="sims.dynamics.joints.test.PrismaticJoint#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 this joint's associated bodies</p><div class="fullcomment"> + <div class="comment cmt"><p>Corrects the velocities of this joint's associated bodies.@param h a time interval, used for converting forces and impulses</p></div> + + + + + </div> + </li><li name="sims.dynamics.joints.test.PrismaticJoint#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.dynamics.joints.test.PrismaticJoint#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.dynamics.joints.test.PrismaticJoint#node1"> + <h4 class="signature"> + <span class="kind">val</span> + <span class="symbol"> + <span class="name">node1</span><span class="result">: <a href="../../Body.html" class="extype" name="sims.dynamics.Body">Body</a></span> + </span> + </h4> + <p class="shortcomment cmt">First body of the joint</p><div class="fullcomment"> + <div class="comment cmt"><p>First body of the joint.</p></div> + + + + + </div> + </li><li name="sims.dynamics.joints.test.PrismaticJoint#node2"> + <h4 class="signature"> + <span class="kind">val</span> + <span class="symbol"> + <span class="name">node2</span><span class="result">: <a href="../../Body.html" class="extype" name="sims.dynamics.Body">Body</a></span> + </span> + </h4> + <p class="shortcomment cmt">Second body of the joint</p><div class="fullcomment"> + <div class="comment cmt"><p>Second body of the joint.</p></div> + + + + + </div> + </li><li name="sims.dynamics.joints.test.PrismaticJoint#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.dynamics.joints.test.PrismaticJoint#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.dynamics.joints.test.PrismaticJoint#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.dynamics.joints.test.PrismaticJoint#toString"> + <h4 class="signature"> + <span class="kind">def</span> + <span class="symbol"> + <span class="name">toString</span><span class="params">()</span><span class="result">: <span class="extype" name="java.lang.String">String</span></span> + </span> + </h4> + <p class="shortcomment cmt">Returns a string representation of the object</p><div class="fullcomment"> + <div class="comment cmt"><p>Returns a string representation of the object. +<p> +The default representation is platform dependent. +</p></div> + + + + + </div> + </li><li name="sims.dynamics.joints.test.PrismaticJoint#v"> + <h4 class="signature"> + <span class="kind">def</span> + <span class="symbol"> + <span class="name">v</span><span class="result">: <a href="../../../geometry/Vector2D.html" class="extype" name="sims.geometry.Vector2D">Vector2D</a></span> + </span> + </h4> + + </li><li name="sims.dynamics.joints.test.PrismaticJoint#x"> + <h4 class="signature"> + <span class="kind">def</span> + <span class="symbol"> + <span class="name">x</span><span class="result">: <a href="../../../geometry/Vector2D.html" class="extype" name="sims.geometry.Vector2D">Vector2D</a></span> + </span> + </h4> + + </li></ol> + </div> + + <div class="members" id="constructors"> + <h3>Instance constructors</h3> + <ol><li name="sims.dynamics.joints.test.PrismaticJoint#this"> + <h4 class="signature"> + <span class="kind">new</span> + <span class="symbol"> + <span class="name">PrismaticJoint</span><span class="params">(<span name="node1">node1: <a href="../../Body.html" class="extype" name="sims.dynamics.Body">Body</a></span>, <span name="node2">node2: <a href="../../Body.html" class="extype" name="sims.dynamics.Body">Body</a></span>)</span> + </span> + </h4> + + </li><li name="sims.dynamics.joints.test.PrismaticJoint#this"> + <h4 class="signature"> + <span class="kind">new</span> + <span class="symbol"> + <span class="name">PrismaticJoint</span><span class="params">(<span name="node1">node1: <a href="../../Body.html" class="extype" name="sims.dynamics.Body">Body</a></span>, <span name="anchor1">anchor1: <a href="../../../geometry/Vector2D.html" class="extype" name="sims.geometry.Vector2D">Vector2D</a></span>, <span name="node2">node2: <a href="../../Body.html" class="extype" name="sims.dynamics.Body">Body</a></span>, <span name="anchor2">anchor2: <a href="../../../geometry/Vector2D.html" class="extype" name="sims.geometry.Vector2D">Vector2D</a></span>)</span> + </span> + </h4> + + </li><li name="sims.dynamics.joints.Joint#this"> + <h4 class="signature"> + <span class="kind">new</span> + <span class="symbol"> + <span class="name">PrismaticJoint</span><span class="params">()</span> + </span> + </h4> + + </li></ol> + </div> + + </div> + + </body> </html>
\ No newline at end of file diff --git a/doc/sims/dynamics/joints/test/UnitCircleJoint.html b/doc/sims/dynamics/joints/test/UnitCircleJoint.html index b580f30..d8291c4 100644 --- a/doc/sims/dynamics/joints/test/UnitCircleJoint.html +++ b/doc/sims/dynamics/joints/test/UnitCircleJoint.html @@ -1,261 +1,247 @@ -<!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 UnitCircleJoint in sims.dynamics.joints.test</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.dynamics.joints.test.UnitCircleJoint</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/dynamics/joints/test$package.html" target="_self">sims.dynamics.joints.test</a> - <br></br> - <span class="entity">class UnitCircleJoint</span> - </div><hr></hr> - <div class="source"> - [source: <a href="" class="sims/dynamics/joints/test/UnitCircleJoint"><code>sims/dynamics/joints/test/UnitCircleJoint.scala</code></a>] - </div><hr></hr> - <a name="UnitCircleJoint"></a><dl> - <dt> - - <code></code> - <code>class</code> - <em>UnitCircleJoint</em>(<em>body</em> : <a href="../../../../sims/dynamics/Body.html" target="_self">Body</a>, <em>anchor</em> : <a href="../../../../sims/geometry/Vector2D.html" target="_self">Vector2D</a>) - </dt> - <dd><code> extends </code><a href="../../../../sims/dynamics/joints/Joint.html" target="_self">Joint</a></dd> - </dl> + <body class="type"> + <p id="owner"><a href="../../../package.html">sims</a>.<a href="../../package.html">dynamics</a>.<a href="../package.html">joints</a>.<a href="package.html">test</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/dynamics/joints/test/UnitCircleJoint.html#node1" target="_self">node1</a></em> - : <a href="../../../../sims/dynamics/Body.html" target="_self">Body</a> - - <div>First body of the joint.</div> - </td> - </tr> -<tr> - <td class="modifiers" valign="top"> - <code> val</code> - </td> - <td class="signature"> - <em><a href="../../../../sims/dynamics/joints/test/UnitCircleJoint.html#node2" target="_self">node2</a></em> - : <a href="../../../../sims/dynamics/Body.html" target="_self">Body</a> - - <div>Second body of the joint.</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/dynamics/joints/test/UnitCircleJoint.html#connection" target="_self">connection</a></em> - : <a href="../../../../sims/geometry/Vector2D.html" target="_self">Vector2D</a> - - - </td> - </tr> -<tr> - <td class="modifiers" valign="top"> - <code> def</code> - </td> - <td class="signature"> - <em><a href="../../../../sims/dynamics/joints/test/UnitCircleJoint.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 this joint's associated bodies.</div> - </td> - </tr> -<tr> - <td class="modifiers" valign="top"> - <code> def</code> - </td> - <td class="signature"> - <em><a href="../../../../sims/dynamics/joints/test/UnitCircleJoint.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 this joint's associated bodies.</div> - </td> - </tr> -<tr> - <td class="modifiers" valign="top"> - <code> def</code> - </td> - <td class="signature"> - <em><a href="../../../../sims/dynamics/joints/test/UnitCircleJoint.html#v" target="_self">v</a></em> - : <a href="../../../../sims/geometry/Vector2D.html" target="_self">Vector2D</a> - - - </td> - </tr> -<tr> - <td class="modifiers" valign="top"> - <code> def</code> - </td> - <td class="signature"> - <em><a href="../../../../sims/dynamics/joints/test/UnitCircleJoint.html#x" target="_self">x</a></em> - : <a href="../../../../sims/geometry/Vector2D.html" target="_self">Vector2D</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#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>UnitCircleJoint</h1> + </div> + <h4 class="signature"> + <span class="kind">class</span> + <span class="symbol"> + <span class="name">UnitCircleJoint</span><span class="result"> extends <a href="../Joint.html" class="extype" name="sims.dynamics.joints.Joint">Joint</a></span> + </span> + </h4> + <div class="fullcomment" id="comment"> - -<table summary="" cellpadding="3" class="member-detail"> - <tr><td class="title">Value Details</td></tr> - </table><div><a name="node1"></a><dl> - <dt> - - <code></code> - <code>val</code> - <em>node1</em> : <a href="../../../../sims/dynamics/Body.html" target="_self">Body</a> - </dt> - <dd></dd> - </dl> - <dl><dd>First body of the joint.</dd></dl> - <dl></dl> - <dl> - <dt style="margin:10px 0 0 20px;"> - <b>Overrides</b> - </dt> - <dd> - <a href="../../../../sims/dynamics/joints/Joint.html" target="_self">Joint</a>.<a href="../../../../sims/dynamics/joints/Joint.html#node1" target="_self">node1</a> - </dd> - </dl><hr></hr> -<a name="node2"></a><dl> - <dt> - - <code></code> - <code>val</code> - <em>node2</em> : <a href="../../../../sims/dynamics/Body.html" target="_self">Body</a> - </dt> - <dd></dd> - </dl> - <dl><dd>Second body of the joint.</dd></dl> - <dl></dl> - <dl> - <dt style="margin:10px 0 0 20px;"> - <b>Overrides</b> - </dt> - <dd> - <a href="../../../../sims/dynamics/joints/Joint.html" target="_self">Joint</a>.<a href="../../../../sims/dynamics/joints/Joint.html#node2" target="_self">node2</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="connection"></a><dl> - <dt> - - <code></code> - <code>def</code> - <em>connection</em> : <a href="../../../../sims/geometry/Vector2D.html" target="_self">Vector2D</a> - </dt> - <dd></dd> - </dl><hr></hr> -<a name="x"></a><dl> - <dt> - - <code></code> - <code>def</code> - <em>x</em> : <a href="../../../../sims/geometry/Vector2D.html" target="_self">Vector2D</a> - </dt> - <dd></dd> - </dl><hr></hr> -<a name="v"></a><dl> - <dt> - - <code></code> - <code>def</code> - <em>v</em> : <a href="../../../../sims/geometry/Vector2D.html" target="_self">Vector2D</a> - </dt> - <dd></dd> - </dl><hr></hr> -<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 this joint's associated bodies.</dd></dl> - <dl></dl> - <dl> - <dt style="margin:10px 0 0 20px;"> - <b>Overrides</b> - </dt> - <dd> - <a href="../../../../sims/dynamics/joints/Joint.html" target="_self">Joint</a>.<a href="../../../../sims/dynamics/joints/Joint.html#correctVelocity%28Double%29" target="_self">correctVelocity</a> - </dd> - </dl><hr></hr> -<a name="correctPosition%28Double%29"></a><dl> - <dt> + + + + + </div> + + <div id="template"> + + <div id="mbrsel"> + <div id="ancestors"> + <h3>Inherits</h3> + <ol><li class="in" name="sims.dynamics.joints.Joint">Joint</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.dynamics.joints.test.UnitCircleJoint#connection"> + <h4 class="signature"> + <span class="kind">def</span> + <span class="symbol"> + <span class="name">connection</span><span class="result">: <a href="../../../geometry/Vector2D.html" class="extype" name="sims.geometry.Vector2D">Vector2D</a></span> + </span> + </h4> + + </li><li name="sims.dynamics.joints.test.UnitCircleJoint#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 this joint's associated bodies</p><div class="fullcomment"> + <div class="comment cmt"><p>Corrects the positions of this joint's associated bodies.@param h a time interval, used for converting forces and impulses</p></div> + + + + + </div> + </li><li name="sims.dynamics.joints.test.UnitCircleJoint#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 this joint's associated bodies</p><div class="fullcomment"> + <div class="comment cmt"><p>Corrects the velocities of this joint's associated bodies.@param h a time interval, used for converting forces and impulses</p></div> + + + + + </div> + </li><li name="scala.AnyRef#equals"> + <h4 class="signature"> + <span class="kind">def</span> + <span class="symbol"> + <span class="name">equals</span><span class="params">(<span name="arg0">arg0: <span class="extype" name="scala.Any">Any</span></span>)</span><span class="result">: <span class="extype" name="scala.Boolean">Boolean</span></span> + </span> + </h4> + <p class="shortcomment cmt">This method is used to compare the receiver object (<code>this</code>) +with the argument object (<code>arg0</code>) for equivalence</p><div class="fullcomment"> + <div class="comment cmt"><p>This method is used to compare the receiver object (<code>this</code>) +with the argument object (<code>arg0</code>) for equivalence.</p><p><p> +The default implementations of this method is an <a +href="http://en.wikipedia.org/wiki/Equivalence_relation">equivalence +relation</a>: + <ul> + <li>It is reflexive: for any instance <code>x</code> of type <code>Any</code>, + <code>x.equals(x)</code> should return <code>true</code>.</li> + <li>It is symmetric: for any instances <code>x</code> and <code>y</code> of type + <code>Any</code>, <code>x.equals(y)</code> should return <code>true</code> if and only + if <code>y.equals(x)</code> returns <code>true</code>.</li> + <li>It is transitive: for any instances + <code>x</code>, <code>y</code>, and <code>z</code> of type <code>AnyRef</code> + if <code>x.equals(y)</code> returns <code>true</code> and + <code>y.equals(z)</code> returns + <code>true</code>, then <code>x.equals(z)</code> should return <code>true</code>.</li> +</ul> +</p></p><p><p> +If you override this method, you should verify that +your implementation remains an equivalence relation. +Additionally, when overriding this method it is often necessary to +override <code>hashCode</code> to ensure that objects that are +"equal" (<code>o1.equals(o2)</code> returns <code>true</code>) +hash to the same <a href="Int.html"><code>Int</code></a> +(<code>o1.hashCode.equals(o2.hashCode)</code>). +</p></div> + <dl class="paramcmts block"><dt class="param">arg0</dt><dd class="cmt"><p>the object to compare against this object for equality.</p></dd><dt>returns</dt><dd class="cmt"><p><code>true</code> if the receiver object is equivalent to the argument; <code>false</code> otherwise. +</p></p></dd></dl> + + <div class="block"> + definition classes: AnyRef ⇐ Any + </div> + + </div> + </li><li name="scala.AnyRef#hashCode"> + <h4 class="signature"> + <span class="kind">def</span> + <span class="symbol"> + <span class="name">hashCode</span><span class="params">()</span><span class="result">: <span class="extype" name="scala.Int">Int</span></span> + </span> + </h4> + <p class="shortcomment cmt">Returns a hash code value for the object</p><div class="fullcomment"> + <div class="comment cmt"><p>Returns a hash code value for the object.</p><p><p> +The default hashing algorithm is platform dependent.</p><p>Note that it is allowed for two objects to have identical hash +codes (<code>o1.hashCode.equals(o2.hashCode)</code>) yet not be +equal (<code>o1.equals(o2)</code> returns <code>false</code>). A +degenerate implementation could always return <code>0</code>. +However, it is required that if two objects are equal +(<code>o1.equals(o2)</code> returns <code>true</code>) that they +have identical hash codes +(<code>o1.hashCode.equals(o2.hashCode)</code>). Therefore, when +overriding this method, be sure to verify that the behavior is +consistent with the <code>equals</code> method. +</p></p><p><p></p></div> + + + <div class="block"> + definition classes: AnyRef ⇐ Any + </div> + + </div> + </li><li name="sims.dynamics.joints.test.UnitCircleJoint#node1"> + <h4 class="signature"> + <span class="kind">val</span> + <span class="symbol"> + <span class="name">node1</span><span class="result">: <a href="../../Body.html" class="extype" name="sims.dynamics.Body">Body</a></span> + </span> + </h4> + <p class="shortcomment cmt">First body of the joint</p><div class="fullcomment"> + <div class="comment cmt"><p>First body of the joint.</p></div> + + + + + </div> + </li><li name="sims.dynamics.joints.test.UnitCircleJoint#node2"> + <h4 class="signature"> + <span class="kind">val</span> + <span class="symbol"> + <span class="name">node2</span><span class="result">: <a href="../../Body.html" class="extype" name="sims.dynamics.Body">Body</a></span> + </span> + </h4> + <p class="shortcomment cmt">Second body of the joint</p><div class="fullcomment"> + <div class="comment cmt"><p>Second body of the joint.</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.dynamics.joints.test.UnitCircleJoint#v"> + <h4 class="signature"> + <span class="kind">def</span> + <span class="symbol"> + <span class="name">v</span><span class="result">: <a href="../../../geometry/Vector2D.html" class="extype" name="sims.geometry.Vector2D">Vector2D</a></span> + </span> + </h4> + + </li><li name="sims.dynamics.joints.test.UnitCircleJoint#x"> + <h4 class="signature"> + <span class="kind">def</span> + <span class="symbol"> + <span class="name">x</span><span class="result">: <a href="../../../geometry/Vector2D.html" class="extype" name="sims.geometry.Vector2D">Vector2D</a></span> + </span> + </h4> + + </li></ol> + </div> + + <div class="members" id="constructors"> + <h3>Instance constructors</h3> + <ol><li name="sims.dynamics.joints.test.UnitCircleJoint#this"> + <h4 class="signature"> + <span class="kind">new</span> + <span class="symbol"> + <span class="name">UnitCircleJoint</span><span class="params">(<span name="body">body: <a href="../../Body.html" class="extype" name="sims.dynamics.Body">Body</a></span>, <span name="anchor">anchor: <a href="../../../geometry/Vector2D.html" class="extype" name="sims.geometry.Vector2D">Vector2D</a></span>)</span> + </span> + </h4> + + </li><li name="sims.dynamics.joints.Joint#this"> + <h4 class="signature"> + <span class="kind">new</span> + <span class="symbol"> + <span class="name">UnitCircleJoint</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 this joint's associated bodies.</dd></dl> - <dl></dl> - <dl> - <dt style="margin:10px 0 0 20px;"> - <b>Overrides</b> - </dt> - <dd> - <a href="../../../../sims/dynamics/joints/Joint.html" target="_self">Joint</a>.<a href="../../../../sims/dynamics/joints/Joint.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/dynamics/joints/test/package.html b/doc/sims/dynamics/joints/test/package.html new file mode 100644 index 0000000..43414db --- /dev/null +++ b/doc/sims/dynamics/joints/test/package.html @@ -0,0 +1,70 @@ +<?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.dynamics.joints.test</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">dynamics</a>.<a href="../package.html">joints</a></p> + + <div id="definition"> + <img src="../../../../lib/package_big.png" /> + <h1>test</h1> + </div> + + <h4 class="signature"> + <span class="kind">package</span> + <span class="symbol"> + <span class="name">test</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.dynamics.joints.test.PrismaticJoint"> + <h4 class="signature"><a href="PrismaticJoint.html"> + <span class="kind">class</span> + <span class="symbol"> + <span class="name">PrismaticJoint</span><span class="params">(<span name="node1">node1: Body</span>, <span name="anchor1">anchor1: Vector2D</span>, <span name="node2">node2: Body</span>, <span name="anchor2">anchor2: Vector2D</span>)</span><span class="result"> extends Joint with Product</span> + </span> + </a></h4> + + </li><li name="sims.dynamics.joints.test.UnitCircleJoint"> + <h4 class="signature"><a href="UnitCircleJoint.html"> + <span class="kind">class</span> + <span class="symbol"> + <span class="name">UnitCircleJoint</span><span class="result"> extends Joint</span> + </span> + </a></h4> + + </li></ol> + </div> + + + + + + </div> + + </body> + </html>
\ No newline at end of file diff --git a/doc/sims/dynamics/package.html b/doc/sims/dynamics/package.html new file mode 100644 index 0000000..f9e3a86 --- /dev/null +++ b/doc/sims/dynamics/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.dynamics</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>dynamics</h1> + </div> + + <h4 class="signature"> + <span class="kind">package</span> + <span class="symbol"> + <span class="name">dynamics</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.dynamics.Body"> + <h4 class="signature"><a href="Body.html"> + <span class="kind">class</span> + <span class="symbol"> + <span class="name">Body</span><span class="result"> extends AnyRef</span> + </span> + </a></h4> + <p class="comment cmt">A two dimensional rigid body is made out of shapes</p> + </li><li name="sims.dynamics.Circle"> + <h4 class="signature"><a href="Circle.html"> + <span class="kind">class</span> + <span class="symbol"> + <span class="name">Circle</span><span class="params">(<span name="radius">radius: Double</span>, <span name="density">density: Double</span>)</span><span class="result"> extends Shape with Product</span> + </span> + </a></h4> + <p class="comment cmt">A circle</p> + </li><li name="sims.dynamics.Constraint"> + <h4 class="signature"><a href="Constraint.html"> + <span class="kind">trait</span> + <span class="symbol"> + <span class="name">Constraint</span><span class="result"> extends AnyRef</span> + </span> + </a></h4> + <p class="comment cmt">All constraints in SiMS implement this trait</p> + </li><li name="sims.dynamics.Rectangle"> + <h4 class="signature"><a href="Rectangle.html"> + <span class="kind">class</span> + <span class="symbol"> + <span class="name">Rectangle</span><span class="params">(<span name="halfWidth">halfWidth: Double</span>, <span name="halfHeight">halfHeight: Double</span>, <span name="density">density: Double</span>)</span><span class="result"> extends Shape with ConvexPolygon with Product</span> + </span> + </a></h4> + <p class="comment cmt">A rectangle is a polygon</p> + </li><li name="sims.dynamics.RegularPolygon"> + <h4 class="signature"><a href="RegularPolygon.html"> + <span class="kind">class</span> + <span class="symbol"> + <span class="name">RegularPolygon</span><span class="params">(<span name="n">n: Int</span>, <span name="radius">radius: Double</span>, <span name="density">density: Double</span>)</span><span class="result"> extends Shape with ConvexPolygon with Product</span> + </span> + </a></h4> + <p class="comment cmt">A regular polygon with <code>n</code> sides whose excircle has a radius <code>radius</code></p> + </li><li name="sims.dynamics.Shape"> + <h4 class="signature"><a href="Shape.html"> + <span class="kind">class</span> + <span class="symbol"> + <span class="name">Shape</span><span class="result"> extends AnyRef</span> + </span> + </a></h4> + <p class="comment cmt">An abstract shape</p> + </li><li name="sims.dynamics.World"> + <h4 class="signature"><a href="World.html"> + <span class="kind">class</span> + <span class="symbol"> + <span class="name">World</span><span class="result"> extends AnyRef</span> + </span> + </a></h4> + <p class="comment cmt">A world contains and simulates a system of rigid bodies and joints</p> + </li></ol> + </div> + + <div class="members" id="values"> + <h3>Value Members</h3> + <ol><li name="sims.dynamics.Body"> + <h4 class="signature"><a href="Body$.html"> + <span class="kind">object</span> + <span class="symbol"> + <span class="name">Body</span><span class="result"> extends AnyRef</span> + </span> + </a></h4> + + </li><li name="sims.dynamics.Shape"> + <h4 class="signature"><a href="Shape$.html"> + <span class="kind">object</span> + <span class="symbol"> + <span class="name">Shape</span><span class="result"> extends AnyRef</span> + </span> + </a></h4> + + </li><li name="sims.dynamics.joints"> + <h4 class="signature"><a href="joints/package.html"> + <span class="kind">package</span> + <span class="symbol"> + <span class="name">joints</span> + </span> + </a></h4> + + </li></ol> + </div> + + + + </div> + + </body> + </html>
\ No newline at end of file |