API Documentation for:
Show:

File:addBox2D\Dynamics\Joints\b2AreaJointDef.js

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

 // CLASS CONSTRUCTOR

    /**
     * Definitions for a b2AreaJoint which maintains the relationship between group of
     * moving bodies so that they maintain a constant volume (area in 2D) between them.
     *
     * @class b2AreaJointDef
     * @constructor
     * @extends {b2JointDef}
     * @module  Joints
     */
    function b2AreaJointDef() {

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

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

     // property INITIALISATIONS

        /**
         *
         * @public
         * @property    m_bodies
         * @type        {Array}
         * @default     []
         */
        this.bodies = [];

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

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

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

        /**
         * The mass-spring-damper frequency in Hertz. A value of 0 disables softness.
         *
         * @public
         * @property  frequencyHz
         * @type      {b2World}
         * @default   null
         */
        this.world = null;

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

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

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

 // INSTANCE METHODS

    /**
     *
     * @public
     * @method  addBody
     * @param   {b2Body} body
     * @return  {void}
     */
    p.addBody = function ( body ) {
        this.bodies.push( body );

        if ( this.bodies.length === 1 ) {
            this.bodyA = body;
        }
        else if ( this.bodies.length === 2 ) {
            this.bodyB = body;
        }
    };