File:addBox2D\Dynamics\Joints\b2WheelJointDef.js
//################################################################################################//
//################################################################################################//
// //
// ██ ██ ██ ██ ██ ██ ██ ██ █████ ████ //
// ██ ██ ██ ██ ██ ██ ██ ██ ██ ██ //
// ██ ██ ██ █████ █████ █████ ██ ██ █████ ██ █████ █████ ██ ██ █████ ██ //
// ██ ██ ██ ██ ██ ██ ██ ██ ██ ██ ██ ██ ██ ██ ██ ██ ██ ██ ██ ██ ██ █████ //
// ██ ██ ██ ██ ██ █████ █████ ██ ██ ██ ██ ██ ██ ██ ██ ██ ██ █████ ██ //
// ██ ██ ██ ██ ██ ██ ██ ██ ██ ██ ██ ██ ██ ██ ██ ██ ██ ██ ██ //
// ██████████ ██ ██ █████ █████ ██ █████ █████ ██ ██ ██ ████ █████ █████ ██ //
// //
//################################################################################################//
//################################################################################################//
// CLASS CONSTRUCTOR
/**
* Wheel joint definition. This requires defining a line of
* motion using an axis and an anchor point. The definition uses
* local anchor points and a local axis so that the initial
* configuration can violate the constraint slightly. The joint
* translation is zero when the local anchor points coincide in
* world space. Using local anchors and a local axis helps when
* saving and loading a game.
*
* @class b2WheelJointDef
* @constructor
* @extends {b2JointDef}
* @module Joints
*/
function b2WheelJointDef() {
/**
* Invokes parent class constructor function reference.
*/
this.constructor( b2Joint.e_wheelJoint );
////////////////////////////////////////////////////////////////////////////////////////////////////
// //
// ██████ ██ ██ //
// ██ ██ ██ //
// ██ ██ ████ █████ █████ █████ ████ █████ ██ █████ █████ //
// ██████ ██ ██ ██ ██ ██ ██ ██ ██ ██ ██ ██ ██ ██ //
// ██ ██ ██ ██ ██ ██ █████ ██ ██ ██ █████ █████ //
// ██ ██ ██ ██ ██ ██ ██ ██ ██ ██ ██ ██ //
// ██ ██ █████ █████ █████ ██ ████ ██ █████ █████ //
// ██ //
// ██ //
// //
////////////////////////////////////////////////////////////////////////////////////////////////////
// property DECLARATIONS
/**
* The local anchor point relative to bodyA's origin.
*
* @public
* @property localAnchorA
* @type {b2Vec2}
*/
this.localAnchorA = new b2Vec2;
/**
* The local anchor point relative to bodyB's origin.
*
* @public
* @property localAnchorB
* @type {b2Vec2}
*/
this.localAnchorB = new b2Vec2;
/**
* The local translation axis in bodyA.
*
* @public
* @property localAxisA
* @type {b2Vec2}
*/
this.localAxisA = new b2Vec2;
/**
* The local translation axis in bodyA.
*
* @public
* @property localAxisA
* @type {b2Vec2}
*/
this.localAxisA = new b2Vec2;
// property INITIALISATIONS
this.localAxisA.set( 1.0, 0.0 );
/**
*
* @public
* @property type
* @type {int}
*/
// @this.constructor( b2Joint.e_wheelJoint ) above.
/**
* Suspension damping ratio, one indicates critical damping
*
* @public
* @property dampingRatio
* @type {float}
* @default 0.0
*/
this.dampingRatio = 0.7;
/**
*
* @public
* @property enableLimit
* @type {boolean}
* @default false
*/
this.enableLimit = false;
/**
* Enable/disable the joint motor.
*
* @public
* @property enableMotor
* @type {boolean}
* @default false
*/
this.enableMotor = false;
/**
* Suspension frequency, zero indicates no suspension
*
* @public
* @property upperTranslation
* @type {number}
* @default 0
*/
this.frequencyHz = 2.0;
/**
*
* @public
* @property maxMotorTorque
* @type {float}
* @default 0.0
*/
this.maxMotorTorque = 0.0;
/**
* The desired motor speed in radians per second.
*
* @public
* @property motorSpeed
* @type {float}
* @default 0.0
*/
this.motorSpeed = 0.0;
////////////////////////////////////////////////////////////////////////////////////////////////////
// //
// ██ ██ ██ ██ //
// ██ ██ ██ //
// ██ █████ █████ █████ ████ ██ █████ █████ █████ █████ █████ //
// ██ ██ ██ ██ ██ ██ ██ ██ ██ ██ ██ ██ ██ ██ ██ ██ //
// ██ ██ ██ ██ ██ █████ ██ ██ ██ █████ ██ ██ ██ █████ //
// ██ ██ ██ ██ ██ ██ ██ ██ ██ ██ ██ ██ ██ ██ ██ //
// ██ ██ ██ ██ ██ █████ ██ ██ ████ █████ ██ ██ █████ █████ //
// //
////////////////////////////////////////////////////////////////////////////////////////////////////
} b2WheelJointDef.prototype = p = new b2JointDef; Box2D.b2WheelJointDef = b2WheelJointDef;
////////////////////////////////////////////////////////////////////////////////////////////////////
// //
// ██ ██ ██ ██ ██ //
// ███ ███ ██ ██ ██ //
// ███████ █████ █████ █████ █████ █████ █████ //
// ██ █ ██ ██ ██ ██ ██ ██ ██ ██ ██ ██ ██ //
// ██ ██ █████ ██ ██ ██ ██ ██ ██ ██ █████ //
// ██ ██ ██ ██ ██ ██ ██ ██ ██ ██ ██ //
// ██ ██ █████ ████ ██ ██ █████ █████ █████ //
// //
////////////////////////////////////////////////////////////////////////////////////////////////////
// INSTANCE METHODS
/**
* @public
* @method initialize
* @param {b2Body} bodyA
* @param {b2Body} bodyB
* @param {b2Vec2} anchor
* @param {b2Vec2} axis
* @return {void}
*/
p.initialize = function ( bodyA, bodyB, anchor, axis ) {
this.bodyA = bodyA;
this.bodyB = bodyB;
this.bodyA.getLocalPoint( anchor, this.localAnchorA );
this.bodyB.getLocalPoint( anchor, this.localAnchorB );
this.bodyA.getLocalVector( axis, this.localAxisA );
};
