blob: b2b8a2333ae2b0b35233b133b927250d61d32b8c (
plain) (
tree)
|
|
<?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.prefabs.Prefab</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">prefabs</a></p>
<div id="definition">
<img src="../../lib/trait_big.png" />
<h1>Prefab</h1>
</div>
<h4 class="signature">
<span class="kind">trait</span>
<span class="symbol">
<span class="name">Prefab</span><span class="result"> extends AnyRef</span>
</span>
</h4>
<div class="fullcomment" id="comment">
<div class="block">
known subclasses: <a href="Ragdoll.html">Ragdoll</a>, <a href="Pylon.html">Pylon</a>, <a href="Net.html">Net</a>, <a href="../../graphyx/tests/Carriage$$Car.html">Car</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.prefabs.Prefab#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.Iterable">Iterable</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.Prefab#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.Iterable">Iterable</span>[<a href="../dynamics/joints/Joint.html" class="extype" name="sims.dynamics.joints.Joint">Joint</a>]</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>
</body>
</html>
|
