diff options
Diffstat (limited to 'doc/sims/dynamics')
| -rw-r--r-- | doc/sims/dynamics/Body$.html | 148 | ||||
| -rw-r--r-- | doc/sims/dynamics/Body.html | 490 | ||||
| -rw-r--r-- | doc/sims/dynamics/Circle.html | 530 | ||||
| -rw-r--r-- | doc/sims/dynamics/Constraint.html | 184 | ||||
| -rw-r--r-- | doc/sims/dynamics/Rectangle.html | 598 | ||||
| -rw-r--r-- | doc/sims/dynamics/RegularPolygon.html | 588 | ||||
| -rw-r--r-- | doc/sims/dynamics/Shape$.html | 148 | ||||
| -rw-r--r-- | doc/sims/dynamics/Shape.html | 458 | ||||
| -rw-r--r-- | doc/sims/dynamics/World.html | 539 | ||||
| -rw-r--r-- | doc/sims/dynamics/joints/DistanceJoint.html | 359 | ||||
| -rw-r--r-- | doc/sims/dynamics/joints/ForceJoint.html | 166 | ||||
| -rw-r--r-- | doc/sims/dynamics/joints/Joint.html | 228 | ||||
| -rw-r--r-- | doc/sims/dynamics/joints/RevoluteJoint.html | 307 | ||||
| -rw-r--r-- | doc/sims/dynamics/joints/SpringJoint.html | 419 | ||||
| -rw-r--r-- | doc/sims/dynamics/joints/package.html | 105 | ||||
| -rw-r--r-- | doc/sims/dynamics/joints/test/PrismaticJoint.html | 345 | ||||
| -rw-r--r-- | doc/sims/dynamics/joints/test/UnitCircleJoint.html | 247 | ||||
| -rw-r--r-- | doc/sims/dynamics/joints/test/package.html | 70 | ||||
| -rw-r--r-- | doc/sims/dynamics/package.html | 137 |
19 files changed, 0 insertions, 6066 deletions
diff --git a/doc/sims/dynamics/Body$.html b/doc/sims/dynamics/Body$.html deleted file mode 100644 index c9c6b49..0000000 --- a/doc/sims/dynamics/Body$.html +++ /dev/null @@ -1,148 +0,0 @@ -<?xml version='1.0' encoding='UTF-8'?> -<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.1//EN" "http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd"> -<html> - <head> - <title>Scaladoc for sims.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.html b/doc/sims/dynamics/Body.html deleted file mode 100644 index 858116a..0000000 --- a/doc/sims/dynamics/Body.html +++ /dev/null @@ -1,490 +0,0 @@ -<?xml version='1.0' encoding='UTF-8'?> -<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.1//EN" "http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd"> -<html> - <head> - <title>Scaladoc for sims.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> - - <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> - - - - - </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> - - </div> - - </body> - </html>
\ No newline at end of file diff --git a/doc/sims/dynamics/Circle.html b/doc/sims/dynamics/Circle.html deleted file mode 100644 index 47526f7..0000000 --- a/doc/sims/dynamics/Circle.html +++ /dev/null @@ -1,530 +0,0 @@ -<?xml version='1.0' encoding='UTF-8'?> -<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.1//EN" "http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd"> -<html> - <head> - <title>Scaladoc for sims.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 class="type"> - - <p id="owner"><a href="../package.html">sims</a>.<a href="package.html">dynamics</a></p> - - <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> - - - <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> - - - - <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> - - <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> - - </div> - - </body> - </html>
\ No newline at end of file diff --git a/doc/sims/dynamics/Constraint.html b/doc/sims/dynamics/Constraint.html deleted file mode 100644 index 23264ed..0000000 --- a/doc/sims/dynamics/Constraint.html +++ /dev/null @@ -1,184 +0,0 @@ -<?xml version='1.0' encoding='UTF-8'?> -<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.1//EN" "http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd"> -<html> - <head> - <title>Scaladoc for sims.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 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> - - <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 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> - - - </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> - - - - </div> - - </body> - </html>
\ No newline at end of file diff --git a/doc/sims/dynamics/Rectangle.html b/doc/sims/dynamics/Rectangle.html deleted file mode 100644 index 63ef89d..0000000 --- a/doc/sims/dynamics/Rectangle.html +++ /dev/null @@ -1,598 +0,0 @@ -<?xml version='1.0' encoding='UTF-8'?> -<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.1//EN" "http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd"> -<html> - <head> - <title>Scaladoc for sims.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 class="type"> - - <p id="owner"><a href="../package.html">sims</a>.<a href="package.html">dynamics</a></p> - - <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> - - - <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> - - - - <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> - - <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> - - </div> - - </body> - </html>
\ No newline at end of file diff --git a/doc/sims/dynamics/RegularPolygon.html b/doc/sims/dynamics/RegularPolygon.html deleted file mode 100644 index b0e8cc9..0000000 --- a/doc/sims/dynamics/RegularPolygon.html +++ /dev/null @@ -1,588 +0,0 @@ -<?xml version='1.0' encoding='UTF-8'?> -<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.1//EN" "http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd"> -<html> - <head> - <title>Scaladoc for sims.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 class="type"> - - <p id="owner"><a href="../package.html">sims</a>.<a href="package.html">dynamics</a></p> - - <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> - - - <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> - - - - <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> - - <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> - - </div> - - </body> - </html>
\ No newline at end of file diff --git a/doc/sims/dynamics/Shape$.html b/doc/sims/dynamics/Shape$.html deleted file mode 100644 index 6cc92c5..0000000 --- a/doc/sims/dynamics/Shape$.html +++ /dev/null @@ -1,148 +0,0 @@ -<?xml version='1.0' encoding='UTF-8'?> -<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.1//EN" "http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd"> -<html> - <head> - <title>Scaladoc for sims.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.html b/doc/sims/dynamics/Shape.html deleted file mode 100644 index 03db5e1..0000000 --- a/doc/sims/dynamics/Shape.html +++ /dev/null @@ -1,458 +0,0 @@ -<?xml version='1.0' encoding='UTF-8'?> -<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.1//EN" "http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd"> -<html> - <head> - <title>Scaladoc for sims.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="type"> - - <p id="owner"><a href="../package.html">sims</a>.<a href="package.html">dynamics</a></p> - - <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> - - <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> - - </div> - - </body> - </html>
\ No newline at end of file diff --git a/doc/sims/dynamics/World.html b/doc/sims/dynamics/World.html deleted file mode 100644 index 336852c..0000000 --- a/doc/sims/dynamics/World.html +++ /dev/null @@ -1,539 +0,0 @@ -<?xml version='1.0' encoding='UTF-8'?> -<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.1//EN" "http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd"> -<html> - <head> - <title>Scaladoc for sims.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> - - <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> - - - - - </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> - - </div> - - </body> - </html>
\ No newline at end of file diff --git a/doc/sims/dynamics/joints/DistanceJoint.html b/doc/sims/dynamics/joints/DistanceJoint.html deleted file mode 100644 index 27e4e5c..0000000 --- a/doc/sims/dynamics/joints/DistanceJoint.html +++ /dev/null @@ -1,359 +0,0 @@ -<?xml version='1.0' encoding='UTF-8'?> -<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.1//EN" "http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd"> -<html> - <head> - <title>Scaladoc for sims.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> - - </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> - - <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 deleted file mode 100644 index 76bfe45..0000000 --- a/doc/sims/dynamics/joints/ForceJoint.html +++ /dev/null @@ -1,166 +0,0 @@ -<?xml version='1.0' encoding='UTF-8'?> -<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.1//EN" "http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd"> -<html> - <head> - <title>Scaladoc for sims.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 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> - - <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 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> - - <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> - - - - </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 deleted file mode 100644 index 4874434..0000000 --- a/doc/sims/dynamics/joints/Joint.html +++ /dev/null @@ -1,228 +0,0 @@ -<?xml version='1.0' encoding='UTF-8'?> -<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.1//EN" "http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd"> -<html> - <head> - <title>Scaladoc for sims.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 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>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> - - <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> - - - - <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> - - <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> - - </div> - - </body> - </html>
\ No newline at end of file diff --git a/doc/sims/dynamics/joints/RevoluteJoint.html b/doc/sims/dynamics/joints/RevoluteJoint.html deleted file mode 100644 index 921025a..0000000 --- a/doc/sims/dynamics/joints/RevoluteJoint.html +++ /dev/null @@ -1,307 +0,0 @@ -<?xml version='1.0' encoding='UTF-8'?> -<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.1//EN" "http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd"> -<html> - <head> - <title>Scaladoc for sims.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> - - <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> - - - - - </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> - - </div> - - </body> - </html>
\ No newline at end of file diff --git a/doc/sims/dynamics/joints/SpringJoint.html b/doc/sims/dynamics/joints/SpringJoint.html deleted file mode 100644 index 699f2e0..0000000 --- a/doc/sims/dynamics/joints/SpringJoint.html +++ /dev/null @@ -1,419 +0,0 @@ -<?xml version='1.0' encoding='UTF-8'?> -<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.1//EN" "http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd"> -<html> - <head> - <title>Scaladoc for sims.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> - - </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> - - <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 deleted file mode 100644 index bd320c3..0000000 --- a/doc/sims/dynamics/joints/package.html +++ /dev/null @@ -1,105 +0,0 @@ -<?xml version='1.0' encoding='UTF-8'?> -<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.1//EN" "http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd"> -<html> - <head> - <title>Scaladoc for sims.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/PrismaticJoint.html b/doc/sims/dynamics/joints/test/PrismaticJoint.html deleted file mode 100644 index 2883427..0000000 --- a/doc/sims/dynamics/joints/test/PrismaticJoint.html +++ /dev/null @@ -1,345 +0,0 @@ -<?xml version='1.0' encoding='UTF-8'?> -<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.1//EN" "http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd"> -<html> - <head> - <title>Scaladoc for sims.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 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> - - <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 deleted file mode 100644 index d8291c4..0000000 --- a/doc/sims/dynamics/joints/test/UnitCircleJoint.html +++ /dev/null @@ -1,247 +0,0 @@ -<?xml version='1.0' encoding='UTF-8'?> -<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.1//EN" "http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd"> -<html> - <head> - <title>Scaladoc for sims.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 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>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"> - - - - - - </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> - - </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 deleted file mode 100644 index 43414db..0000000 --- a/doc/sims/dynamics/joints/test/package.html +++ /dev/null @@ -1,70 +0,0 @@ -<?xml version='1.0' encoding='UTF-8'?> -<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.1//EN" "http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd"> -<html> - <head> - <title>Scaladoc for sims.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 deleted file mode 100644 index f9e3a86..0000000 --- a/doc/sims/dynamics/package.html +++ /dev/null @@ -1,137 +0,0 @@ -<?xml version='1.0' encoding='UTF-8'?> -<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.1//EN" "http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd"> -<html> - <head> - <title>Scaladoc for sims.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 |