cannon
Version:
A lightweight 3D physics engine written in JavaScript.
1,063 lines (687 loc) • 66.9 kB
HTML
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="utf-8">
<title>WheelInfo - cannon</title>
<link rel="stylesheet" href="http://yui.yahooapis.com/3.9.1/build/cssgrids/cssgrids-min.css">
<link rel="stylesheet" href="../assets/vendor/prettify/prettify-min.css">
<link rel="stylesheet" href="../assets/css/main.css" id="site_styles">
<link rel="icon" href="../assets/favicon.ico">
<script src="http://yui.yahooapis.com/combo?3.9.1/build/yui/yui-min.js"></script>
</head>
<body class="yui3-skin-sam">
<div id="doc">
<div id="hd" class="yui3-g header">
<div class="yui3-u-3-4">
<h1><img src="../assets/css/logo.png" title="cannon" width="117" height="52"></h1>
</div>
<div class="yui3-u-1-4 version">
<em>API Docs for: 0.6.1</em>
</div>
</div>
<div id="bd" class="yui3-g">
<div class="yui3-u-1-4">
<div id="docs-sidebar" class="sidebar apidocs">
<div id="api-list">
<h2 class="off-left">APIs</h2>
<div id="api-tabview" class="tabview">
<ul class="tabs">
<li><a href="#api-classes">Classes</a></li>
<li><a href="#api-modules">Modules</a></li>
</ul>
<div id="api-tabview-filter">
<input type="search" id="api-filter" placeholder="Type to filter APIs">
</div>
<div id="api-tabview-panel">
<ul id="api-classes" class="apis classes">
<li><a href="../classes/AABB.html">AABB</a></li>
<li><a href="../classes/ArrayCollisionMatrix.html">ArrayCollisionMatrix</a></li>
<li><a href="../classes/Body.html">Body</a></li>
<li><a href="../classes/Box.html">Box</a></li>
<li><a href="../classes/Broadphase.html">Broadphase</a></li>
<li><a href="../classes/ConeEquation.html">ConeEquation</a></li>
<li><a href="../classes/ConeTwistConstraint.html">ConeTwistConstraint</a></li>
<li><a href="../classes/Constraint.html">Constraint</a></li>
<li><a href="../classes/ContactEquation.html">ContactEquation</a></li>
<li><a href="../classes/ContactMaterial.html">ContactMaterial</a></li>
<li><a href="../classes/ConvexPolyhedron.html">ConvexPolyhedron</a></li>
<li><a href="../classes/Cylinder.html">Cylinder</a></li>
<li><a href="../classes/Demo.html">Demo</a></li>
<li><a href="../classes/DistanceConstraint.html">DistanceConstraint</a></li>
<li><a href="../classes/Equation.html">Equation</a></li>
<li><a href="../classes/EventTarget.html">EventTarget</a></li>
<li><a href="../classes/FrictionEquation.html">FrictionEquation</a></li>
<li><a href="../classes/GridBroadphase.html">GridBroadphase</a></li>
<li><a href="../classes/GSSolver.html">GSSolver</a></li>
<li><a href="../classes/Heightfield.html">Heightfield</a></li>
<li><a href="../classes/HingeConstraint.html">HingeConstraint</a></li>
<li><a href="../classes/JacobianElement.html">JacobianElement</a></li>
<li><a href="../classes/LockConstraint.html">LockConstraint</a></li>
<li><a href="../classes/Mat3.html">Mat3</a></li>
<li><a href="../classes/Material.html">Material</a></li>
<li><a href="../classes/NaiveBroadphase.html">NaiveBroadphase</a></li>
<li><a href="../classes/Narrowphase.html">Narrowphase</a></li>
<li><a href="../classes/ObjectCollisionMatrix.html">ObjectCollisionMatrix</a></li>
<li><a href="../classes/Octree.html">Octree</a></li>
<li><a href="../classes/OctreeNode.html">OctreeNode</a></li>
<li><a href="../classes/Particle.html">Particle</a></li>
<li><a href="../classes/Plane.html">Plane</a></li>
<li><a href="../classes/PointToPointConstraint.html">PointToPointConstraint</a></li>
<li><a href="../classes/Pool.html">Pool</a></li>
<li><a href="../classes/Quaternion.html">Quaternion</a></li>
<li><a href="../classes/Ray.html">Ray</a></li>
<li><a href="../classes/RaycastResult.html">RaycastResult</a></li>
<li><a href="../classes/RaycastVehicle.html">RaycastVehicle</a></li>
<li><a href="../classes/RigidVehicle.html">RigidVehicle</a></li>
<li><a href="../classes/RotationalEquation.html">RotationalEquation</a></li>
<li><a href="../classes/RotationalMotorEquation.html">RotationalMotorEquation</a></li>
<li><a href="../classes/SAPBroadphase.html">SAPBroadphase</a></li>
<li><a href="../classes/Shape.html">Shape</a></li>
<li><a href="../classes/Solver.html">Solver</a></li>
<li><a href="../classes/Sphere.html">Sphere</a></li>
<li><a href="../classes/SPHSystem.html">SPHSystem</a></li>
<li><a href="../classes/SplitSolver.html">SplitSolver</a></li>
<li><a href="../classes/Spring.html">Spring</a></li>
<li><a href="../classes/Transform.html">Transform</a></li>
<li><a href="../classes/Trimesh.html">Trimesh</a></li>
<li><a href="../classes/TupleDictionary.html">TupleDictionary</a></li>
<li><a href="../classes/Vec3.html">Vec3</a></li>
<li><a href="../classes/Vec3Pool.html">Vec3Pool</a></li>
<li><a href="../classes/WheelInfo.html">WheelInfo</a></li>
<li><a href="../classes/World.html">World</a></li>
</ul>
<ul id="api-modules" class="apis modules">
</ul>
</div>
</div>
</div>
</div>
</div>
<div class="yui3-u-3-4">
<div id="api-options">
Show:
<label for="api-show-inherited">
<input type="checkbox" id="api-show-inherited" checked>
Inherited
</label>
<label for="api-show-protected">
<input type="checkbox" id="api-show-protected">
Protected
</label>
<label for="api-show-private">
<input type="checkbox" id="api-show-private">
Private
</label>
<label for="api-show-deprecated">
<input type="checkbox" id="api-show-deprecated">
Deprecated
</label>
</div>
<div class="apidocs">
<div id="docs-main">
<div class="content">
<h1>WheelInfo Class</h1>
<div class="box meta">
<div class="foundat">
Defined in: <a href="../files/src_objects_WheelInfo.js.html#l8"><code>src/objects/WheelInfo.js:8</code></a>
</div>
</div>
<div class="box intro">
</div>
<div class="constructor">
<h2>Constructor</h2>
<div id="method_WheelInfo" class="method item">
<h3 class="name"><code>WheelInfo</code></h3>
<div class="args">
<span class="paren">(</span><ul class="args-list inline commas">
<li class="arg">
<code class="optional">[options]</code>
</li>
</ul><span class="paren">)</span>
</div>
<div class="meta">
<p>
Defined in
<a href="../files/src_objects_WheelInfo.js.html#l8"><code>src/objects/WheelInfo.js:8</code></a>
</p>
</div>
<div class="description">
</div>
<div class="params">
<h4>Parameters:</h4>
<ul class="params-list">
<li class="param">
<code class="param-name optional">[options]</code>
<span class="type">Object</span>
<span class="flag optional" title="This parameter is optional.">optional</span>
<div class="param-description">
</div>
<ul class="params-list">
<li class="param">
<code class="param-name optional">[chassisConnectionPointLocal]</code>
<span class="type"><a href="../classes/Vec3.html" class="crosslink">Vec3</a></span>
<span class="flag optional" title="This parameter is optional.">optional</span>
<div class="param-description">
</div>
</li>
<li class="param">
<code class="param-name optional">[chassisConnectionPointWorld]</code>
<span class="type"><a href="../classes/Vec3.html" class="crosslink">Vec3</a></span>
<span class="flag optional" title="This parameter is optional.">optional</span>
<div class="param-description">
</div>
</li>
<li class="param">
<code class="param-name optional">[directionLocal]</code>
<span class="type"><a href="../classes/Vec3.html" class="crosslink">Vec3</a></span>
<span class="flag optional" title="This parameter is optional.">optional</span>
<div class="param-description">
</div>
</li>
<li class="param">
<code class="param-name optional">[directionWorld]</code>
<span class="type"><a href="../classes/Vec3.html" class="crosslink">Vec3</a></span>
<span class="flag optional" title="This parameter is optional.">optional</span>
<div class="param-description">
</div>
</li>
<li class="param">
<code class="param-name optional">[axleLocal]</code>
<span class="type"><a href="../classes/Vec3.html" class="crosslink">Vec3</a></span>
<span class="flag optional" title="This parameter is optional.">optional</span>
<div class="param-description">
</div>
</li>
<li class="param">
<code class="param-name optional">[axleWorld]</code>
<span class="type"><a href="../classes/Vec3.html" class="crosslink">Vec3</a></span>
<span class="flag optional" title="This parameter is optional.">optional</span>
<div class="param-description">
</div>
</li>
<li class="param">
<code class="param-name optional">[suspensionRestLength=1]</code>
<span class="type">Number</span>
<span class="flag optional" title="This parameter is optional.">optional</span>
<div class="param-description">
</div>
</li>
<li class="param">
<code class="param-name optional">[suspensionMaxLength=2]</code>
<span class="type">Number</span>
<span class="flag optional" title="This parameter is optional.">optional</span>
<div class="param-description">
</div>
</li>
<li class="param">
<code class="param-name optional">[radius=1]</code>
<span class="type">Number</span>
<span class="flag optional" title="This parameter is optional.">optional</span>
<div class="param-description">
</div>
</li>
<li class="param">
<code class="param-name optional">[suspensionStiffness=100]</code>
<span class="type">Number</span>
<span class="flag optional" title="This parameter is optional.">optional</span>
<div class="param-description">
</div>
</li>
<li class="param">
<code class="param-name optional">[dampingCompression=10]</code>
<span class="type">Number</span>
<span class="flag optional" title="This parameter is optional.">optional</span>
<div class="param-description">
</div>
</li>
<li class="param">
<code class="param-name optional">[dampingRelaxation=10]</code>
<span class="type">Number</span>
<span class="flag optional" title="This parameter is optional.">optional</span>
<div class="param-description">
</div>
</li>
<li class="param">
<code class="param-name optional">[frictionSlip=10000]</code>
<span class="type">Number</span>
<span class="flag optional" title="This parameter is optional.">optional</span>
<div class="param-description">
</div>
</li>
<li class="param">
<code class="param-name optional">[steering=0]</code>
<span class="type">Number</span>
<span class="flag optional" title="This parameter is optional.">optional</span>
<div class="param-description">
</div>
</li>
<li class="param">
<code class="param-name optional">[rotation=0]</code>
<span class="type">Number</span>
<span class="flag optional" title="This parameter is optional.">optional</span>
<div class="param-description">
</div>
</li>
<li class="param">
<code class="param-name optional">[deltaRotation=0]</code>
<span class="type">Number</span>
<span class="flag optional" title="This parameter is optional.">optional</span>
<div class="param-description">
</div>
</li>
<li class="param">
<code class="param-name optional">[rollInfluence=0.01]</code>
<span class="type">Number</span>
<span class="flag optional" title="This parameter is optional.">optional</span>
<div class="param-description">
</div>
</li>
<li class="param">
<code class="param-name optional">[maxSuspensionForce]</code>
<span class="type">Number</span>
<span class="flag optional" title="This parameter is optional.">optional</span>
<div class="param-description">
</div>
</li>
<li class="param">
<code class="param-name optional">[isFrontWheel=true]</code>
<span class="type">Boolean</span>
<span class="flag optional" title="This parameter is optional.">optional</span>
<div class="param-description">
</div>
</li>
<li class="param">
<code class="param-name optional">[clippedInvContactDotSuspension=1]</code>
<span class="type">Number</span>
<span class="flag optional" title="This parameter is optional.">optional</span>
<div class="param-description">
</div>
</li>
<li class="param">
<code class="param-name optional">[suspensionRelativeVelocity=0]</code>
<span class="type">Number</span>
<span class="flag optional" title="This parameter is optional.">optional</span>
<div class="param-description">
</div>
</li>
<li class="param">
<code class="param-name optional">[suspensionForce=0]</code>
<span class="type">Number</span>
<span class="flag optional" title="This parameter is optional.">optional</span>
<div class="param-description">
</div>
</li>
<li class="param">
<code class="param-name optional">[skidInfo=0]</code>
<span class="type">Number</span>
<span class="flag optional" title="This parameter is optional.">optional</span>
<div class="param-description">
</div>
</li>
<li class="param">
<code class="param-name optional">[suspensionLength=0]</code>
<span class="type">Number</span>
<span class="flag optional" title="This parameter is optional.">optional</span>
<div class="param-description">
</div>
</li>
<li class="param">
<code class="param-name optional">[maxSuspensionTravel=1]</code>
<span class="type">Number</span>
<span class="flag optional" title="This parameter is optional.">optional</span>
<div class="param-description">
</div>
</li>
<li class="param">
<code class="param-name optional">[useCustomSlidingRotationalSpeed=false]</code>
<span class="type">Boolean</span>
<span class="flag optional" title="This parameter is optional.">optional</span>
<div class="param-description">
</div>
</li>
<li class="param">
<code class="param-name optional">[customSlidingRotationalSpeed=-0.1]</code>
<span class="type">Number</span>
<span class="flag optional" title="This parameter is optional.">optional</span>
<div class="param-description">
</div>
</li>
</ul>
</li>
</ul>
</div>
</div>
</div>
<div id="classdocs" class="tabview">
<ul class="api-class-tabs">
<li class="api-class-tab index"><a href="#index">Index</a></li>
<li class="api-class-tab properties"><a href="#properties">Properties</a></li>
</ul>
<div>
<div id="index" class="api-class-tabpanel index">
<h2 class="off-left">Item Index</h2>
<div class="index-section properties">
<h3>Properties</h3>
<ul class="index-list properties">
<li class="index-item property">
<a href="#property_axleLocal">axleLocal</a>
</li>
<li class="index-item property">
<a href="#property_axleWorld">axleWorld</a>
</li>
<li class="index-item property">
<a href="#property_brake">brake</a>
</li>
<li class="index-item property">
<a href="#property_chassisConnectionPointLocal">chassisConnectionPointLocal</a>
</li>
<li class="index-item property">
<a href="#property_chassisConnectionPointWorld">chassisConnectionPointWorld</a>
</li>
<li class="index-item property">
<a href="#property_clippedInvContactDotSuspension">clippedInvContactDotSuspension</a>
</li>
<li class="index-item property">
<a href="#property_customSlidingRotationalSpeed">customSlidingRotationalSpeed</a>
</li>
<li class="index-item property">
<a href="#property_dampingCompression">dampingCompression</a>
</li>
<li class="index-item property">
<a href="#property_dampingRelaxation">dampingRelaxation</a>
</li>
<li class="index-item property">
<a href="#property_deltaRotation">deltaRotation</a>
</li>
<li class="index-item property">
<a href="#property_directionLocal">directionLocal</a>
</li>
<li class="index-item property">
<a href="#property_directionWorld">directionWorld</a>
</li>
<li class="index-item property">
<a href="#property_engineForce">engineForce</a>
</li>
<li class="index-item property">
<a href="#property_forwardImpulse">forwardImpulse</a>
</li>
<li class="index-item property">
<a href="#property_frictionSlip">frictionSlip</a>
</li>
<li class="index-item property">
<a href="#property_isFrontWheel">isFrontWheel</a>
</li>
<li class="index-item property">
<a href="#property_isInContact">isInContact</a>
</li>
<li class="index-item property">
<a href="#property_maxSuspensionForce">maxSuspensionForce</a>
</li>
<li class="index-item property">
<a href="#property_maxSuspensionTravel">maxSuspensionTravel</a>
</li>
<li class="index-item property">
<a href="#property_radius">radius</a>
</li>
<li class="index-item property">
<a href="#property_raycastResult">raycastResult</a>
</li>
<li class="index-item property">
<a href="#property_rollInfluence">rollInfluence</a>
</li>
<li class="index-item property">
<a href="#property_rotation">rotation</a>
</li>
<li class="index-item property">
<a href="#property_sideImpulse">sideImpulse</a>
</li>
<li class="index-item property">
<a href="#property_skidInfo">skidInfo</a>
</li>
<li class="index-item property">
<a href="#property_sliding">sliding</a>
</li>
<li class="index-item property">
<a href="#property_steering">steering</a>
</li>
<li class="index-item property">
<a href="#property_suspensionForce">suspensionForce</a>
</li>
<li class="index-item property">
<a href="#property_suspensionLength">suspensionLength</a>
</li>
<li class="index-item property">
<a href="#property_suspensionMaxLength">suspensionMaxLength</a>
</li>
<li class="index-item property">
<a href="#property_suspensionRelativeVelocity">suspensionRelativeVelocity</a>
</li>
<li class="index-item property">
<a href="#property_suspensionRestLength">suspensionRestLength</a>
</li>
<li class="index-item property">
<a href="#property_suspensionStiffness">suspensionStiffness</a>
</li>
<li class="index-item property">
<a href="#property_useCustomSlidingRotationalSpeed">useCustomSlidingRotationalSpeed</a>
</li>
<li class="index-item property">
<a href="#property_worldTransform">worldTransform</a>
</li>
</ul>
</div>
</div>
<div id="properties" class="api-class-tabpanel">
<h2 class="off-left">Properties</h2>
<div id="property_axleLocal" class="property item">
<h3 class="name"><code>axleLocal</code></h3>
<span class="type"><a href="../classes/Vec3.html" class="crosslink">Vec3</a></span>
<div class="meta">
<p>
Defined in
<a href="../files/src_objects_WheelInfo.js.html#l116"><code>src/objects/WheelInfo.js:116</code></a>
</p>
</div>
<div class="description">
</div>
</div>
<div id="property_axleWorld" class="property item">
<h3 class="name"><code>axleWorld</code></h3>
<span class="type"><a href="../classes/Vec3.html" class="crosslink">Vec3</a></span>
<div class="meta">
<p>
Defined in
<a href="../files/src_objects_WheelInfo.js.html#l121"><code>src/objects/WheelInfo.js:121</code></a>
</p>
</div>
<div class="description">
</div>
</div>
<div id="property_brake" class="property item">
<h3 class="name"><code>brake</code></h3>
<span class="type">Number</span>
<div class="meta">
<p>
Defined in
<a href="../files/src_objects_WheelInfo.js.html#l192"><code>src/objects/WheelInfo.js:192</code></a>
</p>
</div>
<div class="description">
</div>
</div>
<div id="property_chassisConnectionPointLocal" class="property item">
<h3 class="name"><code>chassisConnectionPointLocal</code></h3>
<span class="type"><a href="../classes/Vec3.html" class="crosslink">Vec3</a></span>
<div class="meta">
<p>
Defined in
<a href="../files/src_objects_WheelInfo.js.html#l95"><code>src/objects/WheelInfo.js:95</code></a>
</p>
</div>
<div class="description">
<p>Connection point, defined locally in the chassis body frame.</p>
</div>
</div>
<div id="property_chassisConnectionPointWorld" class="property item">
<h3 class="name"><code>chassisConnectionPointWorld</code></h3>
<span class="type"><a href="../classes/Vec3.html" class="crosslink">Vec3</a></span>
<div class="meta">
<p>
Defined in
<a href="../files/src_objects_WheelInfo.js.html#l101"><code>src/objects/WheelInfo.js:101</code></a>
</p>
</div>
<div class="description">
</div>
</div>
<div id="property_clippedInvContactDotSuspension" class="property item">
<h3 class="name"><code>clippedInvContactDotSuspension</code></h3>
<span class="type">Number</span>
<div class="meta">
<p>
Defined in
<a href="../files/src_objects_WheelInfo.js.html#l202"><code>src/objects/WheelInfo.js:202</code></a>
</p>
</div>
<div class="description">
</div>
</div>
<div id="property_customSlidingRotationalSpeed" class="property item">
<h3 class="name"><code>customSlidingRotationalSpeed</code></h3>
<span class="type">Number</span>
<div class="meta">
<p>
Defined in
<a href="../files/src_objects_WheelInfo.js.html#l78"><code>src/objects/WheelInfo.js:78</code></a>
</p>
</div>
<div class="description">
<p>Speed to apply to the wheel rotation when the wheel is sliding.</p>
</div>
</div>
<div id="property_dampingCompression" class="property item">
<h3 class="name"><code>dampingCompression</code></h3>
<span class="type">Number</span>
<div class="meta">
<p>
Defined in
<a href="../files/src_objects_WheelInfo.js.html#l146"><code>src/objects/WheelInfo.js:146</code></a>
</p>
</div>
<div class="description">
</div>
</div>
<div id="property_dampingRelaxation" class="property item">
<h3 class="name"><code>dampingRelaxation</code></h3>
<span class="type">Number</span>
<div class="meta">
<p>
Defined in
<a href="../files/src_objects_WheelInfo.js.html#l151"><code>src/objects/WheelInfo.js:151</code></a>
</p>
</div>
<div class="description">
</div>
</div>
<div id="property_deltaRotation" class="property item">
<h3 class="name"><code>deltaRotation</code></h3>
<span class="type">Number</span>
<div class="meta">
<p>
Defined in
<a href="../files/src_objects_WheelInfo.js.html#l172"><code>src/objects/WheelInfo.js:172</code></a>
</p>
</div>
<div class="description">
</div>
</div>
<div id="property_directionLocal" class="property item">
<h3 class="name"><code>directionLocal</code></h3>
<span class="type"><a href="../classes/Vec3.html" class="crosslink">Vec3</a></span>
<div class="meta">
<p>
Defined in
<a href="../files/src_objects_WheelInfo.js.html#l106"><code>src/objects/WheelInfo.js:106</code></a>
</p>
</div>
<div class="description">
</div>
</div>
<div id="property_directionWorld" class="property item">
<h3 class="name"><code>directionWorld</code></h3>
<span class="type"><a href="../classes/Vec3.html" class="crosslink">Vec3</a></span>
<div class="meta">
<p>
Defined in
<a href="../files/src_objects_WheelInfo.js.html#l111"><code>src/objects/WheelInfo.js:111</code></a>
</p>
</div>
<div class="description">
</div>
</div>
<div id="property_engineForce" class="property item">
<h3 class="name"><code>engineForce</code></h3>
<span class="type">Number</span>
<div class="meta">
<p>
Defined in
<a href="../files/src_objects_WheelInfo.js.html#l187"><code>src/objects/WheelInfo.js:187</code></a>
</p>
</div>
<div class="description">
</div>
</div>
<div id="property_forwardImpulse" class="property item">
<h3 class="name"><code>forwardImpulse</code></h3>
<span class="type">Number</span>
<div class="meta">
<p>
Defined in
<a href="../files/src_objects_WheelInfo.js.html#l232"><code>src/objects/WheelInfo.js:232</code></a>
</p>
</div>
<div class="description">
</div>
</div>
<div id="property_frictionSlip" class="property item">
<h3 class="name"><code>frictionSlip</code></h3>
<span class="type">Number</span>
<div class="meta">
<p>
Defined in
<a href="../files/src_objects_WheelInfo.js.html#l156"><code>src/objects/WheelInfo.js:156</code></a>
</p>
</div>
<div class="description">
</div>
</div>
<div id="property_isFrontWheel" class="property item">
<h3 class="name"><code>isFrontWheel</code></h3>
<span class="type">Number</span>
<div class="meta">
<p>
Defined in
<a href="../files/src_objects_WheelInfo.js.html#l197"><code>src/objects/WheelInfo.js:197</code></a>
</p>
</div>
<div class="description">
</div>
</div>
<div id="property_isInContact" class="property item">
<h3 class="name"><code>isInContact</code></h3>
<span class="type">Boolean</span>
<div class="meta">
<p>
Defined in
<a href="../files/src_objects_WheelInfo.js.html#l249"><code>src/objects/WheelInfo.js:249</code></a>
</p>
</div>
<div class="description">
</div>
</div>
<div id="property_maxSuspensionForce" class="property item">
<h3 class="name"><code>maxSuspensionForce</code></h3>
<span class="type">Number</span>
<div class="meta">
<p>
De