update docs

snowkit · Apr 17, 2015 · f7a5dc2 · f7a5dc2
1 parent fe09fe6
commit f7a5dc2
Show file tree

Hide file tree

Showing 57 changed files with 9,872 additions and 1,199 deletions.
diff --git a/docs/api/differ/Collision.html b/docs/api/differ/Collision.html
@@ -0,0 +1,133 @@
+<!DOCTYPE html>
+<html>
+
+ <head>
+ <title>snow - </title>
+ <meta http-equiv="Content-Type" content="text/html; charset=utf-8">
+ <link rel="shortcut icon" href="../../images/favicon.png" />
+
+ <link rel="stylesheet" type="text/css" href="../../css/style.css" media="all">
+ <link rel="stylesheet" type="text/css" href="../../css/code.css" media="all">
+ <link rel="stylesheet" type="text/css" href="../../css/font.css" media="all">
+
+ <link rel="stylesheet" type="text/css" href="../../css/tooltipster.css" media="all">
+ <link rel="stylesheet" type="text/css" href="../../css/tooltipster-shadow.css" media="all">
+
+ <script src="../../js/jquery-2.0.3.min.js"> </script>
+ <script src="../../js/jquery.tooltipster.min.js"> </script>
+
+ <script>
+
+ $(document).ready(function() {
+
+ $('.section').css('display','none');
+ $('.readmore').click(function(e){
+ var _child = $(this).parent().find('.section').first();
+ var _opp = 'block';
+ if( _child.css('display') == 'block' ) {
+ _opp = 'none';
+ } else {
+ }
+ _child.css('display', _opp);
+ });
+
+ $('div.sample').on('click', function(e){
+ //get the data tag
+ var content = $(this).attr('data-content');
+ //remove clicking handler
+ $(this).off('click');
+ //replace the content!
+ $(this).html('<iframe src="'+content+'" sandbox="allow-same-origin allow-scripts" style="overflow:hidden; scrollbar:none; border: 0; width:645px; height:450px;"></iframe> ')
+ });
+
+ $('.tooltip').each(function(e){
+ var c = $(this).attr('data-tooltip');
+ $(this).tooltipster({
+ content:$('<span>' + c + '</span>'),
+ interactive:true,
+ theme:'tooltipster-shadow'
+ });
+ });
+
+ }); //document.ready
+
+ </script>
+ </head>
+
+ <body>
+ <div class="content">
+ <p><a href="../../api/index.html"><img src="../../images/logo.png" alt="Logo"></a></p>
+<p><hr/>
+<a href="#" id="search_bar" onclick="return;"><div> search API <em>(or start typing anywhere)</em> </div></a></p>
+<hr/>
+
+<script src="../../js/omnibar.js"> </script>
+<link rel="stylesheet" type="text/css" href="../../css/omnibar.css" media="all">
+
+<div id="omnibar"> <a href="#" onclick="return" id="omnibar_close"></a> <input id="omnibar_text" type="text" placeholder="search types..."></input></div>
+<script id="typelist" data-relpath="../../" data-types="differ.Collision,differ.ShapeDrawer,differ.data.RayCollision,differ.data.RayCollisionHelper,differ.data.RayIntersection,differ.data.ShapeCollision,differ.math.Matrix,differ.math.Vector,differ.sat.Common,differ.sat.SAT2D,differ.shapes.Circle,differ.shapes.Polygon,differ.shapes.Ray,differ.shapes.Shape"></script>
+
+
+<p><h1>Collision</h1>
+<small><code>differ.Collision</code></small></p>
+<hr/>
+
+<p><code>class</code><br/><span class="meta">
+meta: @:directlyUsed, @:keep</span></p>
+<hr/>
+
+
+<p>&nbsp;
+&nbsp;</p>
+<p><h3>Methods</h3> <hr/><span class="method apipage">
+ <a name="pointInPoly"><a class="lift" href="#pointInPoly">pointInPoly</a></a><span class="inline-block static">static</span><div class="clear"></div>
+ <code class="signature apipage">pointInPoly(point:<a href="../../api/differ/math/Vector.html">differ.math.Vector</a><span></span>, poly:<a href="../../api/differ/shapes/Polygon.html">differ.shapes.Polygon</a><span></span>) : <a href="http://api.haxe.org/Bool.html">Bool</a></code><br/><span class="small_desc_flat">Test if a given point lands inside the given polygon.
+ Returns true if it does, false otherwise.</span></p>
+<p></span>
+<span class="method apipage">
+ <a name="rayWithRay"><a class="lift" href="#rayWithRay">rayWithRay</a></a><span class="inline-block static">static</span><div class="clear"></div>
+ <code class="signature apipage">rayWithRay(ray1:<a href="../../api/differ/shapes/Ray.html">differ.shapes.Ray</a><span></span>, ray2:<a href="../../api/differ/shapes/Ray.html">differ.shapes.Ray</a><span></span>) : <a href="../../api/differ/data/RayIntersection.html">differ.data.RayIntersection</a></code><br/><span class="small_desc_flat">Test a ray against another ray.
+ When no collision is found, this function returns null.
+ Returns a <code>RayIntersection</code> if a collision is found.</span></p>
+<p></span>
+<span class="method apipage">
+ <a name="rayWithRays"><a class="lift" href="#rayWithRays">rayWithRays</a></a><span class="inline-block static">static</span><div class="clear"></div>
+ <code class="signature apipage">rayWithRays(ray:<a href="../../api/differ/shapes/Ray.html">differ.shapes.Ray</a><span></span>, rays:<a href="http://api.haxe.org/Array.html">Array</a>&lt;<a href="../../api/differ/shapes/Ray.html">differ.shapes.Ray</a>&gt;<span></span>) : <a href="http://api.haxe.org/Array.html">Array</a>&lt;<a href="../../api/differ/data/RayIntersection.html">differ.data.RayIntersection</a>&gt;</code><br/><span class="small_desc_flat">Test a ray against a list of other rays.
+ When no collision is found, this function returns an empty array, this function will never return null.
+ Returns a list of <code>RayIntersection</code> information for each collision found.</span></p>
+<p></span>
+<span class="method apipage">
+ <a name="rayWithShape"><a class="lift" href="#rayWithShape">rayWithShape</a></a><span class="inline-block static">static</span><div class="clear"></div>
+ <code class="signature apipage">rayWithShape(ray:<a href="../../api/differ/shapes/Ray.html">differ.shapes.Ray</a><span></span>, shape:<a href="../../api/differ/shapes/Shape.html">differ.shapes.Shape</a><span></span>) : <a href="../../api/differ/data/RayCollision.html">differ.data.RayCollision</a></code><br/><span class="small_desc_flat">Test a line between two points against a list of shapes.
+ When no collision is found, this function returns null.
+ Returns a <code>RayCollision</code> if a collision is found.</span></p>
+<p></span>
+<span class="method apipage">
+ <a name="rayWithShapes"><a class="lift" href="#rayWithShapes">rayWithShapes</a></a><span class="inline-block static">static</span><div class="clear"></div>
+ <code class="signature apipage">rayWithShapes(ray:<a href="../../api/differ/shapes/Ray.html">differ.shapes.Ray</a><span></span>, shapes:<a href="http://api.haxe.org/Array.html">Array</a>&lt;<a href="../../api/differ/shapes/Shape.html">differ.shapes.Shape</a>&gt;<span></span>) : <a href="http://api.haxe.org/Array.html">Array</a>&lt;<a href="../../api/differ/data/RayCollision.html">differ.data.RayCollision</a>&gt;</code><br/><span class="small_desc_flat">Test a ray between two points against a list of shapes.
+ When no collision is found, this function returns an empty array, this function will never return null.
+ Returns a list of <code>RayCollision</code> information for each collision found.</span></p>
+<p></span>
+<span class="method apipage">
+ <a name="shapeWithShape"><a class="lift" href="#shapeWithShape">shapeWithShape</a></a><span class="inline-block static">static</span><div class="clear"></div>
+ <code class="signature apipage">shapeWithShape(shape1:<a href="../../api/differ/shapes/Shape.html">differ.shapes.Shape</a><span></span>, shape2:<a href="../../api/differ/shapes/Shape.html">differ.shapes.Shape</a><span></span>) : <a href="../../api/differ/data/ShapeCollision.html">differ.data.ShapeCollision</a></code><br/><span class="small_desc_flat">Test a single shape against another shape.
+ When no collision is found between them, this function returns null.
+ Returns a <code>ShapeCollision</code> if a collision is found.</span></p>
+<p></span>
+<span class="method apipage">
+ <a name="shapeWithShapes"><a class="lift" href="#shapeWithShapes">shapeWithShapes</a></a><span class="inline-block static">static</span><div class="clear"></div>
+ <code class="signature apipage">shapeWithShapes(shape1:<a href="../../api/differ/shapes/Shape.html">differ.shapes.Shape</a><span></span>, shapes:<a href="http://api.haxe.org/Array.html">Array</a>&lt;<a href="../../api/differ/shapes/Shape.html">differ.shapes.Shape</a>&gt;<span></span>) : <a href="http://api.haxe.org/Array.html">Array</a>&lt;<a href="../../api/differ/data/ShapeCollision.html">differ.data.ShapeCollision</a>&gt;</code><br/><span class="small_desc_flat">Test a single shape against multiple other shapes.
+ When no collision is found, this function returns an empty array, this function will never return null.
+ Returns a list of <code>ShapeCollision</code> information for each collision found.</span></p>
+<p></span></p>
+<hr/>
+
+<p>&nbsp;
+&nbsp;
+&nbsp;
+&nbsp;</p>
+
+ </div>
+ </body>
+
+</html>
diff --git a/docs/api/differ/ShapeDrawer.html b/docs/api/differ/ShapeDrawer.html
@@ -0,0 +1,126 @@
+<!DOCTYPE html>
+<html>
+
+ <head>
+ <title>snow - </title>
+ <meta http-equiv="Content-Type" content="text/html; charset=utf-8">
+ <link rel="shortcut icon" href="../../images/favicon.png" />
+
+ <link rel="stylesheet" type="text/css" href="../../css/style.css" media="all">
+ <link rel="stylesheet" type="text/css" href="../../css/code.css" media="all">
+ <link rel="stylesheet" type="text/css" href="../../css/font.css" media="all">
+
+ <link rel="stylesheet" type="text/css" href="../../css/tooltipster.css" media="all">
+ <link rel="stylesheet" type="text/css" href="../../css/tooltipster-shadow.css" media="all">
+
+ <script src="../../js/jquery-2.0.3.min.js"> </script>
+ <script src="../../js/jquery.tooltipster.min.js"> </script>
+
+ <script>
+
+ $(document).ready(function() {
+
+ $('.section').css('display','none');
+ $('.readmore').click(function(e){
+ var _child = $(this).parent().find('.section').first();
+ var _opp = 'block';
+ if( _child.css('display') == 'block' ) {
+ _opp = 'none';
+ } else {
+ }
+ _child.css('display', _opp);
+ });
+
+ $('div.sample').on('click', function(e){
+ //get the data tag
+ var content = $(this).attr('data-content');
+ //remove clicking handler
+ $(this).off('click');
+ //replace the content!
+ $(this).html('<iframe src="'+content+'" sandbox="allow-same-origin allow-scripts" style="overflow:hidden; scrollbar:none; border: 0; width:645px; height:450px;"></iframe> ')
+ });
+
+ $('.tooltip').each(function(e){
+ var c = $(this).attr('data-tooltip');
+ $(this).tooltipster({
+ content:$('<span>' + c + '</span>'),
+ interactive:true,
+ theme:'tooltipster-shadow'
+ });
+ });
+
+ }); //document.ready
+
+ </script>
+ </head>
+
+ <body>
+ <div class="content">
+ <p><a href="../../api/index.html"><img src="../../images/logo.png" alt="Logo"></a></p>
+<p><hr/>
+<a href="#" id="search_bar" onclick="return;"><div> search API <em>(or start typing anywhere)</em> </div></a></p>
+<hr/>
+
+<script src="../../js/omnibar.js"> </script>
+<link rel="stylesheet" type="text/css" href="../../css/omnibar.css" media="all">
+
+<div id="omnibar"> <a href="#" onclick="return" id="omnibar_close"></a> <input id="omnibar_text" type="text" placeholder="search types..."></input></div>
+<script id="typelist" data-relpath="../../" data-types="differ.Collision,differ.ShapeDrawer,differ.data.RayCollision,differ.data.RayCollisionHelper,differ.data.RayIntersection,differ.data.ShapeCollision,differ.math.Matrix,differ.math.Vector,differ.sat.Common,differ.sat.SAT2D,differ.shapes.Circle,differ.shapes.Polygon,differ.shapes.Ray,differ.shapes.Shape"></script>
+
+
+<p><h1>ShapeDrawer</h1>
+<small><code>differ.ShapeDrawer</code></small></p>
+<p>To implement your own debug drawing class, you only need to override drawLine function and implement it
+ the rest is handled internally. You can override specifics if you want, but it’s not required</p>
+<hr/>
+
+<p><code>class</code><br/><span class="meta">
+meta: @:keep</span></p>
+<hr/>
+
+
+<p>&nbsp;
+&nbsp;</p>
+<p><h3>Methods</h3> <hr/><span class="method apipage">
+ <a name="drawCircle"><a class="lift" href="#drawCircle">drawCircle</a></a><div class="clear"></div>
+ <code class="signature apipage">drawCircle(circle:<a href="../../api/differ/shapes/Circle.html">differ.shapes.Circle</a><span></span>) : <a href="http://api.haxe.org/Void.html">Void</a></code><br/><span class="small_desc_flat">Draw a circle <code>Shape</code></span></p>
+<p></span>
+<span class="method apipage">
+ <a name="drawLine"><a class="lift" href="#drawLine">drawLine</a></a><div class="clear"></div>
+ <code class="signature apipage">drawLine(p0:<a href="../../api/differ/math/Vector.html">differ.math.Vector</a><span></span>, p1:<a href="../../api/differ/math/Vector.html">differ.math.Vector</a><span></span>, startPoint:<a href="http://api.haxe.org/Bool.html">Bool</a><span></span>) : <a href="http://api.haxe.org/Void.html">Void</a></code><br/><span class="small_desc_flat">Draw a line between p0 and p1. Implement this function at minimum in custom drawing handlers</span></p>
+<p></span>
+<span class="method apipage">
+ <a name="drawPoint"><a class="lift" href="#drawPoint">drawPoint</a></a><div class="clear"></div>
+ <code class="signature apipage">drawPoint(point:<a href="../../api/differ/math/Vector.html">differ.math.Vector</a><span></span>, size:<a href="http://api.haxe.org/Float.html">Float</a><span></span>) : <a href="http://api.haxe.org/Void.html">Void</a></code><br/><span class="small_desc_flat"></span></p>
+<p></span>
+<span class="method apipage">
+ <a name="drawPolygon"><a class="lift" href="#drawPolygon">drawPolygon</a></a><div class="clear"></div>
+ <code class="signature apipage">drawPolygon(poly:<a href="../../api/differ/shapes/Polygon.html">differ.shapes.Polygon</a><span></span>) : <a href="http://api.haxe.org/Void.html">Void</a></code><br/><span class="small_desc_flat">Draw a <code>Polygon</code></span></p>
+<p></span>
+<span class="method apipage">
+ <a name="drawShape"><a class="lift" href="#drawShape">drawShape</a></a><div class="clear"></div>
+ <code class="signature apipage">drawShape(shape:<a href="../../api/differ/shapes/Shape.html">differ.shapes.Shape</a><span></span>) : <a href="http://api.haxe.org/Void.html">Void</a></code><br/><span class="small_desc_flat">Draw a <code>Shape</code>, it will determine the type and draw it for you.</span></p>
+<p></span>
+<span class="method apipage">
+ <a name="drawShapeCollision"><a class="lift" href="#drawShapeCollision">drawShapeCollision</a></a><div class="clear"></div>
+ <code class="signature apipage">drawShapeCollision(data:<a href="../../api/differ/data/ShapeCollision.html">differ.data.ShapeCollision</a><span></span>, length:<a href="http://api.haxe.org/Float.html">Float</a><span></span>) : <a href="http://api.haxe.org/Void.html">Void</a></code><br/><span class="small_desc_flat"></span></p>
+<p></span>
+<span class="method apipage">
+ <a name="drawVector"><a class="lift" href="#drawVector">drawVector</a></a><div class="clear"></div>
+ <code class="signature apipage">drawVector(v:<a href="../../api/differ/math/Vector.html">differ.math.Vector</a><span></span>, start:<a href="../../api/differ/math/Vector.html">differ.math.Vector</a><span></span>, startPoint:<a href="http://api.haxe.org/Bool.html">Bool</a><span></span>) : <a href="http://api.haxe.org/Void.html">Void</a></code><br/><span class="small_desc_flat">Draw a <code>Vector</code> (with magnitude)</span></p>
+<p></span>
+<span class="method apipage">
+ <a name="new"><a class="lift" href="#new">new</a></a><div class="clear"></div>
+ <code class="signature apipage">new() : <a href="http://api.haxe.org/Void.html">Void</a></code><br/><span class="small_desc_flat"></span></p>
+<p></span></p>
+<hr/>
+
+<p>&nbsp;
+&nbsp;
+&nbsp;
+&nbsp;</p>
+
+ </div>
+ </body>
+
+</html>