diff options
Diffstat (limited to 'doc/sims/geometry/ConvexPolygon.html')
-rw-r--r-- | doc/sims/geometry/ConvexPolygon.html | 228 |
1 files changed, 0 insertions, 228 deletions
diff --git a/doc/sims/geometry/ConvexPolygon.html b/doc/sims/geometry/ConvexPolygon.html deleted file mode 100644 index e3cdc96..0000000 --- a/doc/sims/geometry/ConvexPolygon.html +++ /dev/null @@ -1,228 +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.geometry.ConvexPolygon</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">geometry</a></p> - - <div id="definition"> - <img src="../../lib/trait_big.png" /> - <h1>ConvexPolygon</h1> - </div> - - <h4 class="signature"> - <span class="kind">trait</span> - <span class="symbol"> - <span class="name">ConvexPolygon</span><span class="result"> extends AnyRef</span> - </span> - </h4> - <div class="fullcomment" id="comment"> - <div class="comment cmt"><p>Common properties of all convex polygons.</p></div> - - - - <div class="block"> - known subclasses: <a href="../dynamics/RegularPolygon.html">RegularPolygon</a>, <a href="../dynamics/Rectangle.html">Rectangle</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.geometry.ConvexPolygon#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 polygon's axis aligned bounding box</p><div class="fullcomment"> - <div class="comment cmt"><p>Returns this polygon's axis aligned bounding box.</p></div> - - - - - </div> - </li><li name="sims.geometry.ConvexPolygon#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="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 polygon</p><div class="fullcomment"> - <div class="comment cmt"><p>Checks if the point <code>point</code> is contained in this polygon. -<p> -A ray is created, originating from the point and following an arbitrary direction (X-Axis was chosen). -The number of intersections between the ray and this polygon's sides (including vertices) is counted. -The amount of intersections with vertices is substracted form the previuos number. -If the latter number is odd, the point is contained in the polygon.</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="sims.geometry.ConvexPolygon#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="Vector2D.html" class="extype" name="sims.geometry.Vector2D">Vector2D</a></span>)</span><span class="result">: <a href="Projection.html" class="extype" name="sims.geometry.Projection">Projection</a></span> - </span> - </h4> - <p class="shortcomment cmt">Returns the projection of this polygon 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 polygon 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 polygon</p></dd></dl> - - - - </div> - </li><li name="sims.geometry.ConvexPolygon#sides"> - <h4 class="signature"> - <span class="kind">def</span> - <span class="symbol"> - <span class="name">sides</span><span class="result">: <span class="extype" name="scala.Array">Array</span>[<a href="Segment.html" class="extype" name="sims.geometry.Segment">Segment</a>]</span> - </span> - </h4> - <p class="shortcomment cmt">Returns all sides of this polygon</p><div class="fullcomment"> - <div class="comment cmt"><p>Returns all sides of this polygon. The sides are ordered counter-clockwise, the first vertex of the side -giving the side index.</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.geometry.ConvexPolygon#vertices"> - <h4 class="signature"> - <span class="kind">def</span> - <span class="symbol"> - <span class="name">vertices</span><span class="result">: <span class="extype" name="scala.collection.Seq">Seq</span>[<a href="Vector2D.html" class="extype" name="sims.geometry.Vector2D">Vector2D</a>]</span> - </span> - </h4> - <p class="shortcomment cmt">Returns positions of all vertices of this Polygon</p><div class="fullcomment"> - <div class="comment cmt"><p>Returns positions of all vertices of this Polygon. Vertices are ordered counter-clockwise.</p></div> - - <div class="block"> - attributes: abstract - </div> - - - </div> - </li></ol> - </div> - - - - </div> - - </body> - </html>
\ No newline at end of file |