chore: build docs

pmndrs · Jan 6, 2024 · dd971c4 · dd971c4
1 parent 1bf3e51
commit dd971c4
Show file tree

Hide file tree

Showing 52 changed files with 922 additions and 823 deletions.
diff --git a/docs/classes/AABB.html b/docs/classes/AABB.html
diff --git a/docs/classes/ArrayCollisionMatrix.html b/docs/classes/ArrayCollisionMatrix.html
diff --git a/docs/classes/Body.html b/docs/classes/Body.html
diff --git a/docs/classes/Box.html b/docs/classes/Box.html
diff --git a/docs/classes/Broadphase.html b/docs/classes/Broadphase.html
diff --git a/docs/classes/ConeTwistConstraint.html b/docs/classes/ConeTwistConstraint.html
diff --git a/docs/classes/Constraint.html b/docs/classes/Constraint.html
diff --git a/docs/classes/ContactEquation.html b/docs/classes/ContactEquation.html
diff --git a/docs/classes/ContactMaterial.html b/docs/classes/ContactMaterial.html
diff --git a/docs/classes/ConvexPolyhedron.html b/docs/classes/ConvexPolyhedron.html
diff --git a/docs/classes/Cylinder.html b/docs/classes/Cylinder.html
diff --git a/docs/classes/DistanceConstraint.html b/docs/classes/DistanceConstraint.html
diff --git a/docs/classes/Equation.html b/docs/classes/Equation.html
diff --git a/docs/classes/EventTarget.html b/docs/classes/EventTarget.html
diff --git a/docs/classes/FrictionEquation.html b/docs/classes/FrictionEquation.html
diff --git a/docs/classes/GSSolver.html b/docs/classes/GSSolver.html
diff --git a/docs/classes/GridBroadphase.html b/docs/classes/GridBroadphase.html
diff --git a/docs/classes/Heightfield.html b/docs/classes/Heightfield.html
diff --git a/docs/classes/HingeConstraint.html b/docs/classes/HingeConstraint.html
diff --git a/docs/classes/JacobianElement.html b/docs/classes/JacobianElement.html
diff --git a/docs/classes/LockConstraint.html b/docs/classes/LockConstraint.html
diff --git a/docs/classes/Mat3.html b/docs/classes/Mat3.html
diff --git a/docs/classes/Material.html b/docs/classes/Material.html
diff --git a/docs/classes/NaiveBroadphase.html b/docs/classes/NaiveBroadphase.html
diff --git a/docs/classes/Narrowphase.html b/docs/classes/Narrowphase.html
diff --git a/docs/classes/ObjectCollisionMatrix.html b/docs/classes/ObjectCollisionMatrix.html
diff --git a/docs/classes/Particle.html b/docs/classes/Particle.html
diff --git a/docs/classes/Plane.html b/docs/classes/Plane.html
diff --git a/docs/classes/PointToPointConstraint.html b/docs/classes/PointToPointConstraint.html
diff --git a/docs/classes/Pool.html b/docs/classes/Pool.html
diff --git a/docs/classes/Quaternion.html b/docs/classes/Quaternion.html
diff --git a/docs/classes/Ray.html b/docs/classes/Ray.html
diff --git a/docs/classes/RaycastResult.html b/docs/classes/RaycastResult.html
diff --git a/docs/classes/RaycastVehicle.html b/docs/classes/RaycastVehicle.html
diff --git a/docs/classes/RigidVehicle.html b/docs/classes/RigidVehicle.html
diff --git a/docs/classes/RotationalEquation.html b/docs/classes/RotationalEquation.html
diff --git a/docs/classes/RotationalMotorEquation.html b/docs/classes/RotationalMotorEquation.html
diff --git a/docs/classes/SAPBroadphase.html b/docs/classes/SAPBroadphase.html
diff --git a/docs/classes/SPHSystem.html b/docs/classes/SPHSystem.html
diff --git a/docs/classes/Shape.html b/docs/classes/Shape.html
diff --git a/docs/classes/Solver.html b/docs/classes/Solver.html
diff --git a/docs/classes/Sphere.html b/docs/classes/Sphere.html
diff --git a/docs/classes/SplitSolver.html b/docs/classes/SplitSolver.html
diff --git a/docs/classes/Spring.html b/docs/classes/Spring.html
diff --git a/docs/classes/Transform.html b/docs/classes/Transform.html
diff --git a/docs/classes/Trimesh.html b/docs/classes/Trimesh.html
diff --git a/docs/classes/Vec3.html b/docs/classes/Vec3.html
diff --git a/docs/classes/Vec3Pool.html b/docs/classes/Vec3Pool.html
diff --git a/docs/classes/WheelInfo.html b/docs/classes/WheelInfo.html
diff --git a/docs/classes/World.html b/docs/classes/World.html
diff --git a/docs/index.html b/docs/index.html
@@ -42,4 +42,103 @@ <h1>Getting Started</h1>
 </code></pre>
 <p>You should now see a falling ball on the screen! Check out the <a href="https://github.com/pmndrs/cannon-es/blob/master/examples/threejs.html">basic three.js example</a> for the full code.</p>
 <p>That&#39;s it for the basic example, to learn more about all the different features, head over to the <a href="https://pmndrs.github.io/cannon-es/">examples page</a>!</p>
+
+<a href="#supported-shape-collision-pairs" id="supported-shape-collision-pairs" style="color: inherit; text-decoration: none;">
+  <h2>Supported Shape Collision Pairs</h2>
+</a>
+<p>Note that not all shapes can collide with each other as some collision algorithms are not implemented. The table below shows which shapes can currently collide with each other:</p>
+<table>
+<thead>
+<tr>
+<th align="left"></th>
+<th align="center"><a href="http://pmndrs.github.io/cannon-es/docs/classes/Sphere.html">Sphere</a></th>
+<th align="center"><a href="http://pmndrs.github.io/cannon-es/docs/classes/Plane.html">Plane</a></th>
+<th align="center"><a href="http://pmndrs.github.io/cannon-es/docs/classes/Box.html">Box</a></th>
+<th align="center"><a href="http://pmndrs.github.io/cannon-es/docs/classes/ConvexPolyhedron.html">Convex</a></th>
+<th align="center"><a href="http://pmndrs.github.io/cannon-es/docs/classes/Particle.html">Particle</a></th>
+<th align="center"><a href="http://pmndrs.github.io/cannon-es/docs/classes/Heightfield.html">Heightfield</a></th>
+<th align="center"><a href="http://pmndrs.github.io/cannon-es/docs/classes/Trimesh.html">Trimesh</a></th>
+</tr>
+</thead>
+<tbody><tr>
+<td align="left">Sphere</td>
+<td align="center">Yes</td>
+<td align="center">Yes</td>
+<td align="center">Yes</td>
+<td align="center">Yes</td>
+<td align="center">Yes</td>
+<td align="center">Yes</td>
+<td align="center">Yes</td>
+</tr>
+<tr>
+<td align="left">Plane</td>
+<td align="center">-</td>
+<td align="center">-</td>
+<td align="center">Yes</td>
+<td align="center">Yes</td>
+<td align="center">Yes</td>
+<td align="center">-</td>
+<td align="center">Yes</td>
+</tr>
+<tr>
+<td align="left">Box</td>
+<td align="center">-</td>
+<td align="center">-</td>
+<td align="center">Yes</td>
+<td align="center">Yes</td>
+<td align="center">Yes</td>
+<td align="center">Yes</td>
+<td align="center">(todo)</td>
+</tr>
+<tr>
+<td align="left">Cylinder</td>
+<td align="center">-</td>
+<td align="center">-</td>
+<td align="center">Yes</td>
+<td align="center">Yes</td>
+<td align="center">Yes</td>
+<td align="center">Yes</td>
+<td align="center">(todo)</td>
+</tr>
+<tr>
+<td align="left">Convex</td>
+<td align="center">-</td>
+<td align="center">-</td>
+<td align="center">-</td>
+<td align="center">Yes</td>
+<td align="center">Yes</td>
+<td align="center">Yes</td>
+<td align="center">(todo)</td>
+</tr>
+<tr>
+<td align="left">Particle</td>
+<td align="center">-</td>
+<td align="center">-</td>
+<td align="center">-</td>
+<td align="center">-</td>
+<td align="center">-</td>
+<td align="center">(todo)</td>
+<td align="center">(todo)</td>
+</tr>
+<tr>
+<td align="left">Heightfield</td>
+<td align="center">-</td>
+<td align="center">-</td>
+<td align="center">-</td>
+<td align="center">-</td>
+<td align="center">-</td>
+<td align="center">-</td>
+<td align="center">(todo)</td>
+</tr>
+<tr>
+<td align="left">Trimesh</td>
+<td align="center">-</td>
+<td align="center">-</td>
+<td align="center">-</td>
+<td align="center">-</td>
+<td align="center">-</td>
+<td align="center">-</td>
+<td align="center">-</td>
+</tr>
+</tbody></table>
 </div></div><div class="col-4 col-menu menu-sticky-wrap menu-highlight"><nav class="tsd-navigation primary"><ul><li class="current"><a href="modules.html">Exports</a></li></ul></nav><nav class="tsd-navigation secondary menu-sticky"><ul><li class="tsd-kind-class"><a href="classes/AABB.html" class="tsd-kind-icon">AABB</a></li><li class="tsd-kind-class"><a href="classes/ArrayCollisionMatrix.html" class="tsd-kind-icon">Array<wbr/>Collision<wbr/>Matrix</a></li><li class="tsd-kind-class"><a href="classes/Body.html" class="tsd-kind-icon">Body</a></li><li class="tsd-kind-class"><a href="classes/Box.html" class="tsd-kind-icon">Box</a></li><li class="tsd-kind-class"><a href="classes/Broadphase.html" class="tsd-kind-icon">Broadphase</a></li><li class="tsd-kind-class"><a href="classes/ConeTwistConstraint.html" class="tsd-kind-icon">Cone<wbr/>Twist<wbr/>Constraint</a></li><li class="tsd-kind-class"><a href="classes/Constraint.html" class="tsd-kind-icon">Constraint</a></li><li class="tsd-kind-class"><a href="classes/ContactEquation.html" class="tsd-kind-icon">Contact<wbr/>Equation</a></li><li class="tsd-kind-class"><a href="classes/ContactMaterial.html" class="tsd-kind-icon">Contact<wbr/>Material</a></li><li class="tsd-kind-class"><a href="classes/ConvexPolyhedron.html" class="tsd-kind-icon">Convex<wbr/>Polyhedron</a></li><li class="tsd-kind-class"><a href="classes/Cylinder.html" class="tsd-kind-icon">Cylinder</a></li><li class="tsd-kind-class"><a href="classes/DistanceConstraint.html" class="tsd-kind-icon">Distance<wbr/>Constraint</a></li><li class="tsd-kind-class"><a href="classes/Equation.html" class="tsd-kind-icon">Equation</a></li><li class="tsd-kind-class"><a href="classes/EventTarget.html" class="tsd-kind-icon">Event<wbr/>Target</a></li><li class="tsd-kind-class"><a href="classes/FrictionEquation.html" class="tsd-kind-icon">Friction<wbr/>Equation</a></li><li class="tsd-kind-class"><a href="classes/GSSolver.html" class="tsd-kind-icon">GSSolver</a></li><li class="tsd-kind-class"><a href="classes/GridBroadphase.html" class="tsd-kind-icon">Grid<wbr/>Broadphase</a></li><li class="tsd-kind-class"><a href="classes/Heightfield.html" class="tsd-kind-icon">Heightfield</a></li><li class="tsd-kind-class"><a href="classes/HingeConstraint.html" class="tsd-kind-icon">Hinge<wbr/>Constraint</a></li><li class="tsd-kind-class"><a href="classes/JacobianElement.html" class="tsd-kind-icon">Jacobian<wbr/>Element</a></li><li class="tsd-kind-class"><a href="classes/LockConstraint.html" class="tsd-kind-icon">Lock<wbr/>Constraint</a></li><li class="tsd-kind-class"><a href="classes/Mat3.html" class="tsd-kind-icon">Mat3</a></li><li class="tsd-kind-class"><a href="classes/Material.html" class="tsd-kind-icon">Material</a></li><li class="tsd-kind-class"><a href="classes/NaiveBroadphase.html" class="tsd-kind-icon">Naive<wbr/>Broadphase</a></li><li class="tsd-kind-class"><a href="classes/Narrowphase.html" class="tsd-kind-icon">Narrowphase</a></li><li class="tsd-kind-class"><a href="classes/ObjectCollisionMatrix.html" class="tsd-kind-icon">Object<wbr/>Collision<wbr/>Matrix</a></li><li class="tsd-kind-class"><a href="classes/Particle.html" class="tsd-kind-icon">Particle</a></li><li class="tsd-kind-class"><a href="classes/Plane.html" class="tsd-kind-icon">Plane</a></li><li class="tsd-kind-class"><a href="classes/PointToPointConstraint.html" class="tsd-kind-icon">Point<wbr/>To<wbr/>Point<wbr/>Constraint</a></li><li class="tsd-kind-class"><a href="classes/Pool.html" class="tsd-kind-icon">Pool</a></li><li class="tsd-kind-class"><a href="classes/Quaternion.html" class="tsd-kind-icon">Quaternion</a></li><li class="tsd-kind-class"><a href="classes/Ray.html" class="tsd-kind-icon">Ray</a></li><li class="tsd-kind-class"><a href="classes/RaycastResult.html" class="tsd-kind-icon">Raycast<wbr/>Result</a></li><li class="tsd-kind-class"><a href="classes/RaycastVehicle.html" class="tsd-kind-icon">Raycast<wbr/>Vehicle</a></li><li class="tsd-kind-class"><a href="classes/RigidVehicle.html" class="tsd-kind-icon">Rigid<wbr/>Vehicle</a></li><li class="tsd-kind-class"><a href="classes/RotationalEquation.html" class="tsd-kind-icon">Rotational<wbr/>Equation</a></li><li class="tsd-kind-class"><a href="classes/RotationalMotorEquation.html" class="tsd-kind-icon">Rotational<wbr/>Motor<wbr/>Equation</a></li><li class="tsd-kind-class"><a href="classes/SAPBroadphase.html" class="tsd-kind-icon">SAPBroadphase</a></li><li class="tsd-kind-class"><a href="classes/SPHSystem.html" class="tsd-kind-icon">SPHSystem</a></li><li class="tsd-kind-class"><a href="classes/Shape.html" class="tsd-kind-icon">Shape</a></li><li class="tsd-kind-class"><a href="classes/Solver.html" class="tsd-kind-icon">Solver</a></li><li class="tsd-kind-class"><a href="classes/Sphere.html" class="tsd-kind-icon">Sphere</a></li><li class="tsd-kind-class"><a href="classes/SplitSolver.html" class="tsd-kind-icon">Split<wbr/>Solver</a></li><li class="tsd-kind-class"><a href="classes/Spring.html" class="tsd-kind-icon">Spring</a></li><li class="tsd-kind-class"><a href="classes/Transform.html" class="tsd-kind-icon">Transform</a></li><li class="tsd-kind-class"><a href="classes/Trimesh.html" class="tsd-kind-icon">Trimesh</a></li><li class="tsd-kind-class"><a href="classes/Vec3.html" class="tsd-kind-icon">Vec3</a></li><li class="tsd-kind-class"><a href="classes/Vec3Pool.html" class="tsd-kind-icon">Vec3<wbr/>Pool</a></li><li class="tsd-kind-class"><a href="classes/WheelInfo.html" class="tsd-kind-icon">Wheel<wbr/>Info</a></li><li class="tsd-kind-class"><a href="classes/World.html" class="tsd-kind-icon">World</a></li><li class="tsd-kind-type-alias"><a href="modules.html#BodySleepState" class="tsd-kind-icon">Body<wbr/>Sleep<wbr/>State</a></li><li class="tsd-kind-type-alias"><a href="modules.html#BodyType" class="tsd-kind-icon">Body<wbr/>Type</a></li><li class="tsd-kind-type-alias"><a href="modules.html#ConvexPolyhedronContactPoint" class="tsd-kind-icon">Convex<wbr/>Polyhedron<wbr/>Contact<wbr/>Point</a></li><li class="tsd-kind-type-alias"><a href="modules.html#RayMode" class="tsd-kind-icon">Ray<wbr/>Mode</a></li><li class="tsd-kind-type-alias"><a href="modules.html#RayOptions" class="tsd-kind-icon">Ray<wbr/>Options</a></li><li class="tsd-kind-type-alias"><a href="modules.html#ShapeType" class="tsd-kind-icon">Shape<wbr/>Type</a></li><li class="tsd-kind-variable"><a href="modules.html#BODY_SLEEP_STATES" class="tsd-kind-icon">BODY_<wbr/>SLEEP_<wbr/>STATES</a></li><li class="tsd-kind-variable"><a href="modules.html#BODY_TYPES" class="tsd-kind-icon">BODY_<wbr/>TYPES</a></li><li class="tsd-kind-variable"><a href="modules.html#RAY_MODES" class="tsd-kind-icon">RAY_<wbr/>MODES</a></li><li class="tsd-kind-variable"><a href="modules.html#SHAPE_TYPES" class="tsd-kind-icon">SHAPE_<wbr/>TYPES</a></li></ul></nav></div></div></div><footer class=""><div class="container"><h2>Legend</h2><div class="tsd-legend-group"><ul class="tsd-legend"><li class="tsd-kind-constructor tsd-parent-kind-class"><span class="tsd-kind-icon">Constructor</span></li><li class="tsd-kind-property tsd-parent-kind-class"><span class="tsd-kind-icon">Property</span></li><li class="tsd-kind-method tsd-parent-kind-class"><span class="tsd-kind-icon">Method</span></li></ul><ul class="tsd-legend"><li class="tsd-kind-constructor tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited constructor</span></li><li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited property</span></li><li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited method</span></li></ul><ul class="tsd-legend"><li class="tsd-kind-property tsd-parent-kind-class tsd-is-static"><span class="tsd-kind-icon">Static property</span></li><li class="tsd-kind-method tsd-parent-kind-class tsd-is-static"><span class="tsd-kind-icon">Static method</span></li></ul></div><h2>Settings</h2><p>Theme <select id="theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></p></div></footer><div class="overlay"></div><script src="assets/main.js"></script></body></html>