API Documentation for:
Show:

File:addBox2D\Dynamics\Joints\b2WeldJointDef.js

//################################################################################################//
//################################################################################################//
//                                                                                                //
//            ██  ██  ██       ██    ██    ██       ██        ██   █████         ████             //
//            ██  ██  ██       ██    ██    ██                 ██   ██  ██        ██               //
//            ██  ██  ██ █████ ██ █████    ██ █████ ██ █████ █████ ██  ██ █████  ██               //
//            ██  ██  ██ ██ ██ ██ ██ ██    ██ ██ ██ ██ ██ ██  ██   ██  ██ ██ ██ █████             //
//            ██  ██  ██ █████ ██ ██ ██    ██ ██ ██ ██ ██ ██  ██   ██  ██ █████  ██               //
//            ██  ██  ██ ██    ██ ██ ██    ██ ██ ██ ██ ██ ██  ██   ██  ██ ██     ██               //
//            ██████████ █████ ██ █████ █████ █████ ██ ██ ██  ████ █████  █████  ██               //
//                                                                                                //
//################################################################################################//
//################################################################################################//

 // CLASS CONSTRUCTOR

    /**
     * Weld joint definition. You need to specify local anchor
     * points where they are attached and the relative body angle.
     * The position of the anchor points is important for computing
     * the reaction torque.
     *
     * @class b2WeldJointDef
     * @constructor
     * @extends {b2JointDef}
     * @module  Joints
     */
    function b2WeldJointDef() {

        /**
         * Invokes parent class constructor function reference.
         */
        this.constructor( b2Joint.e_weldJoint );

////////////////////////////////////////////////////////////////////////////////////////////////////
//                                                                                                //
//                  ██████                              ██   ██                                   //
//                  ██  ██                              ██                                        //
//                  ██  ██ ████ █████ █████ █████ ████ █████ ██ █████ █████                       //
//                  ██████ ██   ██ ██ ██ ██ ██ ██ ██    ██   ██ ██ ██ ██                          //
//                  ██     ██   ██ ██ ██ ██ █████ ██    ██   ██ █████ █████                       //
//                  ██     ██   ██ ██ ██ ██ ██    ██    ██   ██ ██       ██                       //
//                  ██     ██   █████ █████ █████ ██    ████ ██ █████ █████                       //
//                                    ██                                                          //
//                                    ██                                                          //
//                                                                                                //
////////////////////////////////////////////////////////////////////////////////////////////////////

     // 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;

     // property INITIALISATIONS

        /**
         * @public
         * @property  type
         * @type      {int}   b2WeldJoint
         */
        // @this.constructor( b2Joint.e_weldJoint ) above

        /**
         * @public
         * @property   bodyA
         * @type       {b2Body|null}
         */
        this.bodyA = null;

        /**
         * @public
         * @property   bodyB
         * @type       {b2Body|null}
         */
        this.bodyB = null;

        /**
         * The bodyB angle minus bodyA angle in the reference state
         * (radians).
         *
         * @public
         * @property  referenceAngle
         * @type      {float}
         * @default   0.0
         */
        this.referenceAngle = 0.0;

        /**
         * The mass-spring-damper frequency in Hertz. Rotation only.
         * Disable softness with a value of 0.
         *
         * @public
         * @property  frequencyHz
         * @type      {float}
         * @default   0.0
         */
        this.frequencyHz = 0.0;

        /**
         * The damping ratio. 0 = no damping, 1 = critical damping.
         *
         * @public
         * @property  dampingRatio
         * @type      {float}
         * @default   0.0
         */
        this.dampingRatio = 0.0;


////////////////////////////////////////////////////////////////////////////////////////////////////
//                                                                                                //
//                  ██       ██               ██  ██                                              //
//                  ██       ██                   ██                                              //
//                  ██ █████ █████ █████ ████ ██ █████ █████ █████ █████ █████                    //
//                  ██ ██ ██ ██ ██ ██ ██ ██   ██  ██      ██ ██ ██ ██    ██ ██                    //
//                  ██ ██ ██ ██ ██ █████ ██   ██  ██   █████ ██ ██ ██    █████                    //
//                  ██ ██ ██ ██ ██ ██    ██   ██  ██   ██ ██ ██ ██ ██    ██                       //
//                  ██ ██ ██ ██ ██ █████ ██   ██  ████ █████ ██ ██ █████ █████                    //
//                                                                                                //
////////////////////////////////////////////////////////////////////////////////////////////////////

    } b2WeldJointDef.prototype = p = new b2JointDef; Box2D.b2WeldJointDef = b2WeldJointDef;

////////////////////////////////////////////////////////////////////////////////////////////////////
//                                                                                                //
//                       ██   ██        ██   ██             ██                                    //
//                       ███ ███        ██   ██             ██                                    //
//                       ███████ █████ █████ █████ █████ █████ █████                              //
//                       ██ █ ██ ██ ██  ██   ██ ██ ██ ██ ██ ██ ██                                 //
//                       ██   ██ █████  ██   ██ ██ ██ ██ ██ ██ █████                              //
//                       ██   ██ ██     ██   ██ ██ ██ ██ ██ ██    ██                              //
//                       ██   ██ █████  ████ ██ ██ █████ █████ █████                              //
//                                                                                                //
////////////////////////////////////////////////////////////////////////////////////////////////////

 // INSTANCE METHODS

    /**
     * @public
     * @method  initialize
     * @param   {b2Body} bodyA
     * @param   {b2Body} bodyB
     * @param   {b2Vec2} anchor
     * @return  {void}
     */
    p.initialize = function ( bodyA, bodyB, anchor ) {
        this.bodyA = bodyA;
        this.bodyB = bodyB;
        this.bodyA.getLocalPoint( anchor, this.localAnchorA );
        this.bodyB.getLocalPoint( anchor, this.localAnchorB );
        this.referenceAngle = this.bodyB.getAngle() - this.bodyA.getAngle();
    };