phaser/src/physics/arcade/SeparateY.js

/**
 * @author       Richard Davey <rich@photonstorm.com>
 * @copyright    2019 Photon Storm Ltd.
 * @license      {@link https://github.com/photonstorm/phaser/blob/master/license.txt|MIT License}
 */

var CONST = require('./const');
var GetOverlapY = require('./GetOverlapY');

/**
 * Separates two overlapping bodies on the Y-axis (vertically).
 *
 * Separation involves moving two overlapping bodies so they don't overlap anymore
 * and adjusting their velocities based on their mass. This is a core part of collision detection.
 *
 * The bodies won't be separated if there is no vertical overlap between them, if they are static,
 * or if either one uses custom logic for its separation.
 *
 * @function Phaser.Physics.Arcade.SeparateY
 * @since 3.0.0
 *
 * @param {Phaser.Physics.Arcade.Body} body1 - The first Body to separate. This is our priority body.
 * @param {Phaser.Physics.Arcade.Body} body2 - The second Body to separate.
 * @param {boolean} overlapOnly - If `true`, the bodies will only have their overlap data set and no separation will take place.
 * @param {number} bias - A value to add to the delta value during overlap checking. Used to prevent sprite tunneling.
 *
 * @return {boolean} `true` if the two bodies overlap vertically, otherwise `false`.
 */
var SeparateY = function (body1, body2, overlapOnly, bias)
{
    var result = GetOverlapY(body1, body2, overlapOnly, bias);

    var overlap = result[0];
    var faceTop = result[1];
    var faceBottom = !faceTop;

    var velocity1 = body1.velocity;
    var velocity2 = body2.velocity;

    var blocked1 = body1.blocked;
    var blocked2 = body2.blocked;

    var body1Immovable = (body1.physicsType === CONST.STATIC_BODY || body1.immovable);
    var body2Immovable = (body2.physicsType === CONST.STATIC_BODY || body2.immovable);

    //  Can't separate two immovable bodies, or a body with its own custom separation logic
    if (overlapOnly || (body1Immovable && body2Immovable) || body1.customSeparateY || body2.customSeparateY)
    {
        //  return true if there was some overlap, otherwise false.
        return (overlap !== 0) || (body1.embedded && body2.embedded);
    }

    //  Adjust their positions and velocities accordingly based on the amount of overlap
    var v1 = velocity1.y;
    var v2 = velocity2.y;

    //  At this point, the velocity from gravity, world rebounds, etc has been factored in.
    //  The body is moving the direction it wants to, but may be blocked.

    /*
    console.log('Collision - top face of body1?', faceTop);

    console.log('body1', body1.gameObject.name);
    console.log('blocked down', blocked1.down, 'blocked up', blocked1.up);
    console.log('touching down', body1.touching.down, 'touching up', body1.touching.up);
    console.log('world blocked down', body1.worldBlocked.down, 'world blocked up', body1.worldBlocked.up);
    console.log('moving up?', (body1.deltaY() < 0), 'speed', body1.deltaY());
    console.log('immovable', body1.immovable);
    console.log('velocity', v1);

    console.log('');

    console.log('body2', body2.gameObject.name);
    console.log('blocked down', blocked2.down, 'blocked up', blocked2.up);
    console.log('touching down', body2.touching.down, 'touching up', body2.touching.up);
    console.log('world blocked down', body2.worldBlocked.down, 'world blocked up', body2.worldBlocked.up);
    console.log('moving up?', (body2.deltaY() < 0), 'speed', body2.deltaY());
    console.log('immovable', body2.immovable);
    console.log('velocity', v2);

    debugger;
    */

    var ny1 = v1;
    var ny2 = v2;

    if (!body1Immovable && !body2Immovable)
    {
        //  Neither body is immovable, so they get a new velocity based on mass
        var nv1 = Math.sqrt((v2 * v2 * body2.mass) / body1.mass) * ((v2 > 0) ? 1 : -1);
        var nv2 = Math.sqrt((v1 * v1 * body1.mass) / body2.mass) * ((v1 > 0) ? 1 : -1);
        var avg = (nv1 + nv2) * 0.5;

        nv1 -= avg;
        nv2 -= avg;

        ny1 = avg + nv1 * body1.bounce.y;
        ny2 = avg + nv2 * body2.bounce.y;
    }
    else if (body1Immovable)
    {
        //  Body1 is immovable, so carries on at the same speed regardless, adjust body2 speed
        ny2 = v1 - v2 * body2.bounce.y;
    }
    else if (body2Immovable)
    {
        //  Body2 is immovable, so carries on at the same speed regardless, adjust body1 speed
        ny1 = v2 - v1 * body1.bounce.y;
    }

    //  Velocities calculated, time to work out what moves where

    //  -------------------------------------------
    //  1) Bail out if nothing is blocking anything
    //  -------------------------------------------

    if (blocked1.none && blocked2.none)
    {
        overlap *= 0.5;

        if (body1.deltaY())
        {
            body1.y -= body1.getMoveY(overlap);
        }
        else
        {
            body1.y += body1.getMoveY(overlap);
        }

        if (body2.deltaY())
        {
            body2.y -= body2.getMoveY(overlap);
        }
        else
        {
            body2.y += body2.getMoveY(overlap);
        }

        velocity1.y = ny1;
        velocity2.y = ny2;

        return true;
    }

    //  -------------------------------------------
    //  2) Body1 motion checks
    //  -------------------------------------------

    if (body1.deltaY() < 0)
    {
        //  Body1 is moving UP

        if (blocked1.up)
        {
            //  And is blocked
            if (faceTop)
            {
                //  Body1 top hit Body2 bottom and is blocked from moving up
                body1.y = body2.bottom;
            }
            else
            {
                //  Body1 bottom hit Body2 top and is blocked from moving up
                body1.bottom = body2.y;
            }
        }
    }
    else if (body1.deltaY() > 0)
    {
        //  Body1 is moving DOWN

        if (blocked1.down)
        {
            //  And is blocked
            if (faceTop)
            {
                //  Body1 top hit Body2 bottom and is blocked from moving down
                body1.y = body2.bottom;
            }
            else
            {
                //  Body1 bottom hit Body2 top and is blocked from moving down
                body1.bottom = body2.y;
            }
        }
    }
    else
    {
        //  Body1 is static, don't apply any more velocity
        ny1 = 0;
    }

    if (body2.deltaY() < 0)
    {
        //  Body2 is moving UP

        if (blocked2.up)
        {
            //  And is blocked
            if (faceTop)
            {
                //  Body2 bottom hit Body1 top and is blocked from moving up
                body2.bottom = body1.y;
            }
            else
            {
                //  Body2 top hit Body1 bottom and is blocked from moving up
                body2.y = body1.bottom;
            }
        }
    }
    else if (body2.deltaY() > 0)
    {
        //  Body2 is moving DOWN

        if (blocked2.down)
        {
            //  And is blocked
            if (faceTop)
            {
                //  Body2 bottom hit Body1 top and is blocked from moving down
                body2.bottom = body1.y;
            }
            else
            {
                //  Body2 top hit Body1 bottom and is blocked from moving down
                body2.y = body1.bottom;
            }
        }
    }
    else
    {
        //  Body2 is static, don't apply any more velocity
        ny2 = 0;
    }

    /*
    if (!body1Immovable && !body2Immovable)
    {
        //  Neither body is immovable, so they get an equal amount of separation and a new velocity based on mass
        //  Share the overlap equally if both bodies are unblocked

        var nv1 = Math.sqrt((v2 * v2 * body2.mass) / body1.mass) * ((v2 > 0) ? 1 : -1);
        var nv2 = Math.sqrt((v1 * v1 * body1.mass) / body2.mass) * ((v1 > 0) ? 1 : -1);
        var avg = (nv1 + nv2) * 0.5;

        nv1 -= avg;
        nv2 -= avg;

        ny1 = avg + nv1 * body1.bounce.y;
        ny2 = avg + nv2 * body2.bounce.y;
    }
    else if (body1Immovable)
    {
        //  Body1 is immovable, so carries on at the same speed regardless, adjust body2 speed
        ny2 = v1 - v2 * body2.bounce.y;

        if (body1.deltaY() > 0)
        {
            //  Body1 is moving down

            if (faceTop)
            {
                //  and Body2 ran into its top
                body2.y -= body2.getMoveY(overlap);
            }
            else
            {
                //  and Body2 ran into its bottom
                body2.y += body2.getMoveY(overlap);
            }
        }
        else if (body1.deltaY() < 0)
        {
            //  Body1 is moving up

            if (faceTop)
            {
                //  and Body2 ran into its top
                body2.y -= body2.getMoveY(overlap);
            }
            else
            {
                //  and Body2 ran into its bottom
                body2.y += body2.getMoveY(overlap);
            }
        }
    }
    else if (body2Immovable)
    {
        //  Body2 is immovable, so carries on at the same speed regardless, adjust body1 speed
        ny1 = v2 - v1 * body1.bounce.y;

        console.log('b2i', ny1, body2.deltaY(), 'facetop', faceTop);

        if (body2.deltaY() > 0)
        {
            //  Body2 is moving down

            if (faceTop)
            {
                //  and Body1 ran into its top
                body1.bottom = body2.y;

                // body1.y -= body1.getMoveY(overlap);
            }
            else
            {
                //  and Body1 ran into its bottom

                body1.y = body2.bottom;

                // body1.y += body1.getMoveY(overlap);
            }
        }
        else if (body2.deltaY() < 0)
        {
            //  Body2 is moving up

            if (faceTop)
            {
                //  and Body1 ran into its top
                body1.y = body2.bottom;

                // body1.y -= body1.getMoveY(overlap);
            }
            else
            {
                //  and Body1 ran into its bottom, or it ran into Body1
                body1.bottom = body2.y - overlap;

                // body1.y += body1.getMoveY(overlap);
            }
        }
    }
    */

    /*
    if (faceBottom && blocked2.down)
    {
        if (blocked1.by === body2)
        {
            body1.bottom = body2.y;

            if (body1.bounce.y === 0)
            {
                ny1 = 0;
            }
        }
    }
    else if (faceTop && blocked1.down)
    {
        if (blocked2.by === body1)
        {
            body2.bottom = body1.y;

            if (body2.bounce.y === 0)
            {
                ny2 = 0;
            }
        }
    }
    else if (faceBottom && blocked1.up)
    {
        if (blocked2.by === body1)
        {
            body2.y = body1.bottom;

            if (body2.bounce.y === 0)
            {
                ny2 = 0;
            }
        }
    }
    else if (faceTop && blocked2.up)
    {
        if (blocked1.by === body2)
        {
            body1.y = body2.bottom;

            if (body1.bounce.y === 0)
            {
                ny1 = 0;
            }
        }
    }
    else
    {
        overlap *= 0.5;

        if (body1.deltaY())
        {
            body1.y -= body1.getMoveY(overlap);
        }
        else
        {
            body1.y += body1.getMoveY(overlap);
        }

        if (body2.deltaY())
        {
            body2.y -= body2.getMoveY(overlap);
        }
        else
        {
            body2.y += body2.getMoveY(overlap);
        }
    }
    */

    velocity1.y = ny1;
    velocity2.y = ny2;

    /*
    if (!body1Immovable && !body2Immovable)
    {
        //  Neither body is immovable, so they get an equal amount of separation and a new velocity based on mass
        //  Share the overlap equally if both bodies are unblocked

        var nv1 = Math.sqrt((v2 * v2 * body2.mass) / body1.mass) * ((v2 > 0) ? 1 : -1);
        var nv2 = Math.sqrt((v1 * v1 * body1.mass) / body2.mass) * ((v1 > 0) ? 1 : -1);
        var avg = (nv1 + nv2) * 0.5;

        nv1 -= avg;
        nv2 -= avg;

        var ny1 = avg + nv1 * body1.bounce.y;
        var ny2 = avg + nv2 * body2.bounce.y;

        if (faceBottom && blocked2.down)
        {
            if (blocked1.by === body2)
            {
                body1.bottom = body2.y;

                if (body1.bounce.y === 0)
                {
                    ny1 = 0;
                }
            }
        }
        else if (faceTop && blocked1.down)
        {
            if (blocked2.by === body1)
            {
                body2.bottom = body1.y;

                if (body2.bounce.y === 0)
                {
                    ny2 = 0;
                }
            }
        }
        else if (faceBottom && blocked1.up)
        {
            if (blocked2.by === body1)
            {
                body2.y = body1.bottom;

                if (body2.bounce.y === 0)
                {
                    ny2 = 0;
                }
            }
        }
        else if (faceTop && blocked2.up)
        {
            if (blocked1.by === body2)
            {
                body1.y = body2.bottom;

                if (body1.bounce.y === 0)
                {
                    ny1 = 0;
                }
            }
        }
        else
        {
            overlap *= 0.5;

            if (body1.deltaY())
            {
                body1.y -= body1.getMoveY(overlap);
            }
            else
            {
                body1.y += body1.getMoveY(overlap);
            }

            if (body2.deltaY())
            {
                body2.y -= body2.getMoveY(overlap);
            }
            else
            {
                body2.y += body2.getMoveY(overlap);
            }
        }

        velocity1.y = ny1;
        velocity2.y = ny2;
    }
    else if (body1Immovable)
    {
        //  Body1 is immovable, but Body2 can move, so it gets all the separation

        if (faceBottom)
        {
            if (blocked2.down)
            {
                body1.bottom = body2.y;
                velocity1.y = v2 - v1 * body1.bounce.y;
            }
            else
            {
                body2.y = body1.bottom;
                velocity2.y = v1 - v2 * body2.bounce.y;
            }
        }
        else if (faceTop)
        {
            if (blocked1.up)
            {
                body1.y = body2.bottom;
                velocity1.y = v2 - v1 * body1.bounce.y;
            }
            else
            {
                body2.bottom = body1.y;
                velocity2.y = v1 - v2 * body2.bounce.y;
            }
        }

        //  This is special case code that handles things like horizontal moving platforms you can ride
        if (body1.moves)
        {
            body2.x += body2.getMoveX((body1.deltaX()) * body1.friction.x, true);
        }
    }
    else if (body2Immovable)
    {
        //  Body2 is immovable, but Body1 can move, so it gets all the separation

        if (faceBottom)
        {
            //  Body1 was hit on the bottom by Body2 (which is immovable)
            if (blocked1.up)
            {
                //  But it can't go any further
                body2.y = body1.bottom;
            }
            else
            {
                //  Body1 has room to move, so pass on the velocity from Body2
                body1.y -= body1.getMoveY(overlap);
            }


            // if (blocked1.down)
            // {
            //     body2.bottom = body1.y;
            //     velocity2.y = v2 - v1 * body2.bounce.y;
            // }
            // else
            // {
            //     body1.y = body2.bottom;
            //     velocity1.y = v1 - v2 * body1.bounce.y;
            // }
        }
        else if (faceTop)
        {
            // if (blocked2.up)
            // {
            //     body1.y = body1.bottom;
            //     velocity2.y = v2 - v1 * body2.bounce.y;
            // }
            // else
            // {
            //     body1.bottom = body2.y;
            //     velocity1.y = v1 - v2 * body1.bounce.y;
            // }
        }

        //  This is special case code that handles things like horizontal moving platforms you can ride
        if (body2.moves)
        {
            body1.x += body1.getMoveX((body2.deltaX()) * body2.friction.x, true);
        }
    }
    */

    //  If we got this far then there WAS overlap, and separation is complete, so return true
    return true;
};

module.exports = SeparateY;