API Documentation for:
Show:

File:addBox2D\Dynamics\Joints\b2MouseJointDef.js

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

 // CLASS CONSTRUCTOR

    /**
     * Mouse joint definition. This requires a world target point,
     * tuning parameters, and the time step.
     *
     * @class b2MouseJointDef
     * @constructor
     * @extends {b2JointDef}
     * @module  Joints
     */
    function b2MouseJointDef() {

        /**
         *Invoke parent class constructor function reference.
         */
        this.constructor( b2Joint.e_mouseJoint );

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

     // property DECLARATIONS

        /**
         * The initial world target point. This is assumed to coincide
         * with the body anchor initially.
         *
         * @public
         * @property  target
         * @type      {b2Vec2}
         */
        this.target = new b2Vec2;

     // property INITIALISATIONS

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

        /**
         * The maximum constraint force that can be exerted to move the
         * candidate body. Usually you will express as some multiple of
         * the weight (multiplier * mass * gravity).
         *
         * @public
         * @property  maxForce
         * @type      {float}
         * @default   0.0
         */
        this.maxForce = 0.0;

        /**
         * The response speed.
         *
         * @public
         * @property  frequencyHz
         * @type      {float}
         * @default   5.0
         */
        this.frequencyHz = 5.0;

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


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

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