API Documentation for:
Show:

File:addBox2D\Dynamics\Joints\b2GearJointDef.js

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

 // CLASS CONSTRUCTOR

    /**
     * Gear joint definition. This definition requires two existing
     * revolute or prismatic joints (any combination will work).
     *
     * @class b2GearJointDef
     * @constructor
     * @extends {b2JointDef}
     * @module  Joints
     */
    function b2GearJointDef() {

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

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

        // property INITIALISATIONS

        /**
         * @public
         * @property    type
         * @type        {int}
         * @default     b2Joint.e_gearJoint
         */
        // @this.constructor( b2Joint.e_gearJoint ); above

        /**
         * The first revolute/prismatic joint attached to the gear joint.
         *
         * @public
         * @property  joint1
         * @type      {b2Joint|null}
         * @default   null
         */
        this.joint1 = null;

        /**
         * The second revolute/prismatic joint attached to the gear joint.
         *
         * @public
         * @property  joint2
         * @type      {b2Joint|null}
         * @default   null
         */
        this.joint2 = null;

        /**
         * The gear ratio.
         * @see b2GearJoint for explanation.
         *
         * @public
         * @property  ratio
         * @type      {float}
         * @default   1.0
         */
        this.ratio = 1.0;


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

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

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

 // INSTANCE METHODS

    /**
     * @public
     * @method  initialize
     * @param   {b2Body} bodyA
     * @param   {b2Body} bodyB
     * @param   {b2Vec2} anchor
     * @return  {void}
     */
    p.initialize = function ( bodyA, bodyB, anchor ) {
        //TODO: implement initialize()
    };