diff options
Diffstat (limited to 'doc/sims/collision')
| -rw-r--r-- | doc/sims/collision/AABB.html | 242 | ||||
| -rw-r--r-- | doc/sims/collision/CircleCollision.html | 321 | ||||
| -rw-r--r-- | doc/sims/collision/Collision$.html | 162 | ||||
| -rw-r--r-- | doc/sims/collision/Collision.html | 263 | ||||
| -rw-r--r-- | doc/sims/collision/Detector.html | 195 | ||||
| -rw-r--r-- | doc/sims/collision/GridDetector.html | 317 | ||||
| -rw-r--r-- | doc/sims/collision/Overlap.html | 233 | ||||
| -rw-r--r-- | doc/sims/collision/Pair.html | 274 | ||||
| -rw-r--r-- | doc/sims/collision/PolyCircleCollision.html | 321 | ||||
| -rw-r--r-- | doc/sims/collision/PolyCollision.html | 345 | ||||
| -rw-r--r-- | doc/sims/collision/package.html | 137 |
11 files changed, 0 insertions, 2810 deletions
diff --git a/doc/sims/collision/AABB.html b/doc/sims/collision/AABB.html deleted file mode 100644 index 9666bff..0000000 --- a/doc/sims/collision/AABB.html +++ /dev/null @@ -1,242 +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.collision.AABB</title> - <meta http-equiv="content-type" content="text/html; charset=UTF-8" /> - <script type="text/javascript" src="../../lib/jquery.js"></script> - - <style type="text/css"> - @import url(../../lib/template.css) screen; - </style> - <script type="text/javascript" src="../../lib/template.js"></script> - - </head> - <body class="type"> - - <p id="owner"><a href="../package.html">sims</a>.<a href="package.html">collision</a></p> - - <div id="definition"> - <img src="../../lib/class_big.png" /> - <h1>AABB</h1> - </div> - - <h4 class="signature"> - <span class="kind">class</span> - <span class="symbol"> - <span class="name">AABB</span><span class="params">(<span name="minVertex">minVertex: <a href="../geometry/Vector2D.html" class="extype" name="sims.geometry.Vector2D">Vector2D</a></span>, <span name="maxVertex">maxVertex: <a href="../geometry/Vector2D.html" class="extype" name="sims.geometry.Vector2D">Vector2D</a></span>)</span><span class="result"> extends <span class="extype" name="scala.Product">Product</span></span> - </span> - </h4> - <div class="fullcomment" id="comment"> - <div class="comment cmt"><p>Axis Aligned Bounding Boxes (AABBs) are rectangles that frame a shape. -Their X-Axis and Y-Axis orientation makes it easy to test two AABBs for overlap.</p></div> - <dl class="paramcmts block"><dt class="param">minVertex</dt><dd class="cmt"><p>Position vector of the bottom-left vertex</p></dd><dt class="param">maxVertex</dt><dd class="cmt"><p>Position vector of the upper-right vertex</p></dd></dl> - - - <div class="block"> - known subclasses: <a href="../../graphyx/graphics/GraphicalAABB.html">GraphicalAABB</a> - </div> - </div> - - <div id="template"> - - <div id="mbrsel"> - <div id="ancestors"> - <h3>Inherits</h3> - <ol><li class="in" name="scala.Product">Product</li><li class="in" name="scala.Equals">Equals</li><li class="in" name="scala.AnyRef">AnyRef</li><li class="in" name="scala.Any">Any</li></ol> - </div> - </div> - - - - <div class="members" id="values"> - <h3>Value Members</h3> - <ol><li name="sims.collision.AABB#canEqual"> - <h4 class="signature"> - <span class="kind">def</span> - <span class="symbol"> - <span class="name">canEqual</span><span class="params">(<span name="arg0">arg0: <span class="extype" name="scala.Any">Any</span></span>)</span><span class="result">: <span class="extype" name="scala.Boolean">Boolean</span></span> - </span> - </h4> - - </li><li name="sims.collision.AABB#equals"> - <h4 class="signature"> - <span class="kind">def</span> - <span class="symbol"> - <span class="name">equals</span><span class="params">(<span name="arg0">arg0: <span class="extype" name="scala.Any">Any</span></span>)</span><span class="result">: <span class="extype" name="scala.Boolean">Boolean</span></span> - </span> - </h4> - <p class="shortcomment cmt">This method is used to compare the receiver object (<code>this</code>) -with the argument object (<code>arg0</code>) for equivalence</p><div class="fullcomment"> - <div class="comment cmt"><p>This method is used to compare the receiver object (<code>this</code>) -with the argument object (<code>arg0</code>) for equivalence.</p><p><p> -The default implementations of this method is an <a -href="http://en.wikipedia.org/wiki/Equivalence_relation">equivalence -relation</a>: - <ul> - <li>It is reflexive: for any instance <code>x</code> of type <code>Any</code>, - <code>x.equals(x)</code> should return <code>true</code>.</li> - <li>It is symmetric: for any instances <code>x</code> and <code>y</code> of type - <code>Any</code>, <code>x.equals(y)</code> should return <code>true</code> if and only - if <code>y.equals(x)</code> returns <code>true</code>.</li> - <li>It is transitive: for any instances - <code>x</code>, <code>y</code>, and <code>z</code> of type <code>AnyRef</code> - if <code>x.equals(y)</code> returns <code>true</code> and - <code>y.equals(z)</code> returns - <code>true</code>, then <code>x.equals(z)</code> should return <code>true</code>.</li> -</ul> -</p></p><p><p> -If you override this method, you should verify that -your implementation remains an equivalence relation. -Additionally, when overriding this method it is often necessary to -override <code>hashCode</code> to ensure that objects that are -"equal" (<code>o1.equals(o2)</code> returns <code>true</code>) -hash to the same <a href="Int.html"><code>Int</code></a> -(<code>o1.hashCode.equals(o2.hashCode)</code>). -</p></div> - <dl class="paramcmts block"><dt class="param">arg0</dt><dd class="cmt"><p>the object to compare against this object for equality.</p></dd><dt>returns</dt><dd class="cmt"><p><code>true</code> if the receiver object is equivalent to the argument; <code>false</code> otherwise. -</p></p></dd></dl> - - - - </div> - </li><li name="sims.collision.AABB#hashCode"> - <h4 class="signature"> - <span class="kind">def</span> - <span class="symbol"> - <span class="name">hashCode</span><span class="params">()</span><span class="result">: <span class="extype" name="scala.Int">Int</span></span> - </span> - </h4> - <p class="shortcomment cmt">Returns a hash code value for the object</p><div class="fullcomment"> - <div class="comment cmt"><p>Returns a hash code value for the object.</p><p><p> -The default hashing algorithm is platform dependent.</p><p>Note that it is allowed for two objects to have identical hash -codes (<code>o1.hashCode.equals(o2.hashCode)</code>) yet not be -equal (<code>o1.equals(o2)</code> returns <code>false</code>). A -degenerate implementation could always return <code>0</code>. -However, it is required that if two objects are equal -(<code>o1.equals(o2)</code> returns <code>true</code>) that they -have identical hash codes -(<code>o1.hashCode.equals(o2.hashCode)</code>). Therefore, when -overriding this method, be sure to verify that the behavior is -consistent with the <code>equals</code> method. -</p></p><p><p></p></div> - - - - - </div> - </li><li name="sims.collision.AABB#maxVertex"> - <h4 class="signature"> - <span class="kind">val</span> - <span class="symbol"> - <span class="name">maxVertex</span><span class="result">: <a href="../geometry/Vector2D.html" class="extype" name="sims.geometry.Vector2D">Vector2D</a></span> - </span> - </h4> - - </li><li name="sims.collision.AABB#minVertex"> - <h4 class="signature"> - <span class="kind">val</span> - <span class="symbol"> - <span class="name">minVertex</span><span class="result">: <a href="../geometry/Vector2D.html" class="extype" name="sims.geometry.Vector2D">Vector2D</a></span> - </span> - </h4> - - </li><li name="sims.collision.AABB#overlaps"> - <h4 class="signature"> - <span class="kind">def</span> - <span class="symbol"> - <span class="name">overlaps</span><span class="params">(<span name="box">box: <a href="" class="extype" name="sims.collision.AABB">AABB</a></span>)</span><span class="result">: <span class="extype" name="scala.Boolean">Boolean</span></span> - </span> - </h4> - <p class="shortcomment cmt">Checks this AABB with <code>box</code> for overlap</p><div class="fullcomment"> - <div class="comment cmt"><p>Checks this AABB with <code>box</code> for overlap.</p></div> - <dl class="paramcmts block"><dt class="param">box</dt><dd class="cmt"><p>AABB with which to check for overlap</p></dd></dl> - - - - </div> - </li><li name="sims.collision.AABB#productArity"> - <h4 class="signature"> - <span class="kind">def</span> - <span class="symbol"> - <span class="name">productArity</span><span class="result">: <span class="extype" name="scala.Int">Int</span></span> - </span> - </h4> - - </li><li name="sims.collision.AABB#productElement"> - <h4 class="signature"> - <span class="kind">def</span> - <span class="symbol"> - <span class="name">productElement</span><span class="params">(<span name="arg0">arg0: <span class="extype" name="scala.Int">Int</span></span>)</span><span class="result">: <span class="extype" name="scala.Any">Any</span></span> - </span> - </h4> - - </li><li name="scala.Product#productElements"> - <h4 class="signature"> - <span class="kind">def</span> - <span class="symbol"> - <span class="name">productElements</span><span class="result">: <span class="extype" name="scala.collection.Iterator">Iterator</span>[<span class="extype" name="scala.Any">Any</span>]</span> - </span> - </h4> - - </li><li name="scala.Product#productIterator"> - <h4 class="signature"> - <span class="kind">def</span> - <span class="symbol"> - <span class="name">productIterator</span><span class="result">: <span class="extype" name="scala.collection.Iterator">Iterator</span>[<span class="extype" name="scala.Any">Any</span>]</span> - </span> - </h4> - - </li><li name="sims.collision.AABB#productPrefix"> - <h4 class="signature"> - <span class="kind">def</span> - <span class="symbol"> - <span class="name">productPrefix</span><span class="result">: <span class="extype" name="java.lang.String">String</span></span> - </span> - </h4> - - </li><li name="sims.collision.AABB#toString"> - <h4 class="signature"> - <span class="kind">def</span> - <span class="symbol"> - <span class="name">toString</span><span class="params">()</span><span class="result">: <span class="extype" name="java.lang.String">String</span></span> - </span> - </h4> - <p class="shortcomment cmt">Returns a string representation of the object</p><div class="fullcomment"> - <div class="comment cmt"><p>Returns a string representation of the object. -<p> -The default representation is platform dependent. -</p></div> - - - - - </div> - </li></ol> - </div> - - <div class="members" id="constructors"> - <h3>Instance constructors</h3> - <ol><li name="sims.collision.AABB#this"> - <h4 class="signature"> - <span class="kind">new</span> - <span class="symbol"> - <span class="name">AABB</span><span class="params">(<span name="minVertex">minVertex: <a href="../geometry/Vector2D.html" class="extype" name="sims.geometry.Vector2D">Vector2D</a></span>, <span name="maxVertex">maxVertex: <a href="../geometry/Vector2D.html" class="extype" name="sims.geometry.Vector2D">Vector2D</a></span>)</span> - </span> - </h4> - - </li><li name="scala.AnyRef#this"> - <h4 class="signature"> - <span class="kind">new</span> - <span class="symbol"> - <span class="name">AABB</span><span class="params">()</span> - </span> - </h4> - - </li></ol> - </div> - - </div> - - </body> - </html>
\ No newline at end of file diff --git a/doc/sims/collision/CircleCollision.html b/doc/sims/collision/CircleCollision.html deleted file mode 100644 index 80e6b4d..0000000 --- a/doc/sims/collision/CircleCollision.html +++ /dev/null @@ -1,321 +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.collision.CircleCollision</title> - <meta http-equiv="content-type" content="text/html; charset=UTF-8" /> - <script type="text/javascript" src="../../lib/jquery.js"></script> - - <style type="text/css"> - @import url(../../lib/template.css) screen; - </style> - <script type="text/javascript" src="../../lib/template.js"></script> - - </head> - <body class="type"> - - <p id="owner"><a href="../package.html">sims</a>.<a href="package.html">collision</a></p> - - <div id="definition"> - <img src="../../lib/class_big.png" /> - <h1>CircleCollision</h1> - </div> - - <h4 class="signature"> - <span class="kind">class</span> - <span class="symbol"> - <span class="name">CircleCollision</span><span class="params">(<span name="c1">c1: <a href="../dynamics/Circle.html" class="extype" name="sims.dynamics.Circle">Circle</a></span>, <span name="c2">c2: <a href="../dynamics/Circle.html" class="extype" name="sims.dynamics.Circle">Circle</a></span>)</span><span class="result"> extends <a href="Collision.html" class="extype" name="sims.collision.Collision">Collision</a> with <span class="extype" name="scala.Product">Product</span></span> - </span> - </h4> - <div class="fullcomment" id="comment"> - <div class="comment cmt"><p>Collision between two circles.</p></div> - - - - - </div> - - <div id="template"> - - <div id="mbrsel"> - <div id="ancestors"> - <h3>Inherits</h3> - <ol><li class="in" name="scala.Product">Product</li><li class="in" name="scala.Equals">Equals</li><li class="in" name="sims.collision.Collision">Collision</li><li class="in" name="sims.dynamics.Constraint">Constraint</li><li class="in" name="scala.AnyRef">AnyRef</li><li class="in" name="scala.Any">Any</li></ol> - </div> - </div> - - - - <div class="members" id="values"> - <h3>Value Members</h3> - <ol><li name="sims.collision.CircleCollision#c1"> - <h4 class="signature"> - <span class="kind">val</span> - <span class="symbol"> - <span class="name">c1</span><span class="result">: <a href="../dynamics/Circle.html" class="extype" name="sims.dynamics.Circle">Circle</a></span> - </span> - </h4> - - </li><li name="sims.collision.CircleCollision#c2"> - <h4 class="signature"> - <span class="kind">val</span> - <span class="symbol"> - <span class="name">c2</span><span class="result">: <a href="../dynamics/Circle.html" class="extype" name="sims.dynamics.Circle">Circle</a></span> - </span> - </h4> - - </li><li name="sims.collision.CircleCollision#canEqual"> - <h4 class="signature"> - <span class="kind">def</span> - <span class="symbol"> - <span class="name">canEqual</span><span class="params">(<span name="arg0">arg0: <span class="extype" name="scala.Any">Any</span></span>)</span><span class="result">: <span class="extype" name="scala.Boolean">Boolean</span></span> - </span> - </h4> - - </li><li name="sims.collision.Collision#correctFriction"> - <h4 class="signature"> - <span class="kind">def</span> - <span class="symbol"> - <span class="name">correctFriction</span><span class="params">(<span name="point">point: <a href="../geometry/Vector2D.html" class="extype" name="sims.geometry.Vector2D">Vector2D</a></span>, <span name="normalForce">normalForce: <span class="extype" name="scala.Double">Double</span></span>, <span name="h">h: <span class="extype" name="scala.Double">Double</span></span>)</span><span class="result">: <span class="extype" name="scala.Unit">Unit</span></span> - </span> - </h4> - - </li><li name="sims.collision.Collision#correctPosition"> - <h4 class="signature"> - <span class="kind">def</span> - <span class="symbol"> - <span class="name">correctPosition</span><span class="params">(<span name="h">h: <span class="extype" name="scala.Double">Double</span></span>)</span><span class="result">: <span class="extype" name="scala.Unit">Unit</span></span> - </span> - </h4> - <p class="shortcomment cmt">Corrects the positions of bodies according to this constraint</p><div class="fullcomment"> - <div class="comment cmt"><p>Corrects the positions of bodies according to this constraint.</p></div> - <dl class="paramcmts block"><dt class="param">h</dt><dd class="cmt"><p>a time interval, used for converting forces and impulses</p></dd></dl> - - <div class="block"> - definition classes: <a href="Collision.html">Collision</a> ⇐ <a href="../dynamics/Constraint.html">Constraint</a> - </div> - - </div> - </li><li name="sims.collision.Collision#correctVelocity"> - <h4 class="signature"> - <span class="kind">def</span> - <span class="symbol"> - <span class="name">correctVelocity</span><span class="params">(<span name="h">h: <span class="extype" name="scala.Double">Double</span></span>)</span><span class="result">: <span class="extype" name="scala.Unit">Unit</span></span> - </span> - </h4> - <p class="shortcomment cmt">Corrects the velocities of bodies according to this constraint</p><div class="fullcomment"> - <div class="comment cmt"><p>Corrects the velocities of bodies according to this constraint.</p></div> - <dl class="paramcmts block"><dt class="param">h</dt><dd class="cmt"><p>a time interval, used for converting forces and impulses</p></dd></dl> - - <div class="block"> - definition classes: <a href="Collision.html">Collision</a> ⇐ <a href="../dynamics/Constraint.html">Constraint</a> - </div> - - </div> - </li><li name="sims.collision.CircleCollision#equals"> - <h4 class="signature"> - <span class="kind">def</span> - <span class="symbol"> - <span class="name">equals</span><span class="params">(<span name="arg0">arg0: <span class="extype" name="scala.Any">Any</span></span>)</span><span class="result">: <span class="extype" name="scala.Boolean">Boolean</span></span> - </span> - </h4> - <p class="shortcomment cmt">This method is used to compare the receiver object (<code>this</code>) -with the argument object (<code>arg0</code>) for equivalence</p><div class="fullcomment"> - <div class="comment cmt"><p>This method is used to compare the receiver object (<code>this</code>) -with the argument object (<code>arg0</code>) for equivalence.</p><p><p> -The default implementations of this method is an <a -href="http://en.wikipedia.org/wiki/Equivalence_relation">equivalence -relation</a>: - <ul> - <li>It is reflexive: for any instance <code>x</code> of type <code>Any</code>, - <code>x.equals(x)</code> should return <code>true</code>.</li> - <li>It is symmetric: for any instances <code>x</code> and <code>y</code> of type - <code>Any</code>, <code>x.equals(y)</code> should return <code>true</code> if and only - if <code>y.equals(x)</code> returns <code>true</code>.</li> - <li>It is transitive: for any instances - <code>x</code>, <code>y</code>, and <code>z</code> of type <code>AnyRef</code> - if <code>x.equals(y)</code> returns <code>true</code> and - <code>y.equals(z)</code> returns - <code>true</code>, then <code>x.equals(z)</code> should return <code>true</code>.</li> -</ul> -</p></p><p><p> -If you override this method, you should verify that -your implementation remains an equivalence relation. -Additionally, when overriding this method it is often necessary to -override <code>hashCode</code> to ensure that objects that are -"equal" (<code>o1.equals(o2)</code> returns <code>true</code>) -hash to the same <a href="Int.html"><code>Int</code></a> -(<code>o1.hashCode.equals(o2.hashCode)</code>). -</p></div> - <dl class="paramcmts block"><dt class="param">arg0</dt><dd class="cmt"><p>the object to compare against this object for equality.</p></dd><dt>returns</dt><dd class="cmt"><p><code>true</code> if the receiver object is equivalent to the argument; <code>false</code> otherwise. -</p></p></dd></dl> - - - - </div> - </li><li name="sims.collision.CircleCollision#hashCode"> - <h4 class="signature"> - <span class="kind">def</span> - <span class="symbol"> - <span class="name">hashCode</span><span class="params">()</span><span class="result">: <span class="extype" name="scala.Int">Int</span></span> - </span> - </h4> - <p class="shortcomment cmt">Returns a hash code value for the object</p><div class="fullcomment"> - <div class="comment cmt"><p>Returns a hash code value for the object.</p><p><p> -The default hashing algorithm is platform dependent.</p><p>Note that it is allowed for two objects to have identical hash -codes (<code>o1.hashCode.equals(o2.hashCode)</code>) yet not be -equal (<code>o1.equals(o2)</code> returns <code>false</code>). A -degenerate implementation could always return <code>0</code>. -However, it is required that if two objects are equal -(<code>o1.equals(o2)</code> returns <code>true</code>) that they -have identical hash codes -(<code>o1.hashCode.equals(o2.hashCode)</code>). Therefore, when -overriding this method, be sure to verify that the behavior is -consistent with the <code>equals</code> method. -</p></p><p><p></p></div> - - - - - </div> - </li><li name="sims.collision.CircleCollision#normal"> - <h4 class="signature"> - <span class="kind">val</span> - <span class="symbol"> - <span class="name">normal</span><span class="result">: <a href="../geometry/Vector2D.html" class="extype" name="sims.geometry.Vector2D">Vector2D</a></span> - </span> - </h4> - <p class="shortcomment cmt">Normal vector to the collision face</p><div class="fullcomment"> - <div class="comment cmt"><p>Normal vector to the collision face.</p></div> - - - - - </div> - </li><li name="sims.collision.CircleCollision#points"> - <h4 class="signature"> - <span class="kind">val</span> - <span class="symbol"> - <span class="name">points</span><span class="result">: <span class="extype" name="scala.collection.immutable.List">List</span>[<a href="../geometry/Vector2D.html" class="extype" name="sims.geometry.Vector2D">Vector2D</a>]</span> - </span> - </h4> - <p class="shortcomment cmt">Collision points</p><div class="fullcomment"> - <div class="comment cmt"><p>Collision points.</p></div> - - - - - </div> - </li><li name="sims.collision.CircleCollision#productArity"> - <h4 class="signature"> - <span class="kind">def</span> - <span class="symbol"> - <span class="name">productArity</span><span class="result">: <span class="extype" name="scala.Int">Int</span></span> - </span> - </h4> - - </li><li name="sims.collision.CircleCollision#productElement"> - <h4 class="signature"> - <span class="kind">def</span> - <span class="symbol"> - <span class="name">productElement</span><span class="params">(<span name="arg0">arg0: <span class="extype" name="scala.Int">Int</span></span>)</span><span class="result">: <span class="extype" name="scala.Any">Any</span></span> - </span> - </h4> - - </li><li name="scala.Product#productElements"> - <h4 class="signature"> - <span class="kind">def</span> - <span class="symbol"> - <span class="name">productElements</span><span class="result">: <span class="extype" name="scala.collection.Iterator">Iterator</span>[<span class="extype" name="scala.Any">Any</span>]</span> - </span> - </h4> - - </li><li name="scala.Product#productIterator"> - <h4 class="signature"> - <span class="kind">def</span> - <span class="symbol"> - <span class="name">productIterator</span><span class="result">: <span class="extype" name="scala.collection.Iterator">Iterator</span>[<span class="extype" name="scala.Any">Any</span>]</span> - </span> - </h4> - - </li><li name="sims.collision.CircleCollision#productPrefix"> - <h4 class="signature"> - <span class="kind">def</span> - <span class="symbol"> - <span class="name">productPrefix</span><span class="result">: <span class="extype" name="java.lang.String">String</span></span> - </span> - </h4> - - </li><li name="sims.collision.CircleCollision#shape1"> - <h4 class="signature"> - <span class="kind">val</span> - <span class="symbol"> - <span class="name">shape1</span><span class="result">: <a href="../dynamics/Circle.html" class="extype" name="sims.dynamics.Circle">Circle</a></span> - </span> - </h4> - <p class="shortcomment cmt">First colliding shape (reference shape)</p><div class="fullcomment"> - <div class="comment cmt"><p>First colliding shape (reference shape).</p></div> - - - - - </div> - </li><li name="sims.collision.CircleCollision#shape2"> - <h4 class="signature"> - <span class="kind">val</span> - <span class="symbol"> - <span class="name">shape2</span><span class="result">: <a href="../dynamics/Circle.html" class="extype" name="sims.dynamics.Circle">Circle</a></span> - </span> - </h4> - <p class="shortcomment cmt">Second colliding shape (incident shape)</p><div class="fullcomment"> - <div class="comment cmt"><p>Second colliding shape (incident shape).</p></div> - - - - - </div> - </li><li name="sims.collision.CircleCollision#toString"> - <h4 class="signature"> - <span class="kind">def</span> - <span class="symbol"> - <span class="name">toString</span><span class="params">()</span><span class="result">: <span class="extype" name="java.lang.String">String</span></span> - </span> - </h4> - <p class="shortcomment cmt">Returns a string representation of the object</p><div class="fullcomment"> - <div class="comment cmt"><p>Returns a string representation of the object. -<p> -The default representation is platform dependent. -</p></div> - - - - - </div> - </li></ol> - </div> - - <div class="members" id="constructors"> - <h3>Instance constructors</h3> - <ol><li name="sims.collision.CircleCollision#this"> - <h4 class="signature"> - <span class="kind">new</span> - <span class="symbol"> - <span class="name">CircleCollision</span><span class="params">(<span name="c1">c1: <a href="../dynamics/Circle.html" class="extype" name="sims.dynamics.Circle">Circle</a></span>, <span name="c2">c2: <a href="../dynamics/Circle.html" class="extype" name="sims.dynamics.Circle">Circle</a></span>)</span> - </span> - </h4> - - </li><li name="sims.collision.Collision#this"> - <h4 class="signature"> - <span class="kind">new</span> - <span class="symbol"> - <span class="name">CircleCollision</span><span class="params">()</span> - </span> - </h4> - - </li></ol> - </div> - - </div> - - </body> - </html>
\ No newline at end of file diff --git a/doc/sims/collision/Collision$.html b/doc/sims/collision/Collision$.html deleted file mode 100644 index a7c64d8..0000000 --- a/doc/sims/collision/Collision$.html +++ /dev/null @@ -1,162 +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.collision.Collision</title> - <meta http-equiv="content-type" content="text/html; charset=UTF-8" /> - <script type="text/javascript" src="../../lib/jquery.js"></script> - - <style type="text/css"> - @import url(../../lib/template.css) screen; - </style> - <script type="text/javascript" src="../../lib/template.js"></script> - - </head> - <body class="value"> - - <p id="owner"><a href="../package.html">sims</a>.<a href="package.html">collision</a></p> - - <div id="definition"> - <img src="../../lib/object_big.png" /> - <h1>Collision</h1> - </div> - - <h4 class="signature"> - <span class="kind">object</span> - <span class="symbol"> - <span class="name">Collision</span><span class="result"> extends AnyRef</span> - </span> - </h4> - <div class="fullcomment" id="comment"> - - - - - - </div> - - <div id="template"> - - <div id="mbrsel"> - <div id="ancestors"> - <h3>Inherits</h3> - <ol><li class="in" name="scala.AnyRef">AnyRef</li><li class="in" name="scala.Any">Any</li></ol> - </div> - </div> - - - - <div class="members" id="values"> - <h3>Value Members</h3> - <ol><li name="sims.collision.Collision#ToleratedOverlap"> - <h4 class="signature"> - <span class="kind">val</span> - <span class="symbol"> - <span class="name">ToleratedOverlap</span><span class="result">: <span class="extype" name="scala.Double">Double</span></span> - </span> - </h4> - <p class="shortcomment cmt">Tolerated overlap</p><div class="fullcomment"> - <div class="comment cmt"><p>Tolerated overlap. Collision response will only be applied if the overlap of two shapes exceeds the tolerated overlap.</p></div> - - - - - </div> - </li><li name="scala.AnyRef#equals"> - <h4 class="signature"> - <span class="kind">def</span> - <span class="symbol"> - <span class="name">equals</span><span class="params">(<span name="arg0">arg0: <span class="extype" name="scala.Any">Any</span></span>)</span><span class="result">: <span class="extype" name="scala.Boolean">Boolean</span></span> - </span> - </h4> - <p class="shortcomment cmt">This method is used to compare the receiver object (<code>this</code>) -with the argument object (<code>arg0</code>) for equivalence</p><div class="fullcomment"> - <div class="comment cmt"><p>This method is used to compare the receiver object (<code>this</code>) -with the argument object (<code>arg0</code>) for equivalence.</p><p><p> -The default implementations of this method is an <a -href="http://en.wikipedia.org/wiki/Equivalence_relation">equivalence -relation</a>: - <ul> - <li>It is reflexive: for any instance <code>x</code> of type <code>Any</code>, - <code>x.equals(x)</code> should return <code>true</code>.</li> - <li>It is symmetric: for any instances <code>x</code> and <code>y</code> of type - <code>Any</code>, <code>x.equals(y)</code> should return <code>true</code> if and only - if <code>y.equals(x)</code> returns <code>true</code>.</li> - <li>It is transitive: for any instances - <code>x</code>, <code>y</code>, and <code>z</code> of type <code>AnyRef</code> - if <code>x.equals(y)</code> returns <code>true</code> and - <code>y.equals(z)</code> returns - <code>true</code>, then <code>x.equals(z)</code> should return <code>true</code>.</li> -</ul> -</p></p><p><p> -If you override this method, you should verify that -your implementation remains an equivalence relation. -Additionally, when overriding this method it is often necessary to -override <code>hashCode</code> to ensure that objects that are -"equal" (<code>o1.equals(o2)</code> returns <code>true</code>) -hash to the same <a href="Int.html"><code>Int</code></a> -(<code>o1.hashCode.equals(o2.hashCode)</code>). -</p></div> - <dl class="paramcmts block"><dt class="param">arg0</dt><dd class="cmt"><p>the object to compare against this object for equality.</p></dd><dt>returns</dt><dd class="cmt"><p><code>true</code> if the receiver object is equivalent to the argument; <code>false</code> otherwise. -</p></p></dd></dl> - - <div class="block"> - definition classes: AnyRef ⇐ Any - </div> - - </div> - </li><li name="scala.AnyRef#hashCode"> - <h4 class="signature"> - <span class="kind">def</span> - <span class="symbol"> - <span class="name">hashCode</span><span class="params">()</span><span class="result">: <span class="extype" name="scala.Int">Int</span></span> - </span> - </h4> - <p class="shortcomment cmt">Returns a hash code value for the object</p><div class="fullcomment"> - <div class="comment cmt"><p>Returns a hash code value for the object.</p><p><p> -The default hashing algorithm is platform dependent.</p><p>Note that it is allowed for two objects to have identical hash -codes (<code>o1.hashCode.equals(o2.hashCode)</code>) yet not be -equal (<code>o1.equals(o2)</code> returns <code>false</code>). A -degenerate implementation could always return <code>0</code>. -However, it is required that if two objects are equal -(<code>o1.equals(o2)</code> returns <code>true</code>) that they -have identical hash codes -(<code>o1.hashCode.equals(o2.hashCode)</code>). Therefore, when -overriding this method, be sure to verify that the behavior is -consistent with the <code>equals</code> method. -</p></p><p><p></p></div> - - - <div class="block"> - definition classes: AnyRef ⇐ Any - </div> - - </div> - </li><li name="scala.AnyRef#toString"> - <h4 class="signature"> - <span class="kind">def</span> - <span class="symbol"> - <span class="name">toString</span><span class="params">()</span><span class="result">: <span class="extype" name="java.lang.String">String</span></span> - </span> - </h4> - <p class="shortcomment cmt">Returns a string representation of the object</p><div class="fullcomment"> - <div class="comment cmt"><p>Returns a string representation of the object. -<p> -The default representation is platform dependent. -</p></div> - - - <div class="block"> - definition classes: AnyRef ⇐ Any - </div> - - </div> - </li></ol> - </div> - - - - </div> - - </body> - </html>
\ No newline at end of file diff --git a/doc/sims/collision/Collision.html b/doc/sims/collision/Collision.html deleted file mode 100644 index c74223c..0000000 --- a/doc/sims/collision/Collision.html +++ /dev/null @@ -1,263 +0,0 @@ -<?xml version='1.0' encoding='UTF-8'?> -<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.1//EN" "http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd"> -<html> - <head> - <title>Scaladoc for sims.collision.Collision</title> - <meta http-equiv="content-type" content="text/html; charset=UTF-8" /> - <script type="text/javascript" src="../../lib/jquery.js"></script> - - <style type="text/css"> - @import url(../../lib/template.css) screen; - </style> - <script type="text/javascript" src="../../lib/template.js"></script> - - </head> - <body class="type"> - - <p id="owner"><a href="../package.html">sims</a>.<a href="package.html">collision</a></p> - - <div id="definition"> - <img src="../../lib/class_big.png" /> - <h1>Collision</h1> - </div> - - <h4 class="signature"> - <span class="kind">class</span> - <span class="symbol"> - <span class="name">Collision</span><span class="result"> extends <a href="../dynamics/Constraint.html" class="extype" name="sims.dynamics.Constraint">Constraint</a></span> - </span> - </h4> - <div class="fullcomment" id="comment"> - <div class="comment cmt"><p>Collision between two shapes. Contains methods to compute the collision response.</p></div> - - <div class="block"> - attributes: abstract - </div> - - <div class="block"> - known subclasses: <a href="PolyCollision.html">PolyCollision</a>, <a href="PolyCircleCollision.html">PolyCircleCollision</a>, <a href="CircleCollision.html">CircleCollision</a> - </div> - </div> - - <div id="template"> - - <div id="mbrsel"> - <div id="ancestors"> - <h3>Inherits</h3> - <ol><li class="in" name="sims.dynamics.Constraint">Constraint</li><li class="in" name="scala.AnyRef">AnyRef</li><li class="in" name="scala.Any">Any</li></ol> - </div> - </div> - - - - <div class="members" id="values"> - <h3>Value Members</h3> - <ol><li name="sims.collision.Collision#correctFriction"> - <h4 class="signature"> - <span class="kind">def</span> - <span class="symbol"> - <span class="name">correctFriction</span><span class="params">(<span name="point">point: <a href="../geometry/Vector2D.html" class="extype" name="sims.geometry.Vector2D">Vector2D</a></span>, <span name="normalForce">normalForce: <span class="extype" name="scala.Double">Double</span></span>, <span name="h">h: <span class="extype" name="scala.Double">Double</span></span>)</span><span class="result">: <span class="extype" name="scala.Unit">Unit</span></span> - </span> - </h4> - - </li><li name="sims.collision.Collision#correctPosition"> - <h4 class="signature"> - <span class="kind">def</span> - <span class="symbol"> - <span class="name">correctPosition</span><span class="params">(<span name="h">h: <span class="extype" name="scala.Double">Double</span></span>)</span><span class="result">: <span class="extype" name="scala.Unit">Unit</span></span> - </span> - </h4> - <p class="shortcomment cmt">Corrects the positions of bodies according to this constraint</p><div class="fullcomment"> - <div class="comment cmt"><p>Corrects the positions of bodies according to this constraint.</p></div> - <dl class="paramcmts block"><dt class="param">h</dt><dd class="cmt"><p>a time interval, used for converting forces and impulses</p></dd></dl> - - - - </div> - </li><li name="sims.collision.Collision#correctVelocity"> - <h4 class="signature"> - <span class="kind">def</span> - <span class="symbol"> - <span class="name">correctVelocity</span><span class="params">(<span name="h">h: <span class="extype" name="scala.Double">Double</span></span>)</span><span class="result">: <span class="extype" name="scala.Unit">Unit</span></span> - </span> - </h4> - <p class="shortcomment cmt">Corrects the velocities of bodies according to this constraint</p><div class="fullcomment"> - <div class="comment cmt"><p>Corrects the velocities of bodies according to this constraint.</p></div> - <dl class="paramcmts block"><dt class="param">h</dt><dd class="cmt"><p>a time interval, used for converting forces and impulses</p></dd></dl> - - - - </div> - </li><li name="scala.AnyRef#equals"> - <h4 class="signature"> - <span class="kind">def</span> - <span class="symbol"> - <span class="name">equals</span><span class="params">(<span name="arg0">arg0: <span class="extype" name="scala.Any">Any</span></span>)</span><span class="result">: <span class="extype" name="scala.Boolean">Boolean</span></span> - </span> - </h4> - <p class="shortcomment cmt">This method is used to compare the receiver object (<code>this</code>) -with the argument object (<code>arg0</code>) for equivalence</p><div class="fullcomment"> - <div class="comment cmt"><p>This method is used to compare the receiver object (<code>this</code>) -with the argument object (<code>arg0</code>) for equivalence.</p><p><p> -The default implementations of this method is an <a -href="http://en.wikipedia.org/wiki/Equivalence_relation">equivalence -relation</a>: - <ul> - <li>It is reflexive: for any instance <code>x</code> of type <code>Any</code>, - <code>x.equals(x)</code> should return <code>true</code>.</li> - <li>It is symmetric: for any instances <code>x</code> and <code>y</code> of type - <code>Any</code>, <code>x.equals(y)</code> should return <code>true</code> if and only - if <code>y.equals(x)</code> returns <code>true</code>.</li> - <li>It is transitive: for any instances - <code>x</code>, <code>y</code>, and <code>z</code> of type <code>AnyRef</code> - if <code>x.equals(y)</code> returns <code>true</code> and - <code>y.equals(z)</code> returns - <code>true</code>, then <code>x.equals(z)</code> should return <code>true</code>.</li> -</ul> -</p></p><p><p> -If you override this method, you should verify that -your implementation remains an equivalence relation. -Additionally, when overriding this method it is often necessary to -override <code>hashCode</code> to ensure that objects that are -"equal" (<code>o1.equals(o2)</code> returns <code>true</code>) -hash to the same <a href="Int.html"><code>Int</code></a> -(<code>o1.hashCode.equals(o2.hashCode)</code>). -</p></div> - <dl class="paramcmts block"><dt class="param">arg0</dt><dd class="cmt"><p>the object to compare against this object for equality.</p></dd><dt>returns</dt><dd class="cmt"><p><code>true</code> if the receiver object is equivalent to the argument; <code>false</code> otherwise. -</p></p></dd></dl> - - <div class="block"> - definition classes: AnyRef ⇐ Any - </div> - - </div> - </li><li name="scala.AnyRef#hashCode"> - <h4 class="signature"> - <span class="kind">def</span> - <span class="symbol"> - <span class="name">hashCode</span><span class="params">()</span><span class="result">: <span class="extype" name="scala.Int">Int</span></span> - </span> - </h4> - <p class="shortcomment cmt">Returns a hash code value for the object</p><div class="fullcomment"> - <div class="comment cmt"><p>Returns a hash code value for the object.</p><p><p> -The default hashing algorithm is platform dependent.</p><p>Note that it is allowed for two objects to have identical hash -codes (<code>o1.hashCode.equals(o2.hashCode)</code>) yet not be -equal (<code>o1.equals(o2)</code> returns <code>false</code>). A -degenerate implementation could always return <code>0</code>. -However, it is required that if two objects are equal -(<code>o1.equals(o2)</code> returns <code>true</code>) that they -have identical hash codes -(<code>o1.hashCode.equals(o2.hashCode)</code>). Therefore, when -overriding this method, be sure to verify that the behavior is -consistent with the <code>equals</code> method. -</p></p><p><p></p></div> - - - <div class="block"> - definition classes: AnyRef ⇐ Any - </div> - - </div> - </li><li name="sims.collision.Collision#normal"> - <h4 class="signature"> - <span class="kind">val</span> - <span class="symbol"> - <span class="name">normal</span><span class="result">: <a href="../geometry/Vector2D.html" class="extype" name="sims.geometry.Vector2D">Vector2D</a></span> - </span> - </h4> - <p class="shortcomment cmt">Normal vector to the collision face</p><div class="fullcomment"> - <div class="comment cmt"><p>Normal vector to the collision face.</p></div> - - <div class="block"> - attributes: abstract - </div> - - - </div> - </li><li name="sims.collision.Collision#points"> - <h4 class="signature"> - <span class="kind">val</span> - <span class="symbol"> - <span class="name">points</span><span class="result">: <span class="extype" name="scala.collection.Iterable">Iterable</span>[<a href="../geometry/Vector2D.html" class="extype" name="sims.geometry.Vector2D">Vector2D</a>]</span> - </span> - </h4> - <p class="shortcomment cmt">Collision points</p><div class="fullcomment"> - <div class="comment cmt"><p>Collision points.</p></div> - - <div class="block"> - attributes: abstract - </div> - - - </div> - </li><li name="sims.collision.Collision#shape1"> - <h4 class="signature"> - <span class="kind">val</span> - <span class="symbol"> - <span class="name">shape1</span><span class="result">: <a href="../dynamics/Shape.html" class="extype" name="sims.dynamics.Shape">Shape</a></span> - </span> - </h4> - <p class="shortcomment cmt">First colliding shape (reference shape)</p><div class="fullcomment"> - <div class="comment cmt"><p>First colliding shape (reference shape).</p></div> - - <div class="block"> - attributes: abstract - </div> - - - </div> - </li><li name="sims.collision.Collision#shape2"> - <h4 class="signature"> - <span class="kind">val</span> - <span class="symbol"> - <span class="name">shape2</span><span class="result">: <a href="../dynamics/Shape.html" class="extype" name="sims.dynamics.Shape">Shape</a></span> - </span> - </h4> - <p class="shortcomment cmt">Second colliding shape (incident shape)</p><div class="fullcomment"> - <div class="comment cmt"><p>Second colliding shape (incident shape).</p></div> - - <div class="block"> - attributes: abstract - </div> - - - </div> - </li><li name="scala.AnyRef#toString"> - <h4 class="signature"> - <span class="kind">def</span> - <span class="symbol"> - <span class="name">toString</span><span class="params">()</span><span class="result">: <span class="extype" name="java.lang.String">String</span></span> - </span> - </h4> - <p class="shortcomment cmt">Returns a string representation of the object</p><div class="fullcomment"> - <div class="comment cmt"><p>Returns a string representation of the object. -<p> -The default representation is platform dependent. -</p></div> - - - <div class="block"> - definition classes: AnyRef ⇐ Any - </div> - - </div> - </li></ol> - </div> - - <div class="members" id="constructors"> - <h3>Instance constructors</h3> - <ol><li name="sims.collision.Collision#this"> - <h4 class="signature"> - <span class="kind">new</span> - <span class="symbol"> - <span class="name">Collision</span><span class="params">()</span> - </span> - </h4> - - </li></ol> - </div> - - </div> - - </body> - </html>
\ No newline at end of file diff --git a/doc/sims/collision/Detector.html b/doc/sims/collision/Detector.html deleted file mode 100644 index c858df8..0000000 --- a/doc/sims/collision/Detector.html +++ /dev/null @@ -1,195 +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.collision.Detector</title> - <meta http-equiv="content-type" content="text/html; charset=UTF-8" /> - <script type="text/javascript" src="../../lib/jquery.js"></script> - - <style type="text/css"> - @import url(../../lib/template.css) screen; - </style> - <script type="text/javascript" src="../../lib/template.js"></script> - - </head> - <body class="type"> - - <p id="owner"><a href="../package.html">sims</a>.<a href="package.html">collision</a></p> - - <div id="definition"> - <img src="../../lib/class_big.png" /> - <h1>Detector</h1> - </div> - - <h4 class="signature"> - <span class="kind">class</span> - <span class="symbol"> - <span class="name">Detector</span><span class="result"> extends AnyRef</span> - </span> - </h4> - <div class="fullcomment" id="comment"> - <div class="comment cmt"><p>A world detects its collisions through concrete implementations of this class.</p></div> - - <div class="block"> - attributes: abstract - </div> - - <div class="block"> - known subclasses: <a href="GridDetector.html">GridDetector</a> - </div> - </div> - - <div id="template"> - - <div id="mbrsel"> - <div id="ancestors"> - <h3>Inherits</h3> - <ol><li class="in" name="scala.AnyRef">AnyRef</li><li class="in" name="scala.Any">Any</li></ol> - </div> - </div> - - - - <div class="members" id="values"> - <h3>Value Members</h3> - <ol><li name="sims.collision.Detector#collisions"> - <h4 class="signature"> - <span class="kind">def</span> - <span class="symbol"> - <span class="name">collisions</span><span class="result">: <span class="extype" name="scala.collection.Seq">Seq</span>[<a href="Collision.html" class="extype" name="sims.collision.Collision">Collision</a>]</span> - </span> - </h4> - <p class="shortcomment cmt">Returns all collisions between shapes in the world <code>world</code></p><div class="fullcomment"> - <div class="comment cmt"><p>Returns all collisions between shapes in the world <code>world</code>.</p></div> - - <div class="block"> - attributes: abstract - </div> - - - </div> - </li><li name="scala.AnyRef#equals"> - <h4 class="signature"> - <span class="kind">def</span> - <span class="symbol"> - <span class="name">equals</span><span class="params">(<span name="arg0">arg0: <span class="extype" name="scala.Any">Any</span></span>)</span><span class="result">: <span class="extype" name="scala.Boolean">Boolean</span></span> - </span> - </h4> - <p class="shortcomment cmt">This method is used to compare the receiver object (<code>this</code>) -with the argument object (<code>arg0</code>) for equivalence</p><div class="fullcomment"> - <div class="comment cmt"><p>This method is used to compare the receiver object (<code>this</code>) -with the argument object (<code>arg0</code>) for equivalence.</p><p><p> -The default implementations of this method is an <a -href="http://en.wikipedia.org/wiki/Equivalence_relation">equivalence -relation</a>: - <ul> - <li>It is reflexive: for any instance <code>x</code> of type <code>Any</code>, - <code>x.equals(x)</code> should return <code>true</code>.</li> - <li>It is symmetric: for any instances <code>x</code> and <code>y</code> of type - <code>Any</code>, <code>x.equals(y)</code> should return <code>true</code> if and only - if <code>y.equals(x)</code> returns <code>true</code>.</li> - <li>It is transitive: for any instances - <code>x</code>, <code>y</code>, and <code>z</code> of type <code>AnyRef</code> - if <code>x.equals(y)</code> returns <code>true</code> and - <code>y.equals(z)</code> returns - <code>true</code>, then <code>x.equals(z)</code> should return <code>true</code>.</li> -</ul> -</p></p><p><p> -If you override this method, you should verify that -your implementation remains an equivalence relation. -Additionally, when overriding this method it is often necessary to -override <code>hashCode</code> to ensure that objects that are -"equal" (<code>o1.equals(o2)</code> returns <code>true</code>) -hash to the same <a href="Int.html"><code>Int</code></a> -(<code>o1.hashCode.equals(o2.hashCode)</code>). -</p></div> - <dl class="paramcmts block"><dt class="param">arg0</dt><dd class="cmt"><p>the object to compare against this object for equality.</p></dd><dt>returns</dt><dd class="cmt"><p><code>true</code> if the receiver object is equivalent to the argument; <code>false</code> otherwise. -</p></p></dd></dl> - - <div class="block"> - definition classes: AnyRef ⇐ Any - </div> - - </div> - </li><li name="scala.AnyRef#hashCode"> - <h4 class="signature"> - <span class="kind">def</span> - <span class="symbol"> - <span class="name">hashCode</span><span class="params">()</span><span class="result">: <span class="extype" name="scala.Int">Int</span></span> - </span> - </h4> - <p class="shortcomment cmt">Returns a hash code value for the object</p><div class="fullcomment"> - <div class="comment cmt"><p>Returns a hash code value for the object.</p><p><p> -The default hashing algorithm is platform dependent.</p><p>Note that it is allowed for two objects to have identical hash -codes (<code>o1.hashCode.equals(o2.hashCode)</code>) yet not be -equal (<code>o1.equals(o2)</code> returns <code>false</code>). A -degenerate implementation could always return <code>0</code>. -However, it is required that if two objects are equal -(<code>o1.equals(o2)</code> returns <code>true</code>) that they -have identical hash codes -(<code>o1.hashCode.equals(o2.hashCode)</code>). Therefore, when -overriding this method, be sure to verify that the behavior is -consistent with the <code>equals</code> method. -</p></p><p><p></p></div> - - - <div class="block"> - definition classes: AnyRef ⇐ Any - </div> - - </div> - </li><li name="scala.AnyRef#toString"> - <h4 class="signature"> - <span class="kind">def</span> - <span class="symbol"> - <span class="name">toString</span><span class="params">()</span><span class="result">: <span class="extype" name="java.lang.String">String</span></span> - </span> - </h4> - <p class="shortcomment cmt">Returns a string representation of the object</p><div class="fullcomment"> - <div class="comment cmt"><p>Returns a string representation of the object. -<p> -The default representation is platform dependent. -</p></div> - - - <div class="block"> - definition classes: AnyRef ⇐ Any - </div> - - </div> - </li><li name="sims.collision.Detector#world"> - <h4 class="signature"> - <span class="kind">val</span> - <span class="symbol"> - <span class="name">world</span><span class="result">: <a href="../dynamics/World.html" class="extype" name="sims.dynamics.World">World</a></span> - </span> - </h4> - <p class="shortcomment cmt">The world whose shapes are to be checked for collisions</p><div class="fullcomment"> - <div class="comment cmt"><p>The world whose shapes are to be checked for collisions.</p></div> - - <div class="block"> - attributes: abstract - </div> - - - </div> - </li></ol> - </div> - - <div class="members" id="constructors"> - <h3>Instance constructors</h3> - <ol><li name="sims.collision.Detector#this"> - <h4 class="signature"> - <span class="kind">new</span> - <span class="symbol"> - <span class="name">Detector</span><span class="params">()</span> - </span> - </h4> - - </li></ol> - </div> - - </div> - - </body> - </html>
\ No newline at end of file diff --git a/doc/sims/collision/GridDetector.html b/doc/sims/collision/GridDetector.html deleted file mode 100644 index 6cdaad7..0000000 --- a/doc/sims/collision/GridDetector.html +++ /dev/null @@ -1,317 +0,0 @@ -<?xml version='1.0' encoding='UTF-8'?> -<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.1//EN" "http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd"> -<html> - <head> - <title>Scaladoc for sims.collision.GridDetector</title> - <meta http-equiv="content-type" content="text/html; charset=UTF-8" /> - <script type="text/javascript" src="../../lib/jquery.js"></script> - - <style type="text/css"> - @import url(../../lib/template.css) screen; - </style> - <script type="text/javascript" src="../../lib/template.js"></script> - - </head> - <body class="type"> - - <p id="owner"><a href="../package.html">sims</a>.<a href="package.html">collision</a></p> - - <div id="definition"> - <img src="../../lib/class_big.png" /> - <h1>GridDetector</h1> - </div> - - <h4 class="signature"> - <span class="kind">class</span> - <span class="symbol"> - <span class="name">GridDetector</span><span class="result"> extends <a href="Detector.html" class="extype" name="sims.collision.Detector">Detector</a></span> - </span> - </h4> - <div class="fullcomment" id="comment"> - <div class="comment cmt"><p>A conrete implementation of <code>Detector</code>. <code>GridDetector</code> divides the world into a grid -for faster collision detection.</p></div> - - - - - </div> - - <div id="template"> - - <div id="mbrsel"> - <div id="ancestors"> - <h3>Inherits</h3> - <ol><li class="in" name="sims.collision.Detector">Detector</li><li class="in" name="scala.AnyRef">AnyRef</li><li class="in" name="scala.Any">Any</li></ol> - </div> - </div> - - - - <div class="members" id="values"> - <h3>Value Members</h3> - <ol><li name="sims.collision.GridDetector#colliding"> - <h4 class="signature"> - <span class="kind">def</span> - <span class="symbol"> - <span class="name">colliding</span><span class="params">(<span name="p">p: <a href="Pair.html" class="extype" name="sims.collision.Pair">Pair</a></span>)</span><span class="result">: <span class="extype" name="scala.Boolean">Boolean</span></span> - </span> - </h4> - <p class="shortcomment cmt">Checks the pair of shapes <code>p</code> for collision</p><div class="fullcomment"> - <div class="comment cmt"><p>Checks the pair of shapes <code>p</code> for collision.</p></div> - <dl class="paramcmts block"><dt class="param">p</dt><dd class="cmt"><p>Pair of shapes.</p></dd></dl> - - - - </div> - </li><li name="sims.collision.GridDetector#collidingPairs"> - <h4 class="signature"> - <span class="kind">def</span> - <span class="symbol"> - <span class="name">collidingPairs</span><span class="result">: <span class="extype" name="scala.collection.Seq">Seq</span>[<a href="Pair.html" class="extype" name="sims.collision.Pair">Pair</a>]</span> - </span> - </h4> - <p class="shortcomment cmt">Returns all colliding pairs</p><div class="fullcomment"> - <div class="comment cmt"><p>Returns all colliding pairs.</p></div> - - - - - </div> - </li><li name="sims.collision.GridDetector#collision"> - <h4 class="signature"> - <span class="kind">def</span> - <span class="symbol"> - <span class="name">collision</span><span class="params">(<span name="p">p: <a href="Pair.html" class="extype" name="sims.collision.Pair">Pair</a></span>)</span><span class="result">: <a href="Collision.html" class="extype" name="sims.collision.Collision">Collision</a></span> - </span> - </h4> - <p class="shortcomment cmt">Returns the collision between both shapes of the pair <code>p</code></p><div class="fullcomment"> - <div class="comment cmt"><p>Returns the collision between both shapes of the pair <code>p</code>.</p></div> - <dl class="paramcmts block"><dt class="param">p</dt><dd class="cmt"><p>Pair of shapes.</p></dd></dl> - - - - </div> - </li><li name="sims.collision.GridDetector#collisionMethods"> - <h4 class="signature"> - <span class="kind">val</span> - <span class="symbol"> - <span class="name">collisionMethods</span><span class="result">: <span class="extype" name="scala.collection.mutable.ArrayBuffer">ArrayBuffer</span>[<span class="extype" name="scala.PartialFunction">PartialFunction</span>[(<a href="../dynamics/Shape.html" class="extype" name="sims.dynamics.Shape">Shape</a>, <a href="../dynamics/Shape.html" class="extype" name="sims.dynamics.Shape">Shape</a>), <a href="Collision.html" class="extype" name="sims.collision.Collision">Collision</a>]]</span> - </span> - </h4> - <p class="shortcomment cmt">Array of methods returning collisions</p><div class="fullcomment"> - <div class="comment cmt"><p>Array of methods returning collisions. It is assumed that both shapes are colliding.</p></div> - - - - - </div> - </li><li name="sims.collision.GridDetector#collisions"> - <h4 class="signature"> - <span class="kind">def</span> - <span class="symbol"> - <span class="name">collisions</span><span class="result">: <span class="extype" name="scala.collection.Seq">Seq</span>[<a href="Collision.html" class="extype" name="sims.collision.Collision">Collision</a>]</span> - </span> - </h4> - <p class="shortcomment cmt">Returns all collisions</p><div class="fullcomment"> - <div class="comment cmt"><p>Returns all collisions.</p></div> - - - - - </div> - </li><li name="sims.collision.GridDetector#detectionMethods"> - <h4 class="signature"> - <span class="kind">val</span> - <span class="symbol"> - <span class="name">detectionMethods</span><span class="result">: <span class="extype" name="scala.collection.mutable.ArrayBuffer">ArrayBuffer</span>[<span class="extype" name="scala.PartialFunction">PartialFunction</span>[(<a href="../dynamics/Shape.html" class="extype" name="sims.dynamics.Shape">Shape</a>, <a href="../dynamics/Shape.html" class="extype" name="sims.dynamics.Shape">Shape</a>), <span class="extype" name="scala.Boolean">Boolean</span>]]</span> - </span> - </h4> - <p class="shortcomment cmt">Array of collision detection methods</p><div class="fullcomment"> - <div class="comment cmt"><p>Array of collision detection methods. These methods return <code>true</code> if two shapes are colliding.</p></div> - - - - - </div> - </li><li name="scala.AnyRef#equals"> - <h4 class="signature"> - <span class="kind">def</span> - <span class="symbol"> - <span class="name">equals</span><span class="params">(<span name="arg0">arg0: <span class="extype" name="scala.Any">Any</span></span>)</span><span class="result">: <span class="extype" name="scala.Boolean">Boolean</span></span> - </span> - </h4> - <p class="shortcomment cmt">This method is used to compare the receiver object (<code>this</code>) -with the argument object (<code>arg0</code>) for equivalence</p><div class="fullcomment"> - <div class="comment cmt"><p>This method is used to compare the receiver object (<code>this</code>) -with the argument object (<code>arg0</code>) for equivalence.</p><p><p> -The default implementations of this method is an <a -href="http://en.wikipedia.org/wiki/Equivalence_relation">equivalence -relation</a>: - <ul> - <li>It is reflexive: for any instance <code>x</code> of type <code>Any</code>, - <code>x.equals(x)</code> should return <code>true</code>.</li> - <li>It is symmetric: for any instances <code>x</code> and <code>y</code> of type - <code>Any</code>, <code>x.equals(y)</code> should return <code>true</code> if and only - if <code>y.equals(x)</code> returns <code>true</code>.</li> - <li>It is transitive: for any instances - <code>x</code>, <code>y</code>, and <code>z</code> of type <code>AnyRef</code> - if <code>x.equals(y)</code> returns <code>true</code> and - <code>y.equals(z)</code> returns - <code>true</code>, then <code>x.equals(z)</code> should return <code>true</code>.</li> -</ul> -</p></p><p><p> -If you override this method, you should verify that -your implementation remains an equivalence relation. -Additionally, when overriding this method it is often necessary to -override <code>hashCode</code> to ensure that objects that are -"equal" (<code>o1.equals(o2)</code> returns <code>true</code>) -hash to the same <a href="Int.html"><code>Int</code></a> -(<code>o1.hashCode.equals(o2.hashCode)</code>). -</p></div> - <dl class="paramcmts block"><dt class="param">arg0</dt><dd class="cmt"><p>the object to compare against this object for equality.</p></dd><dt>returns</dt><dd class="cmt"><p><code>true</code> if the receiver object is equivalent to the argument; <code>false</code> otherwise. -</p></p></dd></dl> - - <div class="block"> - definition classes: AnyRef ⇐ Any - </div> - - </div> - </li><li name="sims.collision.GridDetector#getPairs"> - <h4 class="signature"> - <span class="kind">def</span> - <span class="symbol"> - <span class="name">getPairs</span><span class="result">: <span class="extype" name="scala.collection.Seq">Seq</span>[<a href="Pair.html" class="extype" name="sims.collision.Pair">Pair</a>]</span> - </span> - </h4> - <p class="shortcomment cmt">Returns potential colliding pairs of shapes of the world <code>world</code></p><div class="fullcomment"> - <div class="comment cmt"><p>Returns potential colliding pairs of shapes of the world <code>world</code>. -<p> -A potential colliding pair is a pair of two shapes that comply with the following criteria: -<ul> -<li>The shapes are situated in the same grid cell.</li> -<li>Their AABBs overlap.</li> -<li>The shapes do not belong to the same body.</li> -<li>At least one shape is not fixed.</li> -<li>Both shapes are {@link dynamics.Shape#collidable}.</li> -</ul></p></div> - - - - - </div> - </li><li name="sims.collision.GridDetector#gridSide"> - <h4 class="signature"> - <span class="kind">var</span> - <span class="symbol"> - <span class="name">gridSide</span><span class="result">: <span class="extype" name="scala.Double">Double</span></span> - </span> - </h4> - <p class="shortcomment cmt">Width and height of a grid cell</p><div class="fullcomment"> - <div class="comment cmt"><p>Width and height of a grid cell.</p></div> - - - - - </div> - </li><li name="scala.AnyRef#hashCode"> - <h4 class="signature"> - <span class="kind">def</span> - <span class="symbol"> - <span class="name">hashCode</span><span class="params">()</span><span class="result">: <span class="extype" name="scala.Int">Int</span></span> - </span> - </h4> - <p class="shortcomment cmt">Returns a hash code value for the object</p><div class="fullcomment"> - <div class="comment cmt"><p>Returns a hash code value for the object.</p><p><p> -The default hashing algorithm is platform dependent.</p><p>Note that it is allowed for two objects to have identical hash -codes (<code>o1.hashCode.equals(o2.hashCode)</code>) yet not be -equal (<code>o1.equals(o2)</code> returns <code>false</code>). A -degenerate implementation could always return <code>0</code>. -However, it is required that if two objects are equal -(<code>o1.equals(o2)</code> returns <code>true</code>) that they -have identical hash codes -(<code>o1.hashCode.equals(o2.hashCode)</code>). Therefore, when -overriding this method, be sure to verify that the behavior is -consistent with the <code>equals</code> method. -</p></p><p><p></p></div> - - - <div class="block"> - definition classes: AnyRef ⇐ Any - </div> - - </div> - </li><li name="sims.collision.GridDetector#pairs"> - <h4 class="signature"> - <span class="kind">def</span> - <span class="symbol"> - <span class="name">pairs</span><span class="result">: <span class="extype" name="scala.collection.Seq">Seq</span>[<a href="Pair.html" class="extype" name="sims.collision.Pair">Pair</a>]</span> - </span> - </h4> - <p class="shortcomment cmt">All potential colliding pairs of the world</p><div class="fullcomment"> - <div class="comment cmt"><p>All potential colliding pairs of the world.</p></div> - - - - - </div> - </li><li name="scala.AnyRef#toString"> - <h4 class="signature"> - <span class="kind">def</span> - <span class="symbol"> - <span class="name">toString</span><span class="params">()</span><span class="result">: <span class="extype" name="java.lang.String">String</span></span> - </span> - </h4> - <p class="shortcomment cmt">Returns a string representation of the object</p><div class="fullcomment"> - <div class="comment cmt"><p>Returns a string representation of the object. -<p> -The default representation is platform dependent. -</p></div> - - - <div class="block"> - definition classes: AnyRef ⇐ Any - </div> - - </div> - </li><li name="sims.collision.GridDetector#world"> - <h4 class="signature"> - <span class="kind">val</span> - <span class="symbol"> - <span class="name">world</span><span class="result">: <a href="../dynamics/World.html" class="extype" name="sims.dynamics.World">World</a></span> - </span> - </h4> - <p class="shortcomment cmt">The world whose shapes are to be checked for collisions</p><div class="fullcomment"> - <div class="comment cmt"><p>The world whose shapes are to be checked for collisions.</p></div> - - - - - </div> - </li></ol> - </div> - - <div class="members" id="constructors"> - <h3>Instance constructors</h3> - <ol><li name="sims.collision.GridDetector#this"> - <h4 class="signature"> - <span class="kind">new</span> - <span class="symbol"> - <span class="name">GridDetector</span><span class="params">(<span name="world">world: <a href="../dynamics/World.html" class="extype" name="sims.dynamics.World">World</a></span>)</span> - </span> - </h4> - - </li><li name="sims.collision.Detector#this"> - <h4 class="signature"> - <span class="kind">new</span> - <span class="symbol"> - <span class="name">GridDetector</span><span class="params">()</span> - </span> - </h4> - - </li></ol> - </div> - - </div> - - </body> - </html>
\ No newline at end of file diff --git a/doc/sims/collision/Overlap.html b/doc/sims/collision/Overlap.html deleted file mode 100644 index b6f9960..0000000 --- a/doc/sims/collision/Overlap.html +++ /dev/null @@ -1,233 +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.collision.Overlap</title> - <meta http-equiv="content-type" content="text/html; charset=UTF-8" /> - <script type="text/javascript" src="../../lib/jquery.js"></script> - - <style type="text/css"> - @import url(../../lib/template.css) screen; - </style> - <script type="text/javascript" src="../../lib/template.js"></script> - - </head> - <body class="type"> - - <p id="owner"><a href="../package.html">sims</a>.<a href="package.html">collision</a></p> - - <div id="definition"> - <img src="../../lib/class_big.png" /> - <h1>Overlap</h1> - </div> - - <h4 class="signature"> - <span class="kind">class</span> - <span class="symbol"> - <span class="name">Overlap</span><span class="params">(<span name="poly">poly: <a href="../geometry/ConvexPolygon.html" class="extype" name="sims.geometry.ConvexPolygon">ConvexPolygon</a></span>, <span name="sideNum">sideNum: <span class="extype" name="scala.Int">Int</span></span>, <span name="overlap">overlap: <span class="extype" name="scala.Double">Double</span></span>)</span><span class="result"> extends <span class="extype" name="scala.Product">Product</span></span> - </span> - </h4> - <div class="fullcomment" id="comment"> - - - - - - </div> - - <div id="template"> - - <div id="mbrsel"> - <div id="ancestors"> - <h3>Inherits</h3> - <ol><li class="in" name="scala.Product">Product</li><li class="in" name="scala.Equals">Equals</li><li class="in" name="scala.AnyRef">AnyRef</li><li class="in" name="scala.Any">Any</li></ol> - </div> - </div> - - - - <div class="members" id="values"> - <h3>Value Members</h3> - <ol><li name="sims.collision.Overlap#canEqual"> - <h4 class="signature"> - <span class="kind">def</span> - <span class="symbol"> - <span class="name">canEqual</span><span class="params">(<span name="arg0">arg0: <span class="extype" name="scala.Any">Any</span></span>)</span><span class="result">: <span class="extype" name="scala.Boolean">Boolean</span></span> - </span> - </h4> - - </li><li name="sims.collision.Overlap#equals"> - <h4 class="signature"> - <span class="kind">def</span> - <span class="symbol"> - <span class="name">equals</span><span class="params">(<span name="arg0">arg0: <span class="extype" name="scala.Any">Any</span></span>)</span><span class="result">: <span class="extype" name="scala.Boolean">Boolean</span></span> - </span> - </h4> - <p class="shortcomment cmt">This method is used to compare the receiver object (<code>this</code>) -with the argument object (<code>arg0</code>) for equivalence</p><div class="fullcomment"> - <div class="comment cmt"><p>This method is used to compare the receiver object (<code>this</code>) -with the argument object (<code>arg0</code>) for equivalence.</p><p><p> -The default implementations of this method is an <a -href="http://en.wikipedia.org/wiki/Equivalence_relation">equivalence -relation</a>: - <ul> - <li>It is reflexive: for any instance <code>x</code> of type <code>Any</code>, - <code>x.equals(x)</code> should return <code>true</code>.</li> - <li>It is symmetric: for any instances <code>x</code> and <code>y</code> of type - <code>Any</code>, <code>x.equals(y)</code> should return <code>true</code> if and only - if <code>y.equals(x)</code> returns <code>true</code>.</li> - <li>It is transitive: for any instances - <code>x</code>, <code>y</code>, and <code>z</code> of type <code>AnyRef</code> - if <code>x.equals(y)</code> returns <code>true</code> and - <code>y.equals(z)</code> returns - <code>true</code>, then <code>x.equals(z)</code> should return <code>true</code>.</li> -</ul> -</p></p><p><p> -If you override this method, you should verify that -your implementation remains an equivalence relation. -Additionally, when overriding this method it is often necessary to -override <code>hashCode</code> to ensure that objects that are -"equal" (<code>o1.equals(o2)</code> returns <code>true</code>) -hash to the same <a href="Int.html"><code>Int</code></a> -(<code>o1.hashCode.equals(o2.hashCode)</code>). -</p></div> - <dl class="paramcmts block"><dt class="param">arg0</dt><dd class="cmt"><p>the object to compare against this object for equality.</p></dd><dt>returns</dt><dd class="cmt"><p><code>true</code> if the receiver object is equivalent to the argument; <code>false</code> otherwise. -</p></p></dd></dl> - - - - </div> - </li><li name="sims.collision.Overlap#hashCode"> - <h4 class="signature"> - <span class="kind">def</span> - <span class="symbol"> - <span class="name">hashCode</span><span class="params">()</span><span class="result">: <span class="extype" name="scala.Int">Int</span></span> - </span> - </h4> - <p class="shortcomment cmt">Returns a hash code value for the object</p><div class="fullcomment"> - <div class="comment cmt"><p>Returns a hash code value for the object.</p><p><p> -The default hashing algorithm is platform dependent.</p><p>Note that it is allowed for two objects to have identical hash -codes (<code>o1.hashCode.equals(o2.hashCode)</code>) yet not be -equal (<code>o1.equals(o2)</code> returns <code>false</code>). A -degenerate implementation could always return <code>0</code>. -However, it is required that if two objects are equal -(<code>o1.equals(o2)</code> returns <code>true</code>) that they -have identical hash codes -(<code>o1.hashCode.equals(o2.hashCode)</code>). Therefore, when -overriding this method, be sure to verify that the behavior is -consistent with the <code>equals</code> method. -</p></p><p><p></p></div> - - - - - </div> - </li><li name="sims.collision.Overlap#overlap"> - <h4 class="signature"> - <span class="kind">val</span> - <span class="symbol"> - <span class="name">overlap</span><span class="result">: <span class="extype" name="scala.Double">Double</span></span> - </span> - </h4> - - </li><li name="sims.collision.Overlap#poly"> - <h4 class="signature"> - <span class="kind">val</span> - <span class="symbol"> - <span class="name">poly</span><span class="result">: <a href="../geometry/ConvexPolygon.html" class="extype" name="sims.geometry.ConvexPolygon">ConvexPolygon</a></span> - </span> - </h4> - - </li><li name="sims.collision.Overlap#productArity"> - <h4 class="signature"> - <span class="kind">def</span> - <span class="symbol"> - <span class="name">productArity</span><span class="result">: <span class="extype" name="scala.Int">Int</span></span> - </span> - </h4> - - </li><li name="sims.collision.Overlap#productElement"> - <h4 class="signature"> - <span class="kind">def</span> - <span class="symbol"> - <span class="name">productElement</span><span class="params">(<span name="arg0">arg0: <span class="extype" name="scala.Int">Int</span></span>)</span><span class="result">: <span class="extype" name="scala.Any">Any</span></span> - </span> - </h4> - - </li><li name="scala.Product#productElements"> - <h4 class="signature"> - <span class="kind">def</span> - <span class="symbol"> - <span class="name">productElements</span><span class="result">: <span class="extype" name="scala.collection.Iterator">Iterator</span>[<span class="extype" name="scala.Any">Any</span>]</span> - </span> - </h4> - - </li><li name="scala.Product#productIterator"> - <h4 class="signature"> - <span class="kind">def</span> - <span class="symbol"> - <span class="name">productIterator</span><span class="result">: <span class="extype" name="scala.collection.Iterator">Iterator</span>[<span class="extype" name="scala.Any">Any</span>]</span> - </span> - </h4> - - </li><li name="sims.collision.Overlap#productPrefix"> - <h4 class="signature"> - <span class="kind">def</span> - <span class="symbol"> - <span class="name">productPrefix</span><span class="result">: <span class="extype" name="java.lang.String">String</span></span> - </span> - </h4> - - </li><li name="sims.collision.Overlap#sideNum"> - <h4 class="signature"> - <span class="kind">val</span> - <span class="symbol"> - <span class="name">sideNum</span><span class="result">: <span class="extype" name="scala.Int">Int</span></span> - </span> - </h4> - - </li><li name="sims.collision.Overlap#toString"> - <h4 class="signature"> - <span class="kind">def</span> - <span class="symbol"> - <span class="name">toString</span><span class="params">()</span><span class="result">: <span class="extype" name="java.lang.String">String</span></span> - </span> - </h4> - <p class="shortcomment cmt">Returns a string representation of the object</p><div class="fullcomment"> - <div class="comment cmt"><p>Returns a string representation of the object. -<p> -The default representation is platform dependent. -</p></div> - - - - - </div> - </li></ol> - </div> - - <div class="members" id="constructors"> - <h3>Instance constructors</h3> - <ol><li name="sims.collision.Overlap#this"> - <h4 class="signature"> - <span class="kind">new</span> - <span class="symbol"> - <span class="name">Overlap</span><span class="params">(<span name="poly">poly: <a href="../geometry/ConvexPolygon.html" class="extype" name="sims.geometry.ConvexPolygon">ConvexPolygon</a></span>, <span name="sideNum">sideNum: <span class="extype" name="scala.Int">Int</span></span>, <span name="overlap">overlap: <span class="extype" name="scala.Double">Double</span></span>)</span> - </span> - </h4> - - </li><li name="scala.AnyRef#this"> - <h4 class="signature"> - <span class="kind">new</span> - <span class="symbol"> - <span class="name">Overlap</span><span class="params">()</span> - </span> - </h4> - - </li></ol> - </div> - - </div> - - </body> - </html>
\ No newline at end of file diff --git a/doc/sims/collision/Pair.html b/doc/sims/collision/Pair.html deleted file mode 100644 index af5a434..0000000 --- a/doc/sims/collision/Pair.html +++ /dev/null @@ -1,274 +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.collision.Pair</title> - <meta http-equiv="content-type" content="text/html; charset=UTF-8" /> - <script type="text/javascript" src="../../lib/jquery.js"></script> - - <style type="text/css"> - @import url(../../lib/template.css) screen; - </style> - <script type="text/javascript" src="../../lib/template.js"></script> - - </head> - <body class="type"> - - <p id="owner"><a href="../package.html">sims</a>.<a href="package.html">collision</a></p> - - <div id="definition"> - <img src="../../lib/class_big.png" /> - <h1>Pair</h1> - </div> - - <h4 class="signature"> - <span class="kind">class</span> - <span class="symbol"> - <span class="name">Pair</span><span class="params">(<span name="s1">s1: <a href="../dynamics/Shape.html" class="extype" name="sims.dynamics.Shape">Shape</a></span>, <span name="s2">s2: <a href="../dynamics/Shape.html" class="extype" name="sims.dynamics.Shape">Shape</a></span>)</span><span class="result"> extends (<a href="../dynamics/Shape.html" class="extype" name="sims.dynamics.Shape">Shape</a>, <a href="../dynamics/Shape.html" class="extype" name="sims.dynamics.Shape">Shape</a>) with <span class="extype" name="scala.Product">Product</span></span> - </span> - </h4> - <div class="fullcomment" id="comment"> - <div class="comment cmt"><p>Pair of shapes.</p></div> - - - - - </div> - - <div id="template"> - - <div id="mbrsel"> - <div id="ancestors"> - <h3>Inherits</h3> - <ol><li class="in" name="scala.Tuple2">Tuple2</li><li class="in" name="scala.Product2">Product2</li><li class="in" name="scala.Product">Product</li><li class="in" name="scala.Equals">Equals</li><li class="in" name="scala.AnyRef">AnyRef</li><li class="in" name="scala.Any">Any</li></ol> - </div> - </div> - - - - <div class="members" id="values"> - <h3>Value Members</h3> - <ol><li name="scala.Tuple2#_1"> - <h4 class="signature"> - <span class="kind">val</span> - <span class="symbol"> - <span class="name">_1</span><span class="result">: <a href="../dynamics/Shape.html" class="extype" name="sims.dynamics.Shape">Shape</a></span> - </span> - </h4> - - </li><li name="scala.Tuple2#_2"> - <h4 class="signature"> - <span class="kind">val</span> - <span class="symbol"> - <span class="name">_2</span><span class="result">: <a href="../dynamics/Shape.html" class="extype" name="sims.dynamics.Shape">Shape</a></span> - </span> - </h4> - - </li><li name="sims.collision.Pair#canEqual"> - <h4 class="signature"> - <span class="kind">def</span> - <span class="symbol"> - <span class="name">canEqual</span><span class="params">(<span name="arg0">arg0: <span class="extype" name="scala.Any">Any</span></span>)</span><span class="result">: <span class="extype" name="scala.Boolean">Boolean</span></span> - </span> - </h4> - - </li><li name="sims.collision.Pair#equals"> - <h4 class="signature"> - <span class="kind">def</span> - <span class="symbol"> - <span class="name">equals</span><span class="params">(<span name="other">other: <span class="extype" name="scala.Any">Any</span></span>)</span><span class="result">: <span class="extype" name="scala.Boolean">Boolean</span></span> - </span> - </h4> - <p class="shortcomment cmt">This method is used to compare the receiver object (<code>this</code>) -with the argument object (<code>arg0</code>) for equivalence</p><div class="fullcomment"> - <div class="comment cmt"><p>This method is used to compare the receiver object (<code>this</code>) -with the argument object (<code>arg0</code>) for equivalence.</p><p><p> -The default implementations of this method is an <a -href="http://en.wikipedia.org/wiki/Equivalence_relation">equivalence -relation</a>: - <ul> - <li>It is reflexive: for any instance <code>x</code> of type <code>Any</code>, - <code>x.equals(x)</code> should return <code>true</code>.</li> - <li>It is symmetric: for any instances <code>x</code> and <code>y</code> of type - <code>Any</code>, <code>x.equals(y)</code> should return <code>true</code> if and only - if <code>y.equals(x)</code> returns <code>true</code>.</li> - <li>It is transitive: for any instances - <code>x</code>, <code>y</code>, and <code>z</code> of type <code>AnyRef</code> - if <code>x.equals(y)</code> returns <code>true</code> and - <code>y.equals(z)</code> returns - <code>true</code>, then <code>x.equals(z)</code> should return <code>true</code>.</li> -</ul> -</p></p><p><p> -If you override this method, you should verify that -your implementation remains an equivalence relation. -Additionally, when overriding this method it is often necessary to -override <code>hashCode</code> to ensure that objects that are -"equal" (<code>o1.equals(o2)</code> returns <code>true</code>) -hash to the same <a href="Int.html"><code>Int</code></a> -(<code>o1.hashCode.equals(o2.hashCode)</code>). -</p></div> - - - - - </div> - </li><li name="sims.collision.Pair#hashCode"> - <h4 class="signature"> - <span class="kind">def</span> - <span class="symbol"> - <span class="name">hashCode</span><span class="params">()</span><span class="result">: <span class="extype" name="scala.Int">Int</span></span> - </span> - </h4> - <p class="shortcomment cmt">Returns a hash code value for the object</p><div class="fullcomment"> - <div class="comment cmt"><p>Returns a hash code value for the object.</p><p><p> -The default hashing algorithm is platform dependent.</p><p>Note that it is allowed for two objects to have identical hash -codes (<code>o1.hashCode.equals(o2.hashCode)</code>) yet not be -equal (<code>o1.equals(o2)</code> returns <code>false</code>). A -degenerate implementation could always return <code>0</code>. -However, it is required that if two objects are equal -(<code>o1.equals(o2)</code> returns <code>true</code>) that they -have identical hash codes -(<code>o1.hashCode.equals(o2.hashCode)</code>). Therefore, when -overriding this method, be sure to verify that the behavior is -consistent with the <code>equals</code> method. -</p></p><p><p></p></div> - - - - - </div> - </li><li name="scala.Product2#productArity"> - <h4 class="signature"> - <span class="kind">def</span> - <span class="symbol"> - <span class="name">productArity</span><span class="result">: <span class="extype" name="scala.Int">Int</span></span> - </span> - </h4> - - </li><li name="scala.Product2#productElement"> - <h4 class="signature"> - <span class="kind">def</span> - <span class="symbol"> - <span class="name">productElement</span><span class="params">(<span name="n">n: <span class="extype" name="scala.Int">Int</span></span>)</span><span class="result">: <span class="extype" name="scala.Any">Any</span></span> - </span> - </h4> - - </li><li name="scala.Product#productElements"> - <h4 class="signature"> - <span class="kind">def</span> - <span class="symbol"> - <span class="name">productElements</span><span class="result">: <span class="extype" name="scala.collection.Iterator">Iterator</span>[<span class="extype" name="scala.Any">Any</span>]</span> - </span> - </h4> - - </li><li name="scala.Product#productIterator"> - <h4 class="signature"> - <span class="kind">def</span> - <span class="symbol"> - <span class="name">productIterator</span><span class="result">: <span class="extype" name="scala.collection.Iterator">Iterator</span>[<span class="extype" name="scala.Any">Any</span>]</span> - </span> - </h4> - - </li><li name="sims.collision.Pair#productPrefix"> - <h4 class="signature"> - <span class="kind">def</span> - <span class="symbol"> - <span class="name">productPrefix</span><span class="result">: <span class="extype" name="java.lang.String">String</span></span> - </span> - </h4> - - </li><li name="sims.collision.Pair#s1"> - <h4 class="signature"> - <span class="kind">val</span> - <span class="symbol"> - <span class="name">s1</span><span class="result">: <a href="../dynamics/Shape.html" class="extype" name="sims.dynamics.Shape">Shape</a></span> - </span> - </h4> - - </li><li name="sims.collision.Pair#s2"> - <h4 class="signature"> - <span class="kind">val</span> - <span class="symbol"> - <span class="name">s2</span><span class="result">: <a href="../dynamics/Shape.html" class="extype" name="sims.dynamics.Shape">Shape</a></span> - </span> - </h4> - - </li><li name="scala.Tuple2#swap"> - <h4 class="signature"> - <span class="kind">def</span> - <span class="symbol"> - <span class="name">swap</span><span class="result">: (<a href="../dynamics/Shape.html" class="extype" name="sims.dynamics.Shape">Shape</a>, <a href="../dynamics/Shape.html" class="extype" name="sims.dynamics.Shape">Shape</a>)</span> - </span> - </h4> - - </li><li name="scala.Tuple2#toString"> - <h4 class="signature"> - <span class="kind">def</span> - <span class="symbol"> - <span class="name">toString</span><span class="params">()</span><span class="result">: <span class="extype" name="java.lang.String">String</span></span> - </span> - </h4> - <p class="shortcomment cmt">Returns a string representation of the object</p><div class="fullcomment"> - <div class="comment cmt"><p>Returns a string representation of the object. -<p> -The default representation is platform dependent. -</p></div> - - - <div class="block"> - definition classes: Tuple2 ⇐ AnyRef ⇐ Any - </div> - - </div> - </li><li name="scala.Tuple2#zip"> - <h4 class="signature"> - <span class="kind">def</span> - <span class="symbol"> - <span class="name">zip</span><span class="tparams">[<span name="Repr1">Repr1</span>, <span name="El1">El1</span>, <span name="El2">El2</span>, <span name="To">To</span>]</span><span class="params">(<span name="w1">w1: (<a href="../dynamics/Shape.html" class="extype" name="sims.dynamics.Shape">Shape</a>) ⇒ <span class="extype" name="scala.collection.TraversableLike">TraversableLike</span>[El1, Repr1]</span>, <span name="w2">w2: (<a href="../dynamics/Shape.html" class="extype" name="sims.dynamics.Shape">Shape</a>) ⇒ <span class="extype" name="scala.collection.Iterable">Iterable</span>[El2]</span>, <span name="cbf1">cbf1: <span class="extype" name="scala.collection.generic.CanBuildFrom">CanBuildFrom</span>[Repr1, (El1, El2), To]</span>)</span><span class="result">: To</span> - </span> - </h4> - - </li><li name="scala.Tuple2#zipped"> - <h4 class="signature"> - <span class="kind">def</span> - <span class="symbol"> - <span class="name">zipped</span><span class="tparams">[<span name="Repr1">Repr1</span>, <span name="El1">El1</span>, <span name="Repr2">Repr2</span>, <span name="El2">El2</span>]</span><span class="params">(<span name="w1">w1: (<a href="../dynamics/Shape.html" class="extype" name="sims.dynamics.Shape">Shape</a>) ⇒ <span class="extype" name="scala.collection.TraversableLike">TraversableLike</span>[El1, Repr1]</span>, <span name="w2">w2: (<a href="../dynamics/Shape.html" class="extype" name="sims.dynamics.Shape">Shape</a>) ⇒ <span class="extype" name="scala.collection.IterableLike">IterableLike</span>[El2, Repr2]</span>)</span><span class="result">: <span class="extype" name="scala.Tuple2.Zipped">Zipped</span>[Repr1, El1, Repr2, El2]</span> - </span> - </h4> - - </li></ol> - </div> - - <div class="members" id="constructors"> - <h3>Instance constructors</h3> - <ol><li name="sims.collision.Pair#this"> - <h4 class="signature"> - <span class="kind">new</span> - <span class="symbol"> - <span class="name">Pair</span><span class="params">(<span name="t">t: (<a href="../dynamics/Shape.html" class="extype" name="sims.dynamics.Shape">Shape</a>, <a href="../dynamics/Shape.html" class="extype" name="sims.dynamics.Shape">Shape</a>)</span>)</span> - </span> - </h4> - - </li><li name="sims.collision.Pair#this"> - <h4 class="signature"> - <span class="kind">new</span> - <span class="symbol"> - <span class="name">Pair</span><span class="params">(<span name="s1">s1: <a href="../dynamics/Shape.html" class="extype" name="sims.dynamics.Shape">Shape</a></span>, <span name="s2">s2: <a href="../dynamics/Shape.html" class="extype" name="sims.dynamics.Shape">Shape</a></span>)</span> - </span> - </h4> - - </li><li name="scala.AnyRef#this"> - <h4 class="signature"> - <span class="kind">new</span> - <span class="symbol"> - <span class="name">Pair</span><span class="params">()</span> - </span> - </h4> - - </li></ol> - </div> - - </div> - - </body> - </html>
\ No newline at end of file diff --git a/doc/sims/collision/PolyCircleCollision.html b/doc/sims/collision/PolyCircleCollision.html deleted file mode 100644 index fc31ca6..0000000 --- a/doc/sims/collision/PolyCircleCollision.html +++ /dev/null @@ -1,321 +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.collision.PolyCircleCollision</title> - <meta http-equiv="content-type" content="text/html; charset=UTF-8" /> - <script type="text/javascript" src="../../lib/jquery.js"></script> - - <style type="text/css"> - @import url(../../lib/template.css) screen; - </style> - <script type="text/javascript" src="../../lib/template.js"></script> - - </head> - <body class="type"> - - <p id="owner"><a href="../package.html">sims</a>.<a href="package.html">collision</a></p> - - <div id="definition"> - <img src="../../lib/class_big.png" /> - <h1>PolyCircleCollision</h1> - </div> - - <h4 class="signature"> - <span class="kind">class</span> - <span class="symbol"> - <span class="name">PolyCircleCollision</span><span class="params">(<span name="p">p: <a href="../geometry/ConvexPolygon.html" class="extype" name="sims.geometry.ConvexPolygon">ConvexPolygon</a></span>, <span name="c">c: <a href="../dynamics/Circle.html" class="extype" name="sims.dynamics.Circle">Circle</a></span>)</span><span class="result"> extends <a href="Collision.html" class="extype" name="sims.collision.Collision">Collision</a> with <span class="extype" name="scala.Product">Product</span></span> - </span> - </h4> - <div class="fullcomment" id="comment"> - <div class="comment cmt"><p>Collision between a convex polygon and a circle.</p></div> - - - - - </div> - - <div id="template"> - - <div id="mbrsel"> - <div id="ancestors"> - <h3>Inherits</h3> - <ol><li class="in" name="scala.Product">Product</li><li class="in" name="scala.Equals">Equals</li><li class="in" name="sims.collision.Collision">Collision</li><li class="in" name="sims.dynamics.Constraint">Constraint</li><li class="in" name="scala.AnyRef">AnyRef</li><li class="in" name="scala.Any">Any</li></ol> - </div> - </div> - - - - <div class="members" id="values"> - <h3>Value Members</h3> - <ol><li name="sims.collision.PolyCircleCollision#c"> - <h4 class="signature"> - <span class="kind">val</span> - <span class="symbol"> - <span class="name">c</span><span class="result">: <a href="../dynamics/Circle.html" class="extype" name="sims.dynamics.Circle">Circle</a></span> - </span> - </h4> - - </li><li name="sims.collision.PolyCircleCollision#canEqual"> - <h4 class="signature"> - <span class="kind">def</span> - <span class="symbol"> - <span class="name">canEqual</span><span class="params">(<span name="arg0">arg0: <span class="extype" name="scala.Any">Any</span></span>)</span><span class="result">: <span class="extype" name="scala.Boolean">Boolean</span></span> - </span> - </h4> - - </li><li name="sims.collision.Collision#correctFriction"> - <h4 class="signature"> - <span class="kind">def</span> - <span class="symbol"> - <span class="name">correctFriction</span><span class="params">(<span name="point">point: <a href="../geometry/Vector2D.html" class="extype" name="sims.geometry.Vector2D">Vector2D</a></span>, <span name="normalForce">normalForce: <span class="extype" name="scala.Double">Double</span></span>, <span name="h">h: <span class="extype" name="scala.Double">Double</span></span>)</span><span class="result">: <span class="extype" name="scala.Unit">Unit</span></span> - </span> - </h4> - - </li><li name="sims.collision.Collision#correctPosition"> - <h4 class="signature"> - <span class="kind">def</span> - <span class="symbol"> - <span class="name">correctPosition</span><span class="params">(<span name="h">h: <span class="extype" name="scala.Double">Double</span></span>)</span><span class="result">: <span class="extype" name="scala.Unit">Unit</span></span> - </span> - </h4> - <p class="shortcomment cmt">Corrects the positions of bodies according to this constraint</p><div class="fullcomment"> - <div class="comment cmt"><p>Corrects the positions of bodies according to this constraint.</p></div> - <dl class="paramcmts block"><dt class="param">h</dt><dd class="cmt"><p>a time interval, used for converting forces and impulses</p></dd></dl> - - <div class="block"> - definition classes: <a href="Collision.html">Collision</a> ⇐ <a href="../dynamics/Constraint.html">Constraint</a> - </div> - - </div> - </li><li name="sims.collision.Collision#correctVelocity"> - <h4 class="signature"> - <span class="kind">def</span> - <span class="symbol"> - <span class="name">correctVelocity</span><span class="params">(<span name="h">h: <span class="extype" name="scala.Double">Double</span></span>)</span><span class="result">: <span class="extype" name="scala.Unit">Unit</span></span> - </span> - </h4> - <p class="shortcomment cmt">Corrects the velocities of bodies according to this constraint</p><div class="fullcomment"> - <div class="comment cmt"><p>Corrects the velocities of bodies according to this constraint.</p></div> - <dl class="paramcmts block"><dt class="param">h</dt><dd class="cmt"><p>a time interval, used for converting forces and impulses</p></dd></dl> - - <div class="block"> - definition classes: <a href="Collision.html">Collision</a> ⇐ <a href="../dynamics/Constraint.html">Constraint</a> - </div> - - </div> - </li><li name="sims.collision.PolyCircleCollision#equals"> - <h4 class="signature"> - <span class="kind">def</span> - <span class="symbol"> - <span class="name">equals</span><span class="params">(<span name="arg0">arg0: <span class="extype" name="scala.Any">Any</span></span>)</span><span class="result">: <span class="extype" name="scala.Boolean">Boolean</span></span> - </span> - </h4> - <p class="shortcomment cmt">This method is used to compare the receiver object (<code>this</code>) -with the argument object (<code>arg0</code>) for equivalence</p><div class="fullcomment"> - <div class="comment cmt"><p>This method is used to compare the receiver object (<code>this</code>) -with the argument object (<code>arg0</code>) for equivalence.</p><p><p> -The default implementations of this method is an <a -href="http://en.wikipedia.org/wiki/Equivalence_relation">equivalence -relation</a>: - <ul> - <li>It is reflexive: for any instance <code>x</code> of type <code>Any</code>, - <code>x.equals(x)</code> should return <code>true</code>.</li> - <li>It is symmetric: for any instances <code>x</code> and <code>y</code> of type - <code>Any</code>, <code>x.equals(y)</code> should return <code>true</code> if and only - if <code>y.equals(x)</code> returns <code>true</code>.</li> - <li>It is transitive: for any instances - <code>x</code>, <code>y</code>, and <code>z</code> of type <code>AnyRef</code> - if <code>x.equals(y)</code> returns <code>true</code> and - <code>y.equals(z)</code> returns - <code>true</code>, then <code>x.equals(z)</code> should return <code>true</code>.</li> -</ul> -</p></p><p><p> -If you override this method, you should verify that -your implementation remains an equivalence relation. -Additionally, when overriding this method it is often necessary to -override <code>hashCode</code> to ensure that objects that are -"equal" (<code>o1.equals(o2)</code> returns <code>true</code>) -hash to the same <a href="Int.html"><code>Int</code></a> -(<code>o1.hashCode.equals(o2.hashCode)</code>). -</p></div> - <dl class="paramcmts block"><dt class="param">arg0</dt><dd class="cmt"><p>the object to compare against this object for equality.</p></dd><dt>returns</dt><dd class="cmt"><p><code>true</code> if the receiver object is equivalent to the argument; <code>false</code> otherwise. -</p></p></dd></dl> - - - - </div> - </li><li name="sims.collision.PolyCircleCollision#hashCode"> - <h4 class="signature"> - <span class="kind">def</span> - <span class="symbol"> - <span class="name">hashCode</span><span class="params">()</span><span class="result">: <span class="extype" name="scala.Int">Int</span></span> - </span> - </h4> - <p class="shortcomment cmt">Returns a hash code value for the object</p><div class="fullcomment"> - <div class="comment cmt"><p>Returns a hash code value for the object.</p><p><p> -The default hashing algorithm is platform dependent.</p><p>Note that it is allowed for two objects to have identical hash -codes (<code>o1.hashCode.equals(o2.hashCode)</code>) yet not be -equal (<code>o1.equals(o2)</code> returns <code>false</code>). A -degenerate implementation could always return <code>0</code>. -However, it is required that if two objects are equal -(<code>o1.equals(o2)</code> returns <code>true</code>) that they -have identical hash codes -(<code>o1.hashCode.equals(o2.hashCode)</code>). Therefore, when -overriding this method, be sure to verify that the behavior is -consistent with the <code>equals</code> method. -</p></p><p><p></p></div> - - - - - </div> - </li><li name="sims.collision.PolyCircleCollision#normal"> - <h4 class="signature"> - <span class="kind">val</span> - <span class="symbol"> - <span class="name">normal</span><span class="result">: <a href="../geometry/Vector2D.html" class="extype" name="sims.geometry.Vector2D">Vector2D</a></span> - </span> - </h4> - <p class="shortcomment cmt">Normal vector to the collision face</p><div class="fullcomment"> - <div class="comment cmt"><p>Normal vector to the collision face.</p></div> - - - - - </div> - </li><li name="sims.collision.PolyCircleCollision#p"> - <h4 class="signature"> - <span class="kind">val</span> - <span class="symbol"> - <span class="name">p</span><span class="result">: <a href="../geometry/ConvexPolygon.html" class="extype" name="sims.geometry.ConvexPolygon">ConvexPolygon</a></span> - </span> - </h4> - - </li><li name="sims.collision.PolyCircleCollision#points"> - <h4 class="signature"> - <span class="kind">val</span> - <span class="symbol"> - <span class="name">points</span><span class="result">: <span class="extype" name="scala.collection.immutable.List">List</span>[<a href="../geometry/Vector2D.html" class="extype" name="sims.geometry.Vector2D">Vector2D</a>]</span> - </span> - </h4> - <p class="shortcomment cmt">Collision points</p><div class="fullcomment"> - <div class="comment cmt"><p>Collision points.</p></div> - - - - - </div> - </li><li name="sims.collision.PolyCircleCollision#productArity"> - <h4 class="signature"> - <span class="kind">def</span> - <span class="symbol"> - <span class="name">productArity</span><span class="result">: <span class="extype" name="scala.Int">Int</span></span> - </span> - </h4> - - </li><li name="sims.collision.PolyCircleCollision#productElement"> - <h4 class="signature"> - <span class="kind">def</span> - <span class="symbol"> - <span class="name">productElement</span><span class="params">(<span name="arg0">arg0: <span class="extype" name="scala.Int">Int</span></span>)</span><span class="result">: <span class="extype" name="scala.Any">Any</span></span> - </span> - </h4> - - </li><li name="scala.Product#productElements"> - <h4 class="signature"> - <span class="kind">def</span> - <span class="symbol"> - <span class="name">productElements</span><span class="result">: <span class="extype" name="scala.collection.Iterator">Iterator</span>[<span class="extype" name="scala.Any">Any</span>]</span> - </span> - </h4> - - </li><li name="scala.Product#productIterator"> - <h4 class="signature"> - <span class="kind">def</span> - <span class="symbol"> - <span class="name">productIterator</span><span class="result">: <span class="extype" name="scala.collection.Iterator">Iterator</span>[<span class="extype" name="scala.Any">Any</span>]</span> - </span> - </h4> - - </li><li name="sims.collision.PolyCircleCollision#productPrefix"> - <h4 class="signature"> - <span class="kind">def</span> - <span class="symbol"> - <span class="name">productPrefix</span><span class="result">: <span class="extype" name="java.lang.String">String</span></span> - </span> - </h4> - - </li><li name="sims.collision.PolyCircleCollision#shape1"> - <h4 class="signature"> - <span class="kind">val</span> - <span class="symbol"> - <span class="name">shape1</span><span class="result">: <a href="../dynamics/Shape.html" class="extype" name="sims.dynamics.Shape">Shape</a></span> - </span> - </h4> - <p class="shortcomment cmt">First colliding shape (reference shape)</p><div class="fullcomment"> - <div class="comment cmt"><p>First colliding shape (reference shape).</p></div> - - - - - </div> - </li><li name="sims.collision.PolyCircleCollision#shape2"> - <h4 class="signature"> - <span class="kind">val</span> - <span class="symbol"> - <span class="name">shape2</span><span class="result">: <a href="../dynamics/Circle.html" class="extype" name="sims.dynamics.Circle">Circle</a></span> - </span> - </h4> - <p class="shortcomment cmt">Second colliding shape (incident shape)</p><div class="fullcomment"> - <div class="comment cmt"><p>Second colliding shape (incident shape).</p></div> - - - - - </div> - </li><li name="sims.collision.PolyCircleCollision#toString"> - <h4 class="signature"> - <span class="kind">def</span> - <span class="symbol"> - <span class="name">toString</span><span class="params">()</span><span class="result">: <span class="extype" name="java.lang.String">String</span></span> - </span> - </h4> - <p class="shortcomment cmt">Returns a string representation of the object</p><div class="fullcomment"> - <div class="comment cmt"><p>Returns a string representation of the object. -<p> -The default representation is platform dependent. -</p></div> - - - - - </div> - </li></ol> - </div> - - <div class="members" id="constructors"> - <h3>Instance constructors</h3> - <ol><li name="sims.collision.PolyCircleCollision#this"> - <h4 class="signature"> - <span class="kind">new</span> - <span class="symbol"> - <span class="name">PolyCircleCollision</span><span class="params">(<span name="p">p: <a href="../geometry/ConvexPolygon.html" class="extype" name="sims.geometry.ConvexPolygon">ConvexPolygon</a></span>, <span name="c">c: <a href="../dynamics/Circle.html" class="extype" name="sims.dynamics.Circle">Circle</a></span>)</span> - </span> - </h4> - - </li><li name="sims.collision.Collision#this"> - <h4 class="signature"> - <span class="kind">new</span> - <span class="symbol"> - <span class="name">PolyCircleCollision</span><span class="params">()</span> - </span> - </h4> - - </li></ol> - </div> - - </div> - - </body> - </html>
\ No newline at end of file diff --git a/doc/sims/collision/PolyCollision.html b/doc/sims/collision/PolyCollision.html deleted file mode 100644 index 8a9cc89..0000000 --- a/doc/sims/collision/PolyCollision.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.collision.PolyCollision</title> - <meta http-equiv="content-type" content="text/html; charset=UTF-8" /> - <script type="text/javascript" src="../../lib/jquery.js"></script> - - <style type="text/css"> - @import url(../../lib/template.css) screen; - </style> - <script type="text/javascript" src="../../lib/template.js"></script> - - </head> - <body class="type"> - - <p id="owner"><a href="../package.html">sims</a>.<a href="package.html">collision</a></p> - - <div id="definition"> - <img src="../../lib/class_big.png" /> - <h1>PolyCollision</h1> - </div> - - <h4 class="signature"> - <span class="kind">class</span> - <span class="symbol"> - <span class="name">PolyCollision</span><span class="params">(<span name="p1">p1: <a href="../geometry/ConvexPolygon.html" class="extype" name="sims.geometry.ConvexPolygon">ConvexPolygon</a></span>, <span name="p2">p2: <a href="../geometry/ConvexPolygon.html" class="extype" name="sims.geometry.ConvexPolygon">ConvexPolygon</a></span>)</span><span class="result"> extends <a href="Collision.html" class="extype" name="sims.collision.Collision">Collision</a> with <span class="extype" name="scala.Product">Product</span></span> - </span> - </h4> - <div class="fullcomment" id="comment"> - <div class="comment cmt"><p>Collision between two convex polygons.</p></div> - - - - - </div> - - <div id="template"> - - <div id="mbrsel"> - <div id="ancestors"> - <h3>Inherits</h3> - <ol><li class="in" name="scala.Product">Product</li><li class="in" name="scala.Equals">Equals</li><li class="in" name="sims.collision.Collision">Collision</li><li class="in" name="sims.dynamics.Constraint">Constraint</li><li class="in" name="scala.AnyRef">AnyRef</li><li class="in" name="scala.Any">Any</li></ol> - </div> - </div> - - - - <div class="members" id="values"> - <h3>Value Members</h3> - <ol><li name="sims.collision.PolyCollision#canEqual"> - <h4 class="signature"> - <span class="kind">def</span> - <span class="symbol"> - <span class="name">canEqual</span><span class="params">(<span name="arg0">arg0: <span class="extype" name="scala.Any">Any</span></span>)</span><span class="result">: <span class="extype" name="scala.Boolean">Boolean</span></span> - </span> - </h4> - - </li><li name="sims.collision.Collision#correctFriction"> - <h4 class="signature"> - <span class="kind">def</span> - <span class="symbol"> - <span class="name">correctFriction</span><span class="params">(<span name="point">point: <a href="../geometry/Vector2D.html" class="extype" name="sims.geometry.Vector2D">Vector2D</a></span>, <span name="normalForce">normalForce: <span class="extype" name="scala.Double">Double</span></span>, <span name="h">h: <span class="extype" name="scala.Double">Double</span></span>)</span><span class="result">: <span class="extype" name="scala.Unit">Unit</span></span> - </span> - </h4> - - </li><li name="sims.collision.Collision#correctPosition"> - <h4 class="signature"> - <span class="kind">def</span> - <span class="symbol"> - <span class="name">correctPosition</span><span class="params">(<span name="h">h: <span class="extype" name="scala.Double">Double</span></span>)</span><span class="result">: <span class="extype" name="scala.Unit">Unit</span></span> - </span> - </h4> - <p class="shortcomment cmt">Corrects the positions of bodies according to this constraint</p><div class="fullcomment"> - <div class="comment cmt"><p>Corrects the positions of bodies according to this constraint.</p></div> - <dl class="paramcmts block"><dt class="param">h</dt><dd class="cmt"><p>a time interval, used for converting forces and impulses</p></dd></dl> - - <div class="block"> - definition classes: <a href="Collision.html">Collision</a> ⇐ <a href="../dynamics/Constraint.html">Constraint</a> - </div> - - </div> - </li><li name="sims.collision.Collision#correctVelocity"> - <h4 class="signature"> - <span class="kind">def</span> - <span class="symbol"> - <span class="name">correctVelocity</span><span class="params">(<span name="h">h: <span class="extype" name="scala.Double">Double</span></span>)</span><span class="result">: <span class="extype" name="scala.Unit">Unit</span></span> - </span> - </h4> - <p class="shortcomment cmt">Corrects the velocities of bodies according to this constraint</p><div class="fullcomment"> - <div class="comment cmt"><p>Corrects the velocities of bodies according to this constraint.</p></div> - <dl class="paramcmts block"><dt class="param">h</dt><dd class="cmt"><p>a time interval, used for converting forces and impulses</p></dd></dl> - - <div class="block"> - definition classes: <a href="Collision.html">Collision</a> ⇐ <a href="../dynamics/Constraint.html">Constraint</a> - </div> - - </div> - </li><li name="sims.collision.PolyCollision#equals"> - <h4 class="signature"> - <span class="kind">def</span> - <span class="symbol"> - <span class="name">equals</span><span class="params">(<span name="arg0">arg0: <span class="extype" name="scala.Any">Any</span></span>)</span><span class="result">: <span class="extype" name="scala.Boolean">Boolean</span></span> - </span> - </h4> - <p class="shortcomment cmt">This method is used to compare the receiver object (<code>this</code>) -with the argument object (<code>arg0</code>) for equivalence</p><div class="fullcomment"> - <div class="comment cmt"><p>This method is used to compare the receiver object (<code>this</code>) -with the argument object (<code>arg0</code>) for equivalence.</p><p><p> -The default implementations of this method is an <a -href="http://en.wikipedia.org/wiki/Equivalence_relation">equivalence -relation</a>: - <ul> - <li>It is reflexive: for any instance <code>x</code> of type <code>Any</code>, - <code>x.equals(x)</code> should return <code>true</code>.</li> - <li>It is symmetric: for any instances <code>x</code> and <code>y</code> of type - <code>Any</code>, <code>x.equals(y)</code> should return <code>true</code> if and only - if <code>y.equals(x)</code> returns <code>true</code>.</li> - <li>It is transitive: for any instances - <code>x</code>, <code>y</code>, and <code>z</code> of type <code>AnyRef</code> - if <code>x.equals(y)</code> returns <code>true</code> and - <code>y.equals(z)</code> returns - <code>true</code>, then <code>x.equals(z)</code> should return <code>true</code>.</li> -</ul> -</p></p><p><p> -If you override this method, you should verify that -your implementation remains an equivalence relation. -Additionally, when overriding this method it is often necessary to -override <code>hashCode</code> to ensure that objects that are -"equal" (<code>o1.equals(o2)</code> returns <code>true</code>) -hash to the same <a href="Int.html"><code>Int</code></a> -(<code>o1.hashCode.equals(o2.hashCode)</code>). -</p></div> - <dl class="paramcmts block"><dt class="param">arg0</dt><dd class="cmt"><p>the object to compare against this object for equality.</p></dd><dt>returns</dt><dd class="cmt"><p><code>true</code> if the receiver object is equivalent to the argument; <code>false</code> otherwise. -</p></p></dd></dl> - - - - </div> - </li><li name="sims.collision.PolyCollision#hashCode"> - <h4 class="signature"> - <span class="kind">def</span> - <span class="symbol"> - <span class="name">hashCode</span><span class="params">()</span><span class="result">: <span class="extype" name="scala.Int">Int</span></span> - </span> - </h4> - <p class="shortcomment cmt">Returns a hash code value for the object</p><div class="fullcomment"> - <div class="comment cmt"><p>Returns a hash code value for the object.</p><p><p> -The default hashing algorithm is platform dependent.</p><p>Note that it is allowed for two objects to have identical hash -codes (<code>o1.hashCode.equals(o2.hashCode)</code>) yet not be -equal (<code>o1.equals(o2)</code> returns <code>false</code>). A -degenerate implementation could always return <code>0</code>. -However, it is required that if two objects are equal -(<code>o1.equals(o2)</code> returns <code>true</code>) that they -have identical hash codes -(<code>o1.hashCode.equals(o2.hashCode)</code>). Therefore, when -overriding this method, be sure to verify that the behavior is -consistent with the <code>equals</code> method. -</p></p><p><p></p></div> - - - - - </div> - </li><li name="sims.collision.PolyCollision#minOverlap"> - <h4 class="signature"> - <span class="kind">var</span> - <span class="symbol"> - <span class="name">minOverlap</span><span class="result">: <a href="Overlap.html" class="extype" name="sims.collision.Overlap">Overlap</a></span> - </span> - </h4> - - </li><li name="sims.collision.PolyCollision#normal"> - <h4 class="signature"> - <span class="kind">var</span> - <span class="symbol"> - <span class="name">normal</span><span class="result">: <a href="../geometry/Vector2D.html" class="extype" name="sims.geometry.Vector2D">Vector2D</a></span> - </span> - </h4> - <p class="shortcomment cmt">Normal vector to the collision face</p><div class="fullcomment"> - <div class="comment cmt"><p>Normal vector to the collision face.</p></div> - - - - - </div> - </li><li name="sims.collision.PolyCollision#overlap"> - <h4 class="signature"> - <span class="kind">def</span> - <span class="symbol"> - <span class="name">overlap</span><span class="params">(<span name="axis">axis: <a href="../geometry/Vector2D.html" class="extype" name="sims.geometry.Vector2D">Vector2D</a></span>)</span><span class="result">: <span class="extype" name="scala.Double">Double</span></span> - </span> - </h4> - - </li><li name="sims.collision.PolyCollision#overlaps"> - <h4 class="signature"> - <span class="kind">var</span> - <span class="symbol"> - <span class="name">overlaps</span><span class="result">: <span class="extype" name="scala.collection.immutable.IndexedSeq">IndexedSeq</span>[<a href="Overlap.html" class="extype" name="sims.collision.Overlap">Overlap</a>]</span> - </span> - </h4> - - </li><li name="sims.collision.PolyCollision#p1"> - <h4 class="signature"> - <span class="kind">val</span> - <span class="symbol"> - <span class="name">p1</span><span class="result">: <a href="../geometry/ConvexPolygon.html" class="extype" name="sims.geometry.ConvexPolygon">ConvexPolygon</a></span> - </span> - </h4> - - </li><li name="sims.collision.PolyCollision#p2"> - <h4 class="signature"> - <span class="kind">val</span> - <span class="symbol"> - <span class="name">p2</span><span class="result">: <a href="../geometry/ConvexPolygon.html" class="extype" name="sims.geometry.ConvexPolygon">ConvexPolygon</a></span> - </span> - </h4> - - </li><li name="sims.collision.PolyCollision#points"> - <h4 class="signature"> - <span class="kind">var</span> - <span class="symbol"> - <span class="name">points</span><span class="result">: <span class="extype" name="scala.collection.Seq">Seq</span>[<a href="../geometry/Vector2D.html" class="extype" name="sims.geometry.Vector2D">Vector2D</a>]</span> - </span> - </h4> - <p class="shortcomment cmt">Collision points</p><div class="fullcomment"> - <div class="comment cmt"><p>Collision points.</p></div> - - - - - </div> - </li><li name="sims.collision.PolyCollision#productArity"> - <h4 class="signature"> - <span class="kind">def</span> - <span class="symbol"> - <span class="name">productArity</span><span class="result">: <span class="extype" name="scala.Int">Int</span></span> - </span> - </h4> - - </li><li name="sims.collision.PolyCollision#productElement"> - <h4 class="signature"> - <span class="kind">def</span> - <span class="symbol"> - <span class="name">productElement</span><span class="params">(<span name="arg0">arg0: <span class="extype" name="scala.Int">Int</span></span>)</span><span class="result">: <span class="extype" name="scala.Any">Any</span></span> - </span> - </h4> - - </li><li name="scala.Product#productElements"> - <h4 class="signature"> - <span class="kind">def</span> - <span class="symbol"> - <span class="name">productElements</span><span class="result">: <span class="extype" name="scala.collection.Iterator">Iterator</span>[<span class="extype" name="scala.Any">Any</span>]</span> - </span> - </h4> - - </li><li name="scala.Product#productIterator"> - <h4 class="signature"> - <span class="kind">def</span> - <span class="symbol"> - <span class="name">productIterator</span><span class="result">: <span class="extype" name="scala.collection.Iterator">Iterator</span>[<span class="extype" name="scala.Any">Any</span>]</span> - </span> - </h4> - - </li><li name="sims.collision.PolyCollision#productPrefix"> - <h4 class="signature"> - <span class="kind">def</span> - <span class="symbol"> - <span class="name">productPrefix</span><span class="result">: <span class="extype" name="java.lang.String">String</span></span> - </span> - </h4> - - </li><li name="sims.collision.PolyCollision#shape1"> - <h4 class="signature"> - <span class="kind">var</span> - <span class="symbol"> - <span class="name">shape1</span><span class="result">: <a href="../dynamics/Shape.html" class="extype" name="sims.dynamics.Shape">Shape</a></span> - </span> - </h4> - <p class="shortcomment cmt">First colliding shape (reference shape)</p><div class="fullcomment"> - <div class="comment cmt"><p>First colliding shape (reference shape).</p></div> - - - - - </div> - </li><li name="sims.collision.PolyCollision#shape2"> - <h4 class="signature"> - <span class="kind">var</span> - <span class="symbol"> - <span class="name">shape2</span><span class="result">: <a href="../dynamics/Shape.html" class="extype" name="sims.dynamics.Shape">Shape</a></span> - </span> - </h4> - <p class="shortcomment cmt">Second colliding shape (incident shape)</p><div class="fullcomment"> - <div class="comment cmt"><p>Second colliding shape (incident shape).</p></div> - - - - - </div> - </li><li name="sims.collision.PolyCollision#toString"> - <h4 class="signature"> - <span class="kind">def</span> - <span class="symbol"> - <span class="name">toString</span><span class="params">()</span><span class="result">: <span class="extype" name="java.lang.String">String</span></span> - </span> - </h4> - <p class="shortcomment cmt">Returns a string representation of the object</p><div class="fullcomment"> - <div class="comment cmt"><p>Returns a string representation of the object. -<p> -The default representation is platform dependent. -</p></div> - - - - - </div> - </li></ol> - </div> - - <div class="members" id="constructors"> - <h3>Instance constructors</h3> - <ol><li name="sims.collision.PolyCollision#this"> - <h4 class="signature"> - <span class="kind">new</span> - <span class="symbol"> - <span class="name">PolyCollision</span><span class="params">(<span name="p1">p1: <a href="../geometry/ConvexPolygon.html" class="extype" name="sims.geometry.ConvexPolygon">ConvexPolygon</a></span>, <span name="p2">p2: <a href="../geometry/ConvexPolygon.html" class="extype" name="sims.geometry.ConvexPolygon">ConvexPolygon</a></span>)</span> - </span> - </h4> - - </li><li name="sims.collision.Collision#this"> - <h4 class="signature"> - <span class="kind">new</span> - <span class="symbol"> - <span class="name">PolyCollision</span><span class="params">()</span> - </span> - </h4> - - </li></ol> - </div> - - </div> - - </body> - </html>
\ No newline at end of file diff --git a/doc/sims/collision/package.html b/doc/sims/collision/package.html deleted file mode 100644 index a1e571e..0000000 --- a/doc/sims/collision/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.collision</title> - <meta http-equiv="content-type" content="text/html; charset=UTF-8" /> - <script type="text/javascript" src="../../lib/jquery.js"></script> - - <style type="text/css"> - @import url(../../lib/template.css) screen; - </style> - <script type="text/javascript" src="../../lib/template.js"></script> - - </head> - <body class="value"> - - <p id="owner"><a href="../package.html">sims</a></p> - - <div id="definition"> - <img src="../../lib/package_big.png" /> - <h1>collision</h1> - </div> - - <h4 class="signature"> - <span class="kind">package</span> - <span class="symbol"> - <span class="name">collision</span> - </span> - </h4> - <div class="fullcomment" id="comment"> - - - - - - </div> - - <div id="template"> - - - - <div class="members" id="types"> - <h3>Type Members</h3> - <ol><li name="sims.collision.AABB"> - <h4 class="signature"><a href="AABB.html"> - <span class="kind">class</span> - <span class="symbol"> - <span class="name">AABB</span><span class="params">(<span name="minVertex">minVertex: Vector2D</span>, <span name="maxVertex">maxVertex: Vector2D</span>)</span><span class="result"> extends Product</span> - </span> - </a></h4> - <p class="comment cmt">Axis Aligned Bounding Boxes (AABBs) are rectangles that frame a shape</p> - </li><li name="sims.collision.CircleCollision"> - <h4 class="signature"><a href="CircleCollision.html"> - <span class="kind">class</span> - <span class="symbol"> - <span class="name">CircleCollision</span><span class="params">(<span name="c1">c1: Circle</span>, <span name="c2">c2: Circle</span>)</span><span class="result"> extends Collision with Product</span> - </span> - </a></h4> - <p class="comment cmt">Collision between two circles</p> - </li><li name="sims.collision.Collision"> - <h4 class="signature"><a href="Collision.html"> - <span class="kind">class</span> - <span class="symbol"> - <span class="name">Collision</span><span class="result"> extends Constraint</span> - </span> - </a></h4> - <p class="comment cmt">Collision between two shapes</p> - </li><li name="sims.collision.Detector"> - <h4 class="signature"><a href="Detector.html"> - <span class="kind">class</span> - <span class="symbol"> - <span class="name">Detector</span><span class="result"> extends AnyRef</span> - </span> - </a></h4> - <p class="comment cmt">A world detects its collisions through concrete implementations of this class</p> - </li><li name="sims.collision.GridDetector"> - <h4 class="signature"><a href="GridDetector.html"> - <span class="kind">class</span> - <span class="symbol"> - <span class="name">GridDetector</span><span class="result"> extends Detector</span> - </span> - </a></h4> - <p class="comment cmt">A conrete implementation of <code>Detector</code></p> - </li><li name="sims.collision.Overlap"> - <h4 class="signature"><a href="Overlap.html"> - <span class="kind">class</span> - <span class="symbol"> - <span class="name">Overlap</span><span class="params">(<span name="poly">poly: ConvexPolygon</span>, <span name="sideNum">sideNum: Int</span>, <span name="overlap">overlap: Double</span>)</span><span class="result"> extends Product</span> - </span> - </a></h4> - - </li><li name="sims.collision.Pair"> - <h4 class="signature"><a href="Pair.html"> - <span class="kind">class</span> - <span class="symbol"> - <span class="name">Pair</span><span class="params">(<span name="s1">s1: Shape</span>, <span name="s2">s2: Shape</span>)</span><span class="result"> extends (Shape, Shape) with Product</span> - </span> - </a></h4> - <p class="comment cmt">Pair of shapes</p> - </li><li name="sims.collision.PolyCircleCollision"> - <h4 class="signature"><a href="PolyCircleCollision.html"> - <span class="kind">class</span> - <span class="symbol"> - <span class="name">PolyCircleCollision</span><span class="params">(<span name="p">p: ConvexPolygon</span>, <span name="c">c: Circle</span>)</span><span class="result"> extends Collision with Product</span> - </span> - </a></h4> - <p class="comment cmt">Collision between a convex polygon and a circle</p> - </li><li name="sims.collision.PolyCollision"> - <h4 class="signature"><a href="PolyCollision.html"> - <span class="kind">class</span> - <span class="symbol"> - <span class="name">PolyCollision</span><span class="params">(<span name="p1">p1: ConvexPolygon</span>, <span name="p2">p2: ConvexPolygon</span>)</span><span class="result"> extends Collision with Product</span> - </span> - </a></h4> - <p class="comment cmt">Collision between two convex polygons</p> - </li></ol> - </div> - - <div class="members" id="values"> - <h3>Value Members</h3> - <ol><li name="sims.collision.Collision"> - <h4 class="signature"><a href="Collision$.html"> - <span class="kind">object</span> - <span class="symbol"> - <span class="name">Collision</span><span class="result"> extends AnyRef</span> - </span> - </a></h4> - - </li></ol> - </div> - - - - </div> - - </body> - </html>
\ No newline at end of file |