be.yildizgames.module.coordinates.BaseCoordinate Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of module-window Show documentation
Window module to wrap graphic engine and handle inputs.
The newest version!
/*
 * This file is part of the Yildiz-Engine project, licenced under the MIT License  (MIT)
 *
 *  Copyright (c) 2019 Grégory Van den Borre
 *
 *  More infos available: https://engine.yildiz-games.be
 *
 *  Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated
 *  documentation files (the "Software"), to deal in the Software without restriction, including without
 *  limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies
 *  of the Software, and to permit persons to whom the Software is furnished to do so,
 *  subject to the following conditions:
 *
 *  The above copyright notice and this permission notice shall be included in all copies or substantial
 *  portions of the Software.
 *
 *  THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE
 *  WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS
 *  OR COPYRIGHT  HOLDERS BE LIABLE FOR ANY CLAIM,
 *  DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 *  OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE  SOFTWARE.
 *
 */

package be.yildizgames.module.coordinates;

/**
 * Base class for coordinates, only to be subclassed.
 *
 * @author Grégory Van den Borre
 */
class BaseCoordinate implements Coordinates {

    /**
     * Width value.
     */
    private final int width;

    /**
     * Height value.
     */
    private final int height;

    /**
     * X position value.
     */
    private final int left;

    /**
     * Y position value.
     */
    private final int top;

    /**
     * Full constructor.
     *
     * @param widthValue  Width coordinate, must be positive.
     * @param heightValue Height coordinate, must be positive.
     * @param leftValue   Left coordinate.
     * @param topValue    Top coordinate.
     */
    protected BaseCoordinate(final int widthValue, final int heightValue, final int leftValue, final int topValue) {
        super();
        if(widthValue < 0) {
            throw new IllegalArgumentException("Width must be positive");
        }
        if(heightValue < 0) {
            throw new IllegalArgumentException("Height must be positive");
        }
        this.width = widthValue;
        this.height = heightValue;
        this.left = leftValue;
        this.top = topValue;
    }

    /**
     * Check if a coordinate is contained in another one.
     *
     * @param toCheck Point to check.
     * @return true if the given coordinate is contained
     */
    public final boolean contains(final BaseCoordinate toCheck) {
        return toCheck.left >= this.left && toCheck.left + toCheck.width <= this.left + this.width && toCheck.top >= this.top
                && toCheck.top + toCheck.height <= this.top + this.height;
    }

    @Override
    public boolean equals(Object o) {
        if (this == o) {
            return true;
        }
        if (!(o instanceof BaseCoordinate)) {
            return false;
        }

        BaseCoordinate that = (BaseCoordinate) o;

        if (width != that.width) {
            return false;
        }
        if (height != that.height) {
            return false;
        }
        if (left != that.left) {
            return false;
        }
        return top == that.top;
    }

    @Override
    public int hashCode() {
        int result = width;
        result = 31 * result + height;
        result = 31 * result + left;
        result = 31 * result + top;
        return result;
    }

    /**
     * @return The coordinates values.
     */
    @Override
    public final String toString() {
        return "Width:" + this.width + ", height:" + this.height + ", left:" + this.left + ", top:" + this.top;
    }

    @Override
    public final int getWidth() {
        return this.width;
    }

    @Override
    public final int getHeight() {
        return this.height;
    }

    @Override
    public final int getLeft() {
        return this.left;
    }

    @Override
    public final int getTop() {
        return this.top;
    }
}