Source: Core/Engine_Physics.js

/*
 * File: EngineCore_Physics.js 
 * Physics engine supporting projection and impulse collision resolution. 
 */
/*jslint node: true, vars: true, white: true */
/*global vec2, CollisionInfo */
/* find out more about jslint: http://www.jslint.com/help.html */

"use strict";  // Operate in Strict mode such that variables must be declared before used!

/**
 * Static refrence to gEngine
 * @type gEngine
 */
var gEngine = gEngine || { };
    // initialize the variable while ensuring it is not redefined

/**
 * Default Constructor<p>
 * Physics engine supporting projection and impulse collision resolution. <p>
 * @class gEngine.Physics
 * @type gEngine.Physics
 */
gEngine.Physics = (function () {
    var mRelaxationCount = 15;                  // number of relaxation iteration
    var mRelaxationOffset = 1/mRelaxationCount; // porportion to apply when scaling friction
    var mPosCorrectionRate = 0.8;               // percentage of separation to project objects
    var mSystemtAcceleration = [0, -50];        // system-wide default acceleration
    
    var mRelaxationLoopCount = 0;               // the current relaxation count
    var mHasOneCollision = false;               // detect the first collision
    
    var mCollisionInfo = null;                  // information of the current collision
    
    /**
     * Initilize the Engine Physics
     * @memberOf gEngine.Physics
     * @returns {void}
     */
    var initialize = function() {
        mCollisionInfo = new CollisionInfo(); // to avoid allocating this constantly
    };
    
    var _positionalCorrection = function (s1, s2, collisionInfo) {
        var s1InvMass = s1.getInvMass();
        var s2InvMass = s2.getInvMass();
        var num = collisionInfo.getDepth() / (s1InvMass + s2InvMass) * mPosCorrectionRate;
        var correctionAmount = [0, 0];
        vec2.scale(correctionAmount, collisionInfo.getNormal(), num);

        var ca = [0, 0];
        vec2.scale(ca, correctionAmount, s1InvMass);
        var s1Pos = s1.getPosition();
        vec2.subtract(s1Pos, s1Pos, ca);

        vec2.scale(ca, correctionAmount, s2InvMass);
        var s2Pos = s2.getPosition();
        vec2.add(s2Pos, s2Pos, ca);
    };
    
    // n is the collision normal
    // v is the velocity
    // f is the friction 
    // m is the invMass
    var _applyFriction = function(n, v, f, m) {
        var tangent = vec2.fromValues(n[1], -n[0]);  // perpendicular to n
        var tComponent = vec2.dot(v, tangent);
        if (Math.abs(tComponent) < 0.01)
            return;
        
        f *= m * mRelaxationOffset;
        if (tComponent < 0) {
            vec2.scale(tangent, tangent, -f);
        } else {
            vec2.scale(tangent, tangent, f);
        }
        vec2.sub(v, v, tangent);
    };
    
    /**
     * 
     * @memberOf gEngine.Physics
     * @param {RigidShape} s1 shape 1
     * @param {RigidShape} s2 shape 2
     * @param {CollisionInfo} collisionInfo
     * @returns {void}
     */
    var resolveCollision = function (s1, s2, collisionInfo) {
        // Step A: one collision has been found
        mHasOneCollision = true;
        
        // Step B: correct positions
        _positionalCorrection(s1, s2, collisionInfo);

        // collision normal direction is _against_ s2
        // Step C: apply friction
        var s1V = s1.getVelocity();
        var s2V = s2.getVelocity();
        var n = collisionInfo.getNormal();
        _applyFriction(n, s1V, s1.getFriction(), s1.getInvMass());
        _applyFriction(n, s2V, -s2.getFriction(), s2.getInvMass());

        // Step D: compute relatively velocity of the colliding objects
        var relativeVelocity = [0, 0];
        vec2.sub(relativeVelocity, s2V, s1V);

        // Step E: examine the component in the normal direction
        // Relative velocity in normal direction
        var rVelocityInNormal = vec2.dot(relativeVelocity, n);
        //if objects moving apart ignore
        if (rVelocityInNormal > 0) {
            return;
        }
        
        // Step F: compute and apply response impulses for each object
        var newRestituion = Math.min(s1.getRestitution(), s2.getRestitution());
        // Calc impulse scalar
        var j = -(1 + newRestituion) * rVelocityInNormal;
        j = j / (s1.getInvMass() + s2.getInvMass());

        var impulse = [0, 0];
        vec2.scale(impulse, collisionInfo.getNormal(), j);

        var newImpulse = [0, 0];
        vec2.scale(newImpulse, impulse, s1.getInvMass());
        vec2.sub(s1V, s1V, newImpulse);

        vec2.scale(newImpulse, impulse, s2.getInvMass());
        vec2.add(s2V, s2V, newImpulse);
    };
    
    /**
     * Start Relaxation
     * @memberOf gEngine.Physics
     * @returns {void}
     */
    var beginRelaxation = function() { 
        mRelaxationLoopCount = mRelaxationCount; 
        mHasOneCollision = true;
    };
    
    /**
     * Continue Relaxation
     * @memberOf gEngine.Physics
     * @returns {Boolean} true if Relaxation is active
     */
    var continueRelaxation = function() { 
        var oneCollision = mHasOneCollision;
        mHasOneCollision = false;
        mRelaxationLoopCount = mRelaxationLoopCount - 1;
        return ((mRelaxationLoopCount > 0) && oneCollision); 
    };
    
    /**
     * Rigid Shape interactions: two game objects
     * @memberOf gEngine.Physics
     * @param {GameObject} obj1 GameObject 1
     * @param {GameObject} obj2 GameObject 2
     * @returns {void}
     */
    var processObjObj = function(obj1, obj2) {
        var s1 = obj1.getPhysicsComponent();
        var s2 = obj2.getPhysicsComponent();
        if (s1 === s2)
            return;
        beginRelaxation();
        while (continueRelaxation()) {
            if (s1.collided(s2, mCollisionInfo)) {
                resolveCollision(s1, s2, mCollisionInfo);
            }
        }
    };
    
    /**
     * Rigid Shape interactions: a game object and a game object set
     * @memberOf gEngine.Physics
     * @param {GameObject} obj GameObject
     * @param {GameObjectSet} set GameObjectSet
     * @returns {void}
     */
    var processObjSet = function(obj, set) {
        var s1 = obj.getPhysicsComponent();
        var i, s2;
        beginRelaxation();
        while (continueRelaxation()) {
            for (i=0; i<set.size(); i++) {
                s2 = set.getObjectAt(i).getPhysicsComponent();
                if ((s1 !== s2) && (s1.collided(s2, mCollisionInfo))) {
                    resolveCollision(s1, s2, mCollisionInfo);
                }
            }
        }
    };
    
    /**
     * Rigid Shape interactions: two game object sets
     * @memberOf gEngine.Physics
     * @param {GameObjectSet} set1 GameObjectSet 1
     * @param {GameObjectSet} set2 GameObjectSet 2
     * @returns {void}
     */
    var processSetSet = function(set1, set2) {
        var i, j, s1, s2;
        beginRelaxation();
        while (continueRelaxation()) {
            for (i=0; i<set1.size(); i++) {
                s1 = set1.getObjectAt(i).getPhysicsComponent();
                for (j=0; j<set2.size(); j++) {
                    s2 = set2.getObjectAt(j).getPhysicsComponent();
                    if ((s1 !== s2) && (s1.collided(s2, mCollisionInfo))) {
                        resolveCollision(s1, s2, mCollisionInfo);
                    }
                }
            }
        }
    };
    
    /**
     * Rigid Shape interactions: a set against itself
     * @memberOf gEngine.Physics
     * @param {GameObjectSet} set GameObjectSet
     * @returns {void}
     */
    var processSelfSet = function(set) {
        var i, j, s1, s2;
        beginRelaxation();
        while (continueRelaxation()) {
            for (i=0; i<set.size(); i++) {
                s1 = set.getObjectAt(i).getPhysicsComponent();
                for (j=i+1; j<set.size(); j++) {
                    s2 = set.getObjectAt(j).getPhysicsComponent();
                    if ((s1 !== s2) && (s1.collided(s2, mCollisionInfo))) {
                        resolveCollision(s1, s2, mCollisionInfo);
                    }
                }
            }
        }
    };
    
    /**
     * Return System Acceleration Value [x, y]
     * @memberOf gEngine.Physics
     * @returns {Float[]} System Acceleration [x, y]
     */
    var getSystemtAcceleration = function() { return mSystemtAcceleration; };
    
    /**
     * Set System Acceleration Value [x, y]
     * @memberOf gEngine.Physics
     * @param {Float[]} g New System Acceleration [x, y]
     * @returns {void}
     */
    var setSystemtAcceleration = function(g) { mSystemtAcceleration = g; };
    
    /**
     * Return Relaxation Correction Rate Value
     * @memberOf gEngine.Physics
     * @returns {Number} Relaxation Correction Rate
     */
    var getRelaxationCorrectionRate = function() { return mPosCorrectionRate; };
    
    /**
     * Set Relaxation Correction Rate Value
     * @memberOf gEngine.Physics
     * @param {Number} r Relaxation Correction Rate
     * @returns {void}
     */
    var setRelaxationCorrectionRate = function(r) {
        if ((r <= 0) || (r>=1)) {
            r = 0.8;
        }
        mPosCorrectionRate = r;
    };
    
    /**
     * Return Relaxation Loop Count
     * @memberOf gEngine.Physics
     * @returns {Number} Relaxation Loop Count
     */
    var getRelaxationLoopCount = function() { return mRelaxationCount; };
    
    /**
     * Set Relaxation Loop Count
     * @memberOf gEngine.Physics
     * @param {Number} c New Relaxation Loop Count
     * @returns {void}
     */
    var setRelaxationLoopCount = function(c) { 
        if (c <= 0)
            c = 1;
        mRelaxationCount = c; 
        mRelaxationOffset = 1/mRelaxationCount;
    };
    
    var mPublic = {
        initialize: initialize,
        resolveCollision: resolveCollision,
        beginRelaxation: beginRelaxation,
        continueRelaxation: continueRelaxation,
        getSystemtAcceleration: getSystemtAcceleration,
        setSystemtAcceleration: setSystemtAcceleration,
        getRelaxationCorrectionRate: getRelaxationCorrectionRate,
        setRelaxationCorrectionRate: setRelaxationCorrectionRate,
        getRelaxationLoopCount: getRelaxationLoopCount,
        setRelaxationLoopCount: setRelaxationLoopCount,
        processObjObj: processObjObj,
        processObjSet: processObjSet,
        processSetSet: processSetSet,
        processSelfSet: processSelfSet
    };

    return mPublic;
}());