diff options
Diffstat (limited to 'doc/sims/prefabs/Net.html')
-rw-r--r-- | doc/sims/prefabs/Net.html | 439 |
1 files changed, 215 insertions, 224 deletions
diff --git a/doc/sims/prefabs/Net.html b/doc/sims/prefabs/Net.html index 0298260..584df7a 100644 --- a/doc/sims/prefabs/Net.html +++ b/doc/sims/prefabs/Net.html @@ -1,232 +1,223 @@ -<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
+<?xml version='1.0' encoding='UTF-8'?> +<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.1//EN" "http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd"> <html> - <head><title>class Net in sims.prefabs</title> - <meta http-equiv="content-type" content="text/html; charset=UTF8"></meta><meta content="scaladoc (version 2.7.5.final)" name="generator"></meta><link href="../../style.css" type="text/css" rel="stylesheet"></link><script type="text/javascript" src="../../script.js"></script> + <head> + <title>Scaladoc for sims.prefabs.Net</title> + <meta http-equiv="content-type" content="text/html; charset=UTF-8" /> + <script type="text/javascript" src="../../lib/jquery.js"></script> + + <style type="text/css"> + @import url(../../lib/template.css) screen; + </style> + <script type="text/javascript" src="../../lib/template.js"></script> + </head> - <body onload="init()"> - <table summary="" class="navigation"> - <tr> - <td class="navigation-links" valign="top"> - <!-- <table><tr></tr></table> --> - </td> - <td align="right" valign="top" style="white-space:nowrap;" rowspan="2"> - <div class="doctitle-larger">SiMS</div> - </td> - </tr> - <tr><td></td></tr> - </table> - - <div class="entity"> - <a href="../../sims/prefabs$package.html" target="_self">sims.prefabs</a> - <br></br> - <span class="entity">class Net</span> - </div><hr></hr> - <div class="source"> - [source: <a href="" class="sims/prefabs/Net"><code>sims/prefabs/Net.scala</code></a>] - </div><hr></hr> - <a name="Net"></a><dl> - <dt> - - <code></code> - <code>class</code> - <em>Net</em>(<em>width</em> : <a href="http://www.scala-lang.org/docu/files/api/scala/Int.html" target="_self">Int</a>, <em>height</em> : <a href="http://www.scala-lang.org/docu/files/api/scala/Int.html" target="_self">Int</a>, <em>initPos</em> : <a href="../../sims/geometry/Vector2D.html" target="_self">Vector2D</a>) - </dt> - <dd><code> extends </code><a href="../../sims/prefabs/Prefab.html" target="_self">Prefab</a></dd> - </dl> + <body class="type"> + <p id="owner"><a href="../package.html">sims</a>.<a href="package.html">prefabs</a></p> -<table summary="" cellpadding="3" class="member"> - <tr><td class="title" colspan="2">Value Summary</td></tr> - <tr> - <td class="modifiers" valign="top"> - <code>override val</code> - </td> - <td class="signature"> - <em><a href="../../sims/prefabs/Net.html#bodies" target="_self">bodies</a></em> - : <a href="" target="contentFrame" class="scala/List">scala.List</a>[<a href="../../sims/dynamics/Body.html" target="_self">Body</a>] - - - </td> - </tr> -<tr> - <td class="modifiers" valign="top"> - <code>override val</code> - </td> - <td class="signature"> - <em><a href="../../sims/prefabs/Net.html#joints" target="_self">joints</a></em> - : <a href="" target="contentFrame" class="scala/List">scala.List</a>[<a href="../../sims/dynamics/joints/DistanceJoint.html" target="_self">DistanceJoint</a>] - - - </td> - </tr> -<tr> - <td class="modifiers" valign="top"> - <code> val</code> - </td> - <td class="signature"> - <em><a href="../../sims/prefabs/Net.html#nodeDensity" target="_self">nodeDensity</a></em> - : <a href="http://www.scala-lang.org/docu/files/api/scala/Double.html" target="_self">Double</a> - - - </td> - </tr> -<tr> - <td class="modifiers" valign="top"> - <code> val</code> - </td> - <td class="signature"> - <em><a href="../../sims/prefabs/Net.html#nodeDistance" target="_self">nodeDistance</a></em> - : <a href="http://www.scala-lang.org/docu/files/api/scala/Double.html" target="_self">Double</a> - - - </td> - </tr> -<tr> - <td class="modifiers" valign="top"> - <code> val</code> - </td> - <td class="signature"> - <em><a href="../../sims/prefabs/Net.html#nodeRadius" target="_self">nodeRadius</a></em> - : <a href="http://www.scala-lang.org/docu/files/api/scala/Double.html" target="_self">Double</a> - - - </td> - </tr> -<tr> - <td class="modifiers" valign="top"> - <code> val</code> - </td> - <td class="signature"> - <em><a href="../../sims/prefabs/Net.html#springConstant" target="_self">springConstant</a></em> - : <a href="http://www.scala-lang.org/docu/files/api/scala/Double.html" target="_self">Double</a> - - - </td> - </tr> -<tr> - <td class="modifiers" valign="top"> - <code> val</code> - </td> - <td class="signature"> - <em><a href="../../sims/prefabs/Net.html#springDamping" target="_self">springDamping</a></em> - : <a href="http://www.scala-lang.org/docu/files/api/scala/Double.html" target="_self">Double</a> - - - </td> - </tr> - </table> -<table summary="" cellpadding="3" class="inherited"> - <tr><td class="title" colspan="2"> - Methods inherited from <a href="http://www.scala-lang.org/docu/files/api/scala/AnyRef.html" target="_self">AnyRef</a> - </td></tr> - <tr><td class="signature" colspan="2"> - <a href="http://www.scala-lang.org/docu/files/api/scala/AnyRef.html#getClass%28%29" target="_self">getClass</a>, <a href="http://www.scala-lang.org/docu/files/api/scala/AnyRef.html#hashCode%28%29" target="_self">hashCode</a>, <a href="http://www.scala-lang.org/docu/files/api/scala/AnyRef.html#equals%28Any%29" target="_self">equals</a>, <a href="http://www.scala-lang.org/docu/files/api/scala/AnyRef.html#clone%28%29" target="_self">clone</a>, <a href="http://www.scala-lang.org/docu/files/api/scala/AnyRef.html#toString%28%29" target="_self">toString</a>, <a href="http://www.scala-lang.org/docu/files/api/scala/AnyRef.html#notify%28%29" target="_self">notify</a>, <a href="http://www.scala-lang.org/docu/files/api/scala/AnyRef.html#notifyAll%28%29" target="_self">notifyAll</a>, <a href="http://www.scala-lang.org/docu/files/api/scala/AnyRef.html#wait%28Long%29" target="_self">wait</a>, <a href="http://www.scala-lang.org/docu/files/api/scala/AnyRef.html#wait%28Long%2CInt%29" target="_self">wait</a>, <a href="http://www.scala-lang.org/docu/files/api/scala/AnyRef.html#wait%28%29" target="_self">wait</a>, <a href="http://www.scala-lang.org/docu/files/api/scala/AnyRef.html#finalize%28%29" target="_self">finalize</a>, <a href="http://www.scala-lang.org/docu/files/api/scala/AnyRef.html#%3D%3D%28AnyRef%29" target="_self">==</a>, <a href="http://www.scala-lang.org/docu/files/api/scala/AnyRef.html#%21%3D%28AnyRef%29" target="_self">!=</a>, <a href="http://www.scala-lang.org/docu/files/api/scala/AnyRef.html#eq%28AnyRef%29" target="_self">eq</a>, <a href="http://www.scala-lang.org/docu/files/api/scala/AnyRef.html#ne%28AnyRef%29" target="_self">ne</a>, <a href="http://www.scala-lang.org/docu/files/api/scala/AnyRef.html#synchronized%28T0%29" target="_self">synchronized</a> - </td></tr> - </table><table summary="" cellpadding="3" class="inherited"> - <tr><td class="title" colspan="2"> - Methods inherited from <a href="http://www.scala-lang.org/docu/files/api/scala/Any.html" target="_self">Any</a> - </td></tr> - <tr><td class="signature" colspan="2"> - <a href="http://www.scala-lang.org/docu/files/api/scala/Any.html#%3D%3D%28Any%29" target="_self">==</a>, <a href="http://www.scala-lang.org/docu/files/api/scala/Any.html#%21%3D%28Any%29" target="_self">!=</a>, <a href="http://www.scala-lang.org/docu/files/api/scala/Any.html#isInstanceOf" target="_self">isInstanceOf</a>, <a href="http://www.scala-lang.org/docu/files/api/scala/Any.html#asInstanceOf" target="_self">asInstanceOf</a> - </td></tr> - </table> - + <div id="definition"> + <img src="../../lib/class_big.png" /> + <h1>Net</h1> + </div> + <h4 class="signature"> + <span class="kind">class</span> + <span class="symbol"> + <span class="name">Net</span><span class="result"> extends <a href="Prefab.html" class="extype" name="sims.prefabs.Prefab">Prefab</a></span> + </span> + </h4> + <div class="fullcomment" id="comment"> - -<table summary="" cellpadding="3" class="member-detail"> - <tr><td class="title">Value Details</td></tr> - </table><div><a name="nodeDistance"></a><dl> - <dt> - - <code></code> - <code>val</code> - <em>nodeDistance</em> : <a href="http://www.scala-lang.org/docu/files/api/scala/Double.html" target="_self">Double</a> - </dt> - <dd></dd> - </dl><hr></hr> -<a name="nodeRadius"></a><dl> - <dt> - - <code></code> - <code>val</code> - <em>nodeRadius</em> : <a href="http://www.scala-lang.org/docu/files/api/scala/Double.html" target="_self">Double</a> - </dt> - <dd></dd> - </dl><hr></hr> -<a name="nodeDensity"></a><dl> - <dt> - - <code></code> - <code>val</code> - <em>nodeDensity</em> : <a href="http://www.scala-lang.org/docu/files/api/scala/Double.html" target="_self">Double</a> - </dt> - <dd></dd> - </dl><hr></hr> -<a name="springConstant"></a><dl> - <dt> - - <code></code> - <code>val</code> - <em>springConstant</em> : <a href="http://www.scala-lang.org/docu/files/api/scala/Double.html" target="_self">Double</a> - </dt> - <dd></dd> - </dl><hr></hr> -<a name="springDamping"></a><dl> - <dt> - - <code></code> - <code>val</code> - <em>springDamping</em> : <a href="http://www.scala-lang.org/docu/files/api/scala/Double.html" target="_self">Double</a> - </dt> - <dd></dd> - </dl><hr></hr> -<a name="bodies"></a><dl> - <dt> - - <code>override</code> - <code>val</code> - <em>bodies</em> : <a href="" target="contentFrame" class="scala/List">scala.List</a>[<a href="../../sims/dynamics/Body.html" target="_self">Body</a>] - </dt> - <dd></dd> - </dl><dl> - <dt style="margin:10px 0 0 20px;"> - <b>Overrides</b> - </dt> - <dd> - <a href="../../sims/prefabs/Prefab.html" target="_self">Prefab</a>.<a href="../../sims/prefabs/Prefab.html#bodies" target="_self">bodies</a> - </dd> - </dl><hr></hr> -<a name="joints"></a><dl> - <dt> + + + + + </div> + + <div id="template"> + + <div id="mbrsel"> + <div id="ancestors"> + <h3>Inherits</h3> + <ol><li class="in" name="sims.prefabs.Prefab">Prefab</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.prefabs.Net#bodies"> + <h4 class="signature"> + <span class="kind">val</span> + <span class="symbol"> + <span class="name">bodies</span><span class="result">: <span class="extype" name="scala.collection.immutable.List">List</span>[<a href="../dynamics/Body.html" class="extype" name="sims.dynamics.Body">Body</a>]</span> + </span> + </h4> + + </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.prefabs.Net#joints"> + <h4 class="signature"> + <span class="kind">val</span> + <span class="symbol"> + <span class="name">joints</span><span class="result">: <span class="extype" name="scala.collection.immutable.List">List</span>[<a href="../dynamics/joints/DistanceJoint.html" class="extype" name="sims.dynamics.joints.DistanceJoint">DistanceJoint</a>]</span> + </span> + </h4> + + </li><li name="sims.prefabs.Net#nodeDensity"> + <h4 class="signature"> + <span class="kind">val</span> + <span class="symbol"> + <span class="name">nodeDensity</span><span class="result">: <span class="extype" name="scala.Double">Double</span></span> + </span> + </h4> + + </li><li name="sims.prefabs.Net#nodeDistance"> + <h4 class="signature"> + <span class="kind">val</span> + <span class="symbol"> + <span class="name">nodeDistance</span><span class="result">: <span class="extype" name="scala.Double">Double</span></span> + </span> + </h4> + + </li><li name="sims.prefabs.Net#nodeRadius"> + <h4 class="signature"> + <span class="kind">val</span> + <span class="symbol"> + <span class="name">nodeRadius</span><span class="result">: <span class="extype" name="scala.Double">Double</span></span> + </span> + </h4> + + </li><li name="sims.prefabs.Net#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.prefabs.Net#springDamping"> + <h4 class="signature"> + <span class="kind">val</span> + <span class="symbol"> + <span class="name">springDamping</span><span class="result">: <span class="extype" name="scala.Double">Double</span></span> + </span> + </h4> + + </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.prefabs.Net#this"> + <h4 class="signature"> + <span class="kind">new</span> + <span class="symbol"> + <span class="name">Net</span><span class="params">(<span name="width">width: <span class="extype" name="scala.Int">Int</span></span>, <span name="height">height: <span class="extype" name="scala.Int">Int</span></span>, <span name="initPos">initPos: <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">Net</span><span class="params">()</span> + </span> + </h4> + + </li></ol> + </div> - <code>override</code> - <code>val</code> - <em>joints</em> : <a href="" target="contentFrame" class="scala/List">scala.List</a>[<a href="../../sims/dynamics/joints/DistanceJoint.html" target="_self">DistanceJoint</a>] - </dt> - <dd></dd> - </dl><dl> - <dt style="margin:10px 0 0 20px;"> - <b>Overrides</b> - </dt> - <dd> - <a href="../../sims/prefabs/Prefab.html" target="_self">Prefab</a>.<a href="../../sims/prefabs/Prefab.html#joints" target="_self">joints</a> - </dd> - </dl><hr></hr></div> - - - - <hr></hr> - <table summary="" class="navigation"> - <tr> - <td class="navigation-links" valign="top"> - <!-- <table><tr></tr></table> --> - </td> - <td align="right" valign="top" style="white-space:nowrap;" rowspan="2"> - <div class="doctitle-larger">SiMS</div> - </td> - </tr> - <tr><td></td></tr> - </table> - </body> + </div> + + </body> </html>
\ No newline at end of file |