shaku/src/collision/result.js

A simple and effective JavaScript game development framework that knows its place!

/**
 * An object to store collision detection result.
 * 
 * |-- copyright and license --|
 * @module     Shaku
 * @file       shaku\src\collision\result.js
 * @author     Ronen Ness (ronenness@gmail.com | http://ronenness.com)
 * @copyright  (c) 2021 Ronen Ness
 * @license    MIT
 * |-- end copyright and license --|
 * 
 */

'use strict';
const Vector2 = require("../utils/vector2");
const CollisionShape = require("./shapes/shape");

 
/**
 * Collision detection result.
 */
class CollisionTestResult
{
    /**
     * Create the collision result.
     * @param {Vector2} position Optional collision position.
     * @param {CollisionShape} first First shape in the collision check.
     * @param {CollisionShape} second Second shape in the collision check.
     */
    constructor(position, first, second)
    {
        /**
         * Collision position, only relevant when there's a single touching point.
         * For shapes with multiple touching points, this will be null.
         * @name CollisionTestResult#position
         * @type {Vector2}
         */
        this.position = position;

        /**
         * First collided shape.
         * @name CollisionTestResult#first
         * @type {CollisionShape}
         */
        this.first = first;

        /**
         * Second collided shape.
         * @name CollisionTestResult#second
         * @type {CollisionShape}
         */
        this.second = second;
    }
}

// export collision shape class
module.exports = CollisionTestResult;