API Documentation for:
Show:

File:addBox2D\Dynamics\Joints\b2Jacobian.js

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

 // CLASS CONSTRUCTOR

    /**
     * @class b2Jacobian
     * @constructor
     * @module  Joints
     */
    function b2Jacobian() {

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

     // property DECLARATIONS

        /**
         * @public
         * @property  linear
         * @type      {b2Vec2}
         */
        this.linear = new b2Vec2;

        /**
         * @public
         * @property  angularA
         * @type      {float}
         * @default     0.0
         */
        this.angularA = 0.0;

        /**
         * @public
         * @property  angularB
         * @type      {float}
         * @default     0.0
         */
        this.angularB = 0.0;


    } p = b2Jacobian.prototype; Box2D.b2Jacobian = b2Jacobian;

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

 // INSTANCE METHODS

    /**
     * @public
     * @method  setZero
     * @return  {b2Jacobian}
     * @chainable
     */
    p.setZero = function () {
        this.linear.setZero();
        this.angularA = 0;
        this.angularB = 0;
        return this;
    };

    /**
     *
     * @public
     * @method  set
     * @param   {b2Vec2}    vector
     * @param   {float}     angularA
     * @param   {float}     angularB
     * @return  {b2Jacobian}
     */
    p.set = function ( vector, angularA, angularB ) {
        this.linear.copy( vector );
        this.angularA = angularA;
        this.angularB = angularB;
        return this;
    };