diff options
author | Jakob Odersky <jodersky@gmail.com> | 2015-06-29 12:36:03 +0200 |
---|---|---|
committer | Jakob Odersky <jodersky@gmail.com> | 2015-06-29 12:36:03 +0200 |
commit | 3bc7d76b5da00781908da82cd0e989885323396f (patch) | |
tree | 991e0f0265057a2fed3c5052433c56ef7fb36248 /doc/sims/dynamics/joints/SpringJoint.html | |
parent | 01c5c700647feba596e02cb7a2e672f5301504ff (diff) | |
download | sims-3bc7d76b5da00781908da82cd0e989885323396f.tar.gz sims-3bc7d76b5da00781908da82cd0e989885323396f.tar.bz2 sims-3bc7d76b5da00781908da82cd0e989885323396f.zip |
remove old scaladoc
Diffstat (limited to 'doc/sims/dynamics/joints/SpringJoint.html')
-rw-r--r-- | doc/sims/dynamics/joints/SpringJoint.html | 419 |
1 files changed, 0 insertions, 419 deletions
diff --git a/doc/sims/dynamics/joints/SpringJoint.html b/doc/sims/dynamics/joints/SpringJoint.html deleted file mode 100644 index 699f2e0..0000000 --- a/doc/sims/dynamics/joints/SpringJoint.html +++ /dev/null @@ -1,419 +0,0 @@ -<?xml version='1.0' encoding='UTF-8'?> -<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.1//EN" "http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd"> -<html> - <head> - <title>Scaladoc for sims.dynamics.joints.SpringJoint</title> - <meta http-equiv="content-type" content="text/html; charset=UTF-8" /> - <script type="text/javascript" src="../../../lib/jquery.js"></script> - - <style type="text/css"> - @import url(../../../lib/template.css) screen; - </style> - <script type="text/javascript" src="../../../lib/template.js"></script> - - </head> - <body class="type"> - - <p id="owner"><a href="../../package.html">sims</a>.<a href="../package.html">dynamics</a>.<a href="package.html">joints</a></p> - - <div id="definition"> - <img src="../../../lib/class_big.png" /> - <h1>SpringJoint</h1> - </div> - - <h4 class="signature"> - <span class="kind">class</span> - <span class="symbol"> - <span class="name">SpringJoint</span><span class="params">(<span name="node1">node1: <a href="../Body.html" class="extype" name="sims.dynamics.Body">Body</a></span>, <span name="anchor1">anchor1: <a href="../../geometry/Vector2D.html" class="extype" name="sims.geometry.Vector2D">Vector2D</a></span>, <span name="node2">node2: <a href="../Body.html" class="extype" name="sims.dynamics.Body">Body</a></span>, <span name="anchor2">anchor2: <a href="../../geometry/Vector2D.html" class="extype" name="sims.geometry.Vector2D">Vector2D</a></span>, <span name="springConstant">springConstant: <span class="extype" name="scala.Double">Double</span></span>, <span name="initialLength">initialLength: <span class="extype" name="scala.Double">Double</span></span>)</span><span class="result"> extends <a href="Joint.html" class="extype" name="sims.dynamics.joints.Joint">Joint</a> with <a href="ForceJoint.html" class="extype" name="sims.dynamics.joints.ForceJoint">ForceJoint</a> with <span class="extype" name="scala.Product">Product</span></span> - </span> - </h4> - <div class="fullcomment" id="comment"> - <div class="comment cmt"><p>A spring obeying Hooke's law.</p></div> - <dl class="paramcmts block"><dt class="param">node1</dt><dd class="cmt"><p>first associated body</p></dd><dt class="param">anchor1</dt><dd class="cmt"><p>first connection point</p></dd><dt class="param">node2</dt><dd class="cmt"><p>second associated body</p></dd><dt class="param">anchor2</dt><dd class="cmt"><p>second connection point</p></dd><dt class="param">springConstant</dt><dd class="cmt"><p>spring constant</p></dd><dt class="param">initialLength</dt><dd class="cmt"><p>initial length</p></dd></dl> - - - - </div> - - <div id="template"> - - <div id="mbrsel"> - <div id="ancestors"> - <h3>Inherits</h3> - <ol><li class="in" name="scala.Product">Product</li><li class="in" name="scala.Equals">Equals</li><li class="in" name="sims.dynamics.joints.ForceJoint">ForceJoint</li><li class="in" name="sims.dynamics.joints.Joint">Joint</li><li class="in" name="sims.dynamics.Constraint">Constraint</li><li class="in" name="scala.AnyRef">AnyRef</li><li class="in" name="scala.Any">Any</li></ol> - </div> - </div> - - - - <div class="members" id="values"> - <h3>Value Members</h3> - <ol><li name="sims.dynamics.joints.SpringJoint#anchor1"> - <h4 class="signature"> - <span class="kind">val</span> - <span class="symbol"> - <span class="name">anchor1</span><span class="result">: <a href="../../geometry/Vector2D.html" class="extype" name="sims.geometry.Vector2D">Vector2D</a></span> - </span> - </h4> - - </li><li name="sims.dynamics.joints.SpringJoint#anchor2"> - <h4 class="signature"> - <span class="kind">val</span> - <span class="symbol"> - <span class="name">anchor2</span><span class="result">: <a href="../../geometry/Vector2D.html" class="extype" name="sims.geometry.Vector2D">Vector2D</a></span> - </span> - </h4> - - </li><li name="sims.dynamics.joints.SpringJoint#applyForce"> - <h4 class="signature"> - <span class="kind">def</span> - <span class="symbol"> - <span class="name">applyForce</span><span class="params">()</span><span class="result">: <span class="extype" name="scala.Unit">Unit</span></span> - </span> - </h4> - <p class="shortcomment cmt">Applies the spring force to the connection points</p><div class="fullcomment"> - <div class="comment cmt"><p>Applies the spring force to the connection points.</p></div> - - - - - </div> - </li><li name="sims.dynamics.joints.SpringJoint#canEqual"> - <h4 class="signature"> - <span class="kind">def</span> - <span class="symbol"> - <span class="name">canEqual</span><span class="params">(<span name="arg0">arg0: <span class="extype" name="scala.Any">Any</span></span>)</span><span class="result">: <span class="extype" name="scala.Boolean">Boolean</span></span> - </span> - </h4> - - </li><li name="sims.dynamics.joints.SpringJoint#connection1"> - <h4 class="signature"> - <span class="kind">def</span> - <span class="symbol"> - <span class="name">connection1</span><span class="result">: <a href="../../geometry/Vector2D.html" class="extype" name="sims.geometry.Vector2D">Vector2D</a></span> - </span> - </h4> - <p class="shortcomment cmt">Returns the connection point on body one (in world coordinates)</p><div class="fullcomment"> - <div class="comment cmt"><p>Returns the connection point on body one (in world coordinates).</p></div> - - - - - </div> - </li><li name="sims.dynamics.joints.SpringJoint#connection2"> - <h4 class="signature"> - <span class="kind">def</span> - <span class="symbol"> - <span class="name">connection2</span><span class="result">: <a href="../../geometry/Vector2D.html" class="extype" name="sims.geometry.Vector2D">Vector2D</a></span> - </span> - </h4> - <p class="shortcomment cmt">Returns the connection point on body two (in world coordinates)</p><div class="fullcomment"> - <div class="comment cmt"><p>Returns the connection point on body two (in world coordinates).</p></div> - - - - - </div> - </li><li name="sims.dynamics.joints.SpringJoint#correctPosition"> - <h4 class="signature"> - <span class="kind">def</span> - <span class="symbol"> - <span class="name">correctPosition</span><span class="params">(<span name="h">h: <span class="extype" name="scala.Double">Double</span></span>)</span><span class="result">: <span class="extype" name="scala.Unit">Unit</span></span> - </span> - </h4> - <p class="shortcomment cmt">Corrects the positions of this joint's associated bodies</p><div class="fullcomment"> - <div class="comment cmt"><p>Corrects the positions of this joint's associated bodies.@param h a time interval, used for converting forces and impulses</p></div> - - - - - </div> - </li><li name="sims.dynamics.joints.SpringJoint#correctVelocity"> - <h4 class="signature"> - <span class="kind">def</span> - <span class="symbol"> - <span class="name">correctVelocity</span><span class="params">(<span name="h">h: <span class="extype" name="scala.Double">Double</span></span>)</span><span class="result">: <span class="extype" name="scala.Unit">Unit</span></span> - </span> - </h4> - <p class="shortcomment cmt">Corrects the velocities of this joint's associated bodies</p><div class="fullcomment"> - <div class="comment cmt"><p>Corrects the velocities of this joint's associated bodies.@param h a time interval, used for converting forces and impulses</p></div> - - - - - </div> - </li><li name="sims.dynamics.joints.SpringJoint#damping"> - <h4 class="signature"> - <span class="kind">var</span> - <span class="symbol"> - <span class="name">damping</span><span class="result">: <span class="extype" name="scala.Double">Double</span></span> - </span> - </h4> - <p class="shortcomment cmt">Damping</p><div class="fullcomment"> - <div class="comment cmt"><p>Damping.</p></div> - - - - - </div> - </li><li name="sims.dynamics.joints.SpringJoint#equals"> - <h4 class="signature"> - <span class="kind">def</span> - <span class="symbol"> - <span class="name">equals</span><span class="params">(<span name="arg0">arg0: <span class="extype" name="scala.Any">Any</span></span>)</span><span class="result">: <span class="extype" name="scala.Boolean">Boolean</span></span> - </span> - </h4> - <p class="shortcomment cmt">This method is used to compare the receiver object (<code>this</code>) -with the argument object (<code>arg0</code>) for equivalence</p><div class="fullcomment"> - <div class="comment cmt"><p>This method is used to compare the receiver object (<code>this</code>) -with the argument object (<code>arg0</code>) for equivalence.</p><p><p> -The default implementations of this method is an <a -href="http://en.wikipedia.org/wiki/Equivalence_relation">equivalence -relation</a>: - <ul> - <li>It is reflexive: for any instance <code>x</code> of type <code>Any</code>, - <code>x.equals(x)</code> should return <code>true</code>.</li> - <li>It is symmetric: for any instances <code>x</code> and <code>y</code> of type - <code>Any</code>, <code>x.equals(y)</code> should return <code>true</code> if and only - if <code>y.equals(x)</code> returns <code>true</code>.</li> - <li>It is transitive: for any instances - <code>x</code>, <code>y</code>, and <code>z</code> of type <code>AnyRef</code> - if <code>x.equals(y)</code> returns <code>true</code> and - <code>y.equals(z)</code> returns - <code>true</code>, then <code>x.equals(z)</code> should return <code>true</code>.</li> -</ul> -</p></p><p><p> -If you override this method, you should verify that -your implementation remains an equivalence relation. -Additionally, when overriding this method it is often necessary to -override <code>hashCode</code> to ensure that objects that are -"equal" (<code>o1.equals(o2)</code> returns <code>true</code>) -hash to the same <a href="Int.html"><code>Int</code></a> -(<code>o1.hashCode.equals(o2.hashCode)</code>). -</p></div> - <dl class="paramcmts block"><dt class="param">arg0</dt><dd class="cmt"><p>the object to compare against this object for equality.</p></dd><dt>returns</dt><dd class="cmt"><p><code>true</code> if the receiver object is equivalent to the argument; <code>false</code> otherwise. -</p></p></dd></dl> - - - - </div> - </li><li name="sims.dynamics.joints.SpringJoint#force"> - <h4 class="signature"> - <span class="kind">def</span> - <span class="symbol"> - <span class="name">force</span><span class="result">: <span class="extype" name="scala.Double">Double</span></span> - </span> - </h4> - <p class="shortcomment cmt">Returns the spring force</p><div class="fullcomment"> - <div class="comment cmt"><p>Returns the spring force.</p></div> - - - - - </div> - </li><li name="sims.dynamics.joints.SpringJoint#hashCode"> - <h4 class="signature"> - <span class="kind">def</span> - <span class="symbol"> - <span class="name">hashCode</span><span class="params">()</span><span class="result">: <span class="extype" name="scala.Int">Int</span></span> - </span> - </h4> - <p class="shortcomment cmt">Returns a hash code value for the object</p><div class="fullcomment"> - <div class="comment cmt"><p>Returns a hash code value for the object.</p><p><p> -The default hashing algorithm is platform dependent.</p><p>Note that it is allowed for two objects to have identical hash -codes (<code>o1.hashCode.equals(o2.hashCode)</code>) yet not be -equal (<code>o1.equals(o2)</code> returns <code>false</code>). A -degenerate implementation could always return <code>0</code>. -However, it is required that if two objects are equal -(<code>o1.equals(o2)</code> returns <code>true</code>) that they -have identical hash codes -(<code>o1.hashCode.equals(o2.hashCode)</code>). Therefore, when -overriding this method, be sure to verify that the behavior is -consistent with the <code>equals</code> method. -</p></p><p><p></p></div> - - - - - </div> - </li><li name="sims.dynamics.joints.SpringJoint#initialLength"> - <h4 class="signature"> - <span class="kind">val</span> - <span class="symbol"> - <span class="name">initialLength</span><span class="result">: <span class="extype" name="scala.Double">Double</span></span> - </span> - </h4> - - </li><li name="sims.dynamics.joints.SpringJoint#node1"> - <h4 class="signature"> - <span class="kind">val</span> - <span class="symbol"> - <span class="name">node1</span><span class="result">: <a href="../Body.html" class="extype" name="sims.dynamics.Body">Body</a></span> - </span> - </h4> - <p class="shortcomment cmt">First body of the joint</p><div class="fullcomment"> - <div class="comment cmt"><p>First body of the joint.</p></div> - - - - - </div> - </li><li name="sims.dynamics.joints.SpringJoint#node2"> - <h4 class="signature"> - <span class="kind">val</span> - <span class="symbol"> - <span class="name">node2</span><span class="result">: <a href="../Body.html" class="extype" name="sims.dynamics.Body">Body</a></span> - </span> - </h4> - <p class="shortcomment cmt">Second body of the joint</p><div class="fullcomment"> - <div class="comment cmt"><p>Second body of the joint.</p></div> - - - - - </div> - </li><li name="sims.dynamics.joints.SpringJoint#productArity"> - <h4 class="signature"> - <span class="kind">def</span> - <span class="symbol"> - <span class="name">productArity</span><span class="result">: <span class="extype" name="scala.Int">Int</span></span> - </span> - </h4> - - </li><li name="sims.dynamics.joints.SpringJoint#productElement"> - <h4 class="signature"> - <span class="kind">def</span> - <span class="symbol"> - <span class="name">productElement</span><span class="params">(<span name="arg0">arg0: <span class="extype" name="scala.Int">Int</span></span>)</span><span class="result">: <span class="extype" name="scala.Any">Any</span></span> - </span> - </h4> - - </li><li name="scala.Product#productElements"> - <h4 class="signature"> - <span class="kind">def</span> - <span class="symbol"> - <span class="name">productElements</span><span class="result">: <span class="extype" name="scala.collection.Iterator">Iterator</span>[<span class="extype" name="scala.Any">Any</span>]</span> - </span> - </h4> - - </li><li name="scala.Product#productIterator"> - <h4 class="signature"> - <span class="kind">def</span> - <span class="symbol"> - <span class="name">productIterator</span><span class="result">: <span class="extype" name="scala.collection.Iterator">Iterator</span>[<span class="extype" name="scala.Any">Any</span>]</span> - </span> - </h4> - - </li><li name="sims.dynamics.joints.SpringJoint#productPrefix"> - <h4 class="signature"> - <span class="kind">def</span> - <span class="symbol"> - <span class="name">productPrefix</span><span class="result">: <span class="extype" name="java.lang.String">String</span></span> - </span> - </h4> - - </li><li name="sims.dynamics.joints.SpringJoint#springConstant"> - <h4 class="signature"> - <span class="kind">val</span> - <span class="symbol"> - <span class="name">springConstant</span><span class="result">: <span class="extype" name="scala.Double">Double</span></span> - </span> - </h4> - - </li><li name="sims.dynamics.joints.SpringJoint#toString"> - <h4 class="signature"> - <span class="kind">def</span> - <span class="symbol"> - <span class="name">toString</span><span class="params">()</span><span class="result">: <span class="extype" name="java.lang.String">String</span></span> - </span> - </h4> - <p class="shortcomment cmt">Returns a string representation of the object</p><div class="fullcomment"> - <div class="comment cmt"><p>Returns a string representation of the object. -<p> -The default representation is platform dependent. -</p></div> - - - - - </div> - </li><li name="sims.dynamics.joints.SpringJoint#v"> - <h4 class="signature"> - <span class="kind">def</span> - <span class="symbol"> - <span class="name">v</span><span class="result">: <a href="../../geometry/Vector2D.html" class="extype" name="sims.geometry.Vector2D">Vector2D</a></span> - </span> - </h4> - <p class="shortcomment cmt">Relative velocity of the connection points</p><div class="fullcomment"> - <div class="comment cmt"><p>Relative velocity of the connection points.</p></div> - - - - - </div> - </li><li name="sims.dynamics.joints.SpringJoint#x"> - <h4 class="signature"> - <span class="kind">def</span> - <span class="symbol"> - <span class="name">x</span><span class="result">: <a href="../../geometry/Vector2D.html" class="extype" name="sims.geometry.Vector2D">Vector2D</a></span> - </span> - </h4> - <p class="shortcomment cmt">Relative position of the connection points</p><div class="fullcomment"> - <div class="comment cmt"><p>Relative position of the connection points.</p></div> - - - - - </div> - </li></ol> - </div> - - <div class="members" id="constructors"> - <h3>Instance constructors</h3> - <ol><li name="sims.dynamics.joints.SpringJoint#this"> - <h4 class="signature"> - <span class="kind">new</span> - <span class="symbol"> - <span class="name">SpringJoint</span><span class="params">(<span name="node1">node1: <a href="../Body.html" class="extype" name="sims.dynamics.Body">Body</a></span>, <span name="node2">node2: <a href="../Body.html" class="extype" name="sims.dynamics.Body">Body</a></span>, <span name="springConstant">springConstant: <span class="extype" name="scala.Double">Double</span></span>)</span> - </span> - </h4> - - </li><li name="sims.dynamics.joints.SpringJoint#this"> - <h4 class="signature"> - <span class="kind">new</span> - <span class="symbol"> - <span class="name">SpringJoint</span><span class="params">(<span name="node1">node1: <a href="../Body.html" class="extype" name="sims.dynamics.Body">Body</a></span>, <span name="node2">node2: <a href="../Body.html" class="extype" name="sims.dynamics.Body">Body</a></span>, <span name="springConstant">springConstant: <span class="extype" name="scala.Double">Double</span></span>, <span name="initialLength">initialLength: <span class="extype" name="scala.Double">Double</span></span>)</span> - </span> - </h4> - - </li><li name="sims.dynamics.joints.SpringJoint#this"> - <h4 class="signature"> - <span class="kind">new</span> - <span class="symbol"> - <span class="name">SpringJoint</span><span class="params">(<span name="node1">node1: <a href="../Body.html" class="extype" name="sims.dynamics.Body">Body</a></span>, <span name="anchor1">anchor1: <a href="../../geometry/Vector2D.html" class="extype" name="sims.geometry.Vector2D">Vector2D</a></span>, <span name="node2">node2: <a href="../Body.html" class="extype" name="sims.dynamics.Body">Body</a></span>, <span name="anchor2">anchor2: <a href="../../geometry/Vector2D.html" class="extype" name="sims.geometry.Vector2D">Vector2D</a></span>, <span name="springConstant">springConstant: <span class="extype" name="scala.Double">Double</span></span>)</span> - </span> - </h4> - - </li><li name="sims.dynamics.joints.SpringJoint#this"> - <h4 class="signature"> - <span class="kind">new</span> - <span class="symbol"> - <span class="name">SpringJoint</span><span class="params">(<span name="node1">node1: <a href="../Body.html" class="extype" name="sims.dynamics.Body">Body</a></span>, <span name="anchor1">anchor1: <a href="../../geometry/Vector2D.html" class="extype" name="sims.geometry.Vector2D">Vector2D</a></span>, <span name="node2">node2: <a href="../Body.html" class="extype" name="sims.dynamics.Body">Body</a></span>, <span name="anchor2">anchor2: <a href="../../geometry/Vector2D.html" class="extype" name="sims.geometry.Vector2D">Vector2D</a></span>, <span name="springConstant">springConstant: <span class="extype" name="scala.Double">Double</span></span>, <span name="initialLength">initialLength: <span class="extype" name="scala.Double">Double</span></span>)</span> - </span> - </h4> - - </li><li name="sims.dynamics.joints.Joint#this"> - <h4 class="signature"> - <span class="kind">new</span> - <span class="symbol"> - <span class="name">SpringJoint</span><span class="params">()</span> - </span> - </h4> - - </li></ol> - </div> - - </div> - - </body> - </html>
\ No newline at end of file |