diff options
Diffstat (limited to 'doc/sims/dynamics/Shape.html')
| -rw-r--r-- | doc/sims/dynamics/Shape.html | 458 |
1 files changed, 0 insertions, 458 deletions
diff --git a/doc/sims/dynamics/Shape.html b/doc/sims/dynamics/Shape.html deleted file mode 100644 index 03db5e1..0000000 --- a/doc/sims/dynamics/Shape.html +++ /dev/null @@ -1,458 +0,0 @@ -<?xml version='1.0' encoding='UTF-8'?> -<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.1//EN" "http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd"> -<html> - <head> - <title>Scaladoc for sims.dynamics.Shape</title> - <meta http-equiv="content-type" content="text/html; charset=UTF-8" /> - <script type="text/javascript" src="../../lib/jquery.js"></script> - - <style type="text/css"> - @import url(../../lib/template.css) screen; - </style> - <script type="text/javascript" src="../../lib/template.js"></script> - - </head> - <body class="type"> - - <p id="owner"><a href="../package.html">sims</a>.<a href="package.html">dynamics</a></p> - - <div id="definition"> - <img src="../../lib/class_big.png" /> - <h1>Shape</h1> - </div> - - <h4 class="signature"> - <span class="kind">class</span> - <span class="symbol"> - <span class="name">Shape</span><span class="result"> extends AnyRef</span> - </span> - </h4> - <div class="fullcomment" id="comment"> - <div class="comment cmt"><p>An abstract shape.</p></div> - - <div class="block"> - attributes: abstract - </div> - - <div class="block"> - known subclasses: <a href="RegularPolygon.html">RegularPolygon</a>, <a href="Rectangle.html">Rectangle</a>, <a href="Circle.html">Circle</a>, <a href="../../graphyx/graphics/GraphicalShape.html">GraphicalShape</a> - </div> - </div> - - <div id="template"> - - <div id="mbrsel"> - <div id="ancestors"> - <h3>Inherits</h3> - <ol><li class="in" name="scala.AnyRef">AnyRef</li><li class="in" name="scala.Any">Any</li></ol> - </div> - </div> - - - - <div class="members" id="values"> - <h3>Value Members</h3> - <ol><li name="sims.dynamics.Shape#AABB"> - <h4 class="signature"> - <span class="kind">def</span> - <span class="symbol"> - <span class="name">AABB</span><span class="result">: <a href="../collision/AABB.html" class="extype" name="sims.collision.AABB">AABB</a></span> - </span> - </h4> - <p class="shortcomment cmt">Returns this shape's axis aligned bounding box</p><div class="fullcomment"> - <div class="comment cmt"><p>Returns this shape's axis aligned bounding box.</p></div> - - <div class="block"> - attributes: abstract - </div> - - - </div> - </li><li name="sims.dynamics.Shape#I"> - <h4 class="signature"> - <span class="kind">val</span> - <span class="symbol"> - <span class="name">I</span><span class="result">: <span class="extype" name="scala.Double">Double</span></span> - </span> - </h4> - <p class="shortcomment cmt">Moment of inertia for a rotation about this shape's COM</p><div class="fullcomment"> - <div class="comment cmt"><p>Moment of inertia for a rotation about this shape's COM.</p></div> - - <div class="block"> - attributes: abstract - </div> - - - </div> - </li><li name="sims.dynamics.Shape#asBody"> - <h4 class="signature"> - <span class="kind">def</span> - <span class="symbol"> - <span class="name">asBody</span><span class="result">: <a href="Body.html" class="extype" name="sims.dynamics.Body">Body</a></span> - </span> - </h4> - <p class="shortcomment cmt">Creates a new body made out of tis shape</p><div class="fullcomment"> - <div class="comment cmt"><p>Creates a new body made out of tis shape.</p></div> - - - - - </div> - </li><li name="sims.dynamics.Shape#body"> - <h4 class="signature"> - <span class="kind">def</span> - <span class="symbol"> - <span class="name">body</span><span class="result">: <a href="Body.html" class="extype" name="sims.dynamics.Body">Body</a></span> - </span> - </h4> - <p class="shortcomment cmt">Returns this shape's containing body</p><div class="fullcomment"> - <div class="comment cmt"><p>Returns this shape's containing body.</p></div> - - - - - </div> - </li><li name="sims.dynamics.Shape#collidable"> - <h4 class="signature"> - <span class="kind">var</span> - <span class="symbol"> - <span class="name">collidable</span><span class="result">: <span class="extype" name="scala.Boolean">Boolean</span></span> - </span> - </h4> - <p class="shortcomment cmt">Flag determining this shapes ability to collide with other shapes</p><div class="fullcomment"> - <div class="comment cmt"><p>Flag determining this shapes ability to collide with other shapes.</p></div> - - - - - </div> - </li><li name="sims.dynamics.Shape#contains"> - <h4 class="signature"> - <span class="kind">def</span> - <span class="symbol"> - <span class="name">contains</span><span class="params">(<span name="point">point: <a href="../geometry/Vector2D.html" class="extype" name="sims.geometry.Vector2D">Vector2D</a></span>)</span><span class="result">: <span class="extype" name="scala.Boolean">Boolean</span></span> - </span> - </h4> - <p class="shortcomment cmt">Checks if the point <code>point</code> is contained in this shape</p><div class="fullcomment"> - <div class="comment cmt"><p>Checks if the point <code>point</code> is contained in this shape.</p></div> - - <div class="block"> - attributes: abstract - </div> - - - </div> - </li><li name="sims.dynamics.Shape#density"> - <h4 class="signature"> - <span class="kind">val</span> - <span class="symbol"> - <span class="name">density</span><span class="result">: <span class="extype" name="scala.Double">Double</span></span> - </span> - </h4> - <p class="shortcomment cmt">Density</p><div class="fullcomment"> - <div class="comment cmt"><p>Density. (Mass per area)</p></div> - - <div class="block"> - attributes: abstract - </div> - - - </div> - </li><li name="scala.AnyRef#equals"> - <h4 class="signature"> - <span class="kind">def</span> - <span class="symbol"> - <span class="name">equals</span><span class="params">(<span name="arg0">arg0: <span class="extype" name="scala.Any">Any</span></span>)</span><span class="result">: <span class="extype" name="scala.Boolean">Boolean</span></span> - </span> - </h4> - <p class="shortcomment cmt">This method is used to compare the receiver object (<code>this</code>) -with the argument object (<code>arg0</code>) for equivalence</p><div class="fullcomment"> - <div class="comment cmt"><p>This method is used to compare the receiver object (<code>this</code>) -with the argument object (<code>arg0</code>) for equivalence.</p><p><p> -The default implementations of this method is an <a -href="http://en.wikipedia.org/wiki/Equivalence_relation">equivalence -relation</a>: - <ul> - <li>It is reflexive: for any instance <code>x</code> of type <code>Any</code>, - <code>x.equals(x)</code> should return <code>true</code>.</li> - <li>It is symmetric: for any instances <code>x</code> and <code>y</code> of type - <code>Any</code>, <code>x.equals(y)</code> should return <code>true</code> if and only - if <code>y.equals(x)</code> returns <code>true</code>.</li> - <li>It is transitive: for any instances - <code>x</code>, <code>y</code>, and <code>z</code> of type <code>AnyRef</code> - if <code>x.equals(y)</code> returns <code>true</code> and - <code>y.equals(z)</code> returns - <code>true</code>, then <code>x.equals(z)</code> should return <code>true</code>.</li> -</ul> -</p></p><p><p> -If you override this method, you should verify that -your implementation remains an equivalence relation. -Additionally, when overriding this method it is often necessary to -override <code>hashCode</code> to ensure that objects that are -"equal" (<code>o1.equals(o2)</code> returns <code>true</code>) -hash to the same <a href="Int.html"><code>Int</code></a> -(<code>o1.hashCode.equals(o2.hashCode)</code>). -</p></div> - <dl class="paramcmts block"><dt class="param">arg0</dt><dd class="cmt"><p>the object to compare against this object for equality.</p></dd><dt>returns</dt><dd class="cmt"><p><code>true</code> if the receiver object is equivalent to the argument; <code>false</code> otherwise. -</p></p></dd></dl> - - <div class="block"> - definition classes: AnyRef ⇐ Any - </div> - - </div> - </li><li name="sims.dynamics.Shape#friction"> - <h4 class="signature"> - <span class="kind">var</span> - <span class="symbol"> - <span class="name">friction</span><span class="result">: <span class="extype" name="scala.Double">Double</span></span> - </span> - </h4> - <p class="shortcomment cmt">Part of the coefficient of friction for a collision between this shape and another</p><div class="fullcomment"> - <div class="comment cmt"><p>Part of the coefficient of friction for a collision between this shape and another. -The coefficient of friction is calculated out of the product of this part and the other shape's part.</p></div> - - - - - </div> - </li><li name="scala.AnyRef#hashCode"> - <h4 class="signature"> - <span class="kind">def</span> - <span class="symbol"> - <span class="name">hashCode</span><span class="params">()</span><span class="result">: <span class="extype" name="scala.Int">Int</span></span> - </span> - </h4> - <p class="shortcomment cmt">Returns a hash code value for the object</p><div class="fullcomment"> - <div class="comment cmt"><p>Returns a hash code value for the object.</p><p><p> -The default hashing algorithm is platform dependent.</p><p>Note that it is allowed for two objects to have identical hash -codes (<code>o1.hashCode.equals(o2.hashCode)</code>) yet not be -equal (<code>o1.equals(o2)</code> returns <code>false</code>). A -degenerate implementation could always return <code>0</code>. -However, it is required that if two objects are equal -(<code>o1.equals(o2)</code> returns <code>true</code>) that they -have identical hash codes -(<code>o1.hashCode.equals(o2.hashCode)</code>). Therefore, when -overriding this method, be sure to verify that the behavior is -consistent with the <code>equals</code> method. -</p></p><p><p></p></div> - - - <div class="block"> - definition classes: AnyRef ⇐ Any - </div> - - </div> - </li><li name="sims.dynamics.Shape#mass"> - <h4 class="signature"> - <span class="kind">def</span> - <span class="symbol"> - <span class="name">mass</span><span class="result">: <span class="extype" name="scala.Double">Double</span></span> - </span> - </h4> - <p class="shortcomment cmt">Returns the mass of this shape</p><div class="fullcomment"> - <div class="comment cmt"><p>Returns the mass of this shape. The mass is given by volume times density.</p></div> - - - - - </div> - </li><li name="sims.dynamics.Shape#pos"> - <h4 class="signature"> - <span class="kind">var</span> - <span class="symbol"> - <span class="name">pos</span><span class="result">: <a href="../geometry/Vector2D.html" class="extype" name="sims.geometry.Vector2D">Vector2D</a></span> - </span> - </h4> - <p class="shortcomment cmt">Position of this shape's COM (in world coordinates)</p><div class="fullcomment"> - <div class="comment cmt"><p>Position of this shape's COM (in world coordinates).</p></div> - - - - - </div> - </li><li name="sims.dynamics.Shape#project"> - <h4 class="signature"> - <span class="kind">def</span> - <span class="symbol"> - <span class="name">project</span><span class="params">(<span name="axis">axis: <a href="../geometry/Vector2D.html" class="extype" name="sims.geometry.Vector2D">Vector2D</a></span>)</span><span class="result">: <a href="../geometry/Projection.html" class="extype" name="sims.geometry.Projection">Projection</a></span> - </span> - </h4> - <p class="shortcomment cmt">Returns the projection of this shape onto the line given by the directional vector <code>axis</code></p><div class="fullcomment"> - <div class="comment cmt"><p>Returns the projection of this shape onto the line given by the directional vector <code>axis</code>.</p></div> - <dl class="paramcmts block"><dt class="param">axis</dt><dd class="cmt"><p>directional vector of the line</p></dd><dt>returns</dt><dd class="cmt"><p>projection of this shape</p></dd></dl> - <div class="block"> - attributes: abstract - </div> - - - </div> - </li><li name="sims.dynamics.Shape#refLocalPos"> - <h4 class="signature"> - <span class="kind">var</span> - <span class="symbol"> - <span class="name">refLocalPos</span><span class="result">: <a href="../geometry/Vector2D.html" class="extype" name="sims.geometry.Vector2D">Vector2D</a></span> - </span> - </h4> - <p class="shortcomment cmt">Local position of this shape's body COM to its COM at a body rotation of zero</p><div class="fullcomment"> - <div class="comment cmt"><p>Local position of this shape's body COM to its COM at a body rotation of zero.</p></div> - - - - - </div> - </li><li name="sims.dynamics.Shape#restitution"> - <h4 class="signature"> - <span class="kind">var</span> - <span class="symbol"> - <span class="name">restitution</span><span class="result">: <span class="extype" name="scala.Double">Double</span></span> - </span> - </h4> - <p class="shortcomment cmt">Part of the coefficient of restitution for a collision between this shape and another</p><div class="fullcomment"> - <div class="comment cmt"><p>Part of the coefficient of restitution for a collision between this shape and another. -The coefficient of restitution is calculated out of the product of this part and the other shape's part.</p></div> - - - - - </div> - </li><li name="sims.dynamics.Shape#rotation"> - <h4 class="signature"> - <span class="kind">var</span> - <span class="symbol"> - <span class="name">rotation</span><span class="result">: <span class="extype" name="scala.Double">Double</span></span> - </span> - </h4> - <p class="shortcomment cmt">Rotation of this shape about its COM</p><div class="fullcomment"> - <div class="comment cmt"><p>Rotation of this shape about its COM.</p></div> - - - - - </div> - </li><li name="sims.dynamics.Shape#rotation0"> - <h4 class="signature"> - <span class="kind">var</span> - <span class="symbol"> - <span class="name">rotation0</span><span class="result">: <span class="extype" name="scala.Double">Double</span></span> - </span> - </h4> - <p class="shortcomment cmt">Initial rotation</p><div class="fullcomment"> - <div class="comment cmt"><p>Initial rotation. Rotation of this shape before it was added to a body.</p></div> - - - - - </div> - </li><li name="scala.AnyRef#toString"> - <h4 class="signature"> - <span class="kind">def</span> - <span class="symbol"> - <span class="name">toString</span><span class="params">()</span><span class="result">: <span class="extype" name="java.lang.String">String</span></span> - </span> - </h4> - <p class="shortcomment cmt">Returns a string representation of the object</p><div class="fullcomment"> - <div class="comment cmt"><p>Returns a string representation of the object. -<p> -The default representation is platform dependent. -</p></div> - - - <div class="block"> - definition classes: AnyRef ⇐ Any - </div> - - </div> - </li><li name="sims.dynamics.Shape#transientShapes"> - <h4 class="signature"> - <span class="kind">val</span> - <span class="symbol"> - <span class="name">transientShapes</span><span class="result">: <span class="extype" name="scala.collection.mutable.Set">Set</span>[<a href="" class="extype" name="sims.dynamics.Shape">Shape</a>]</span> - </span> - </h4> - <p class="shortcomment cmt">Shapes with which this shape cannot collide</p><div class="fullcomment"> - <div class="comment cmt"><p>Shapes with which this shape cannot collide.</p></div> - - - - - </div> - </li><li name="sims.dynamics.Shape#uid"> - <h4 class="signature"> - <span class="kind">val</span> - <span class="symbol"> - <span class="name">uid</span><span class="result">: <span class="extype" name="scala.Int">Int</span></span> - </span> - </h4> - <p class="shortcomment cmt">Unique identification number</p><div class="fullcomment"> - <div class="comment cmt"><p>Unique identification number.</p></div> - - - - - </div> - </li><li name="sims.dynamics.Shape#volume"> - <h4 class="signature"> - <span class="kind">val</span> - <span class="symbol"> - <span class="name">volume</span><span class="result">: <span class="extype" name="scala.Double">Double</span></span> - </span> - </h4> - <p class="shortcomment cmt">Volume</p><div class="fullcomment"> - <div class="comment cmt"><p>Volume. The volume is actually equivalent to this shape's area (SiMS is in 2D) -and is used with this shape's density to calculate its mass.</p></div> - - <div class="block"> - attributes: abstract - </div> - - - </div> - </li><li name="sims.dynamics.Shape#~"> - <h4 class="signature"> - <span class="kind">def</span> - <span class="symbol"> - <span class="name">~</span><span class="params">(<span name="b">b: <a href="Body.html" class="extype" name="sims.dynamics.Body">Body</a></span>)</span><span class="result">: <a href="Body.html" class="extype" name="sims.dynamics.Body">Body</a></span> - </span> - </h4> - <p class="shortcomment cmt">Creates a new body out of this shape and the shapes of body <code>b</code></p><div class="fullcomment"> - <div class="comment cmt"><p>Creates a new body out of this shape and the shapes of body <code>b</code>.</p></div> - - - - - </div> - </li><li name="sims.dynamics.Shape#~"> - <h4 class="signature"> - <span class="kind">def</span> - <span class="symbol"> - <span class="name">~</span><span class="params">(<span name="s">s: <a href="" class="extype" name="sims.dynamics.Shape">Shape</a></span>)</span><span class="result">: <a href="Body.html" class="extype" name="sims.dynamics.Body">Body</a></span> - </span> - </h4> - <p class="shortcomment cmt">Creates a new body out of this shape and the shape <code>s</code></p><div class="fullcomment"> - <div class="comment cmt"><p>Creates a new body out of this shape and the shape <code>s</code>.</p></div> - - - - - </div> - </li></ol> - </div> - - <div class="members" id="constructors"> - <h3>Instance constructors</h3> - <ol><li name="sims.dynamics.Shape#this"> - <h4 class="signature"> - <span class="kind">new</span> - <span class="symbol"> - <span class="name">Shape</span><span class="params">()</span> - </span> - </h4> - - </li></ol> - </div> - - </div> - - </body> - </html>
\ No newline at end of file |