Rectangle.js

/* eslint-disable camelcase */
/*
* Copyright (c) 2022, SmartDeviceLink Consortium, Inc.
* All rights reserved.
*
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions are met:
*
* Redistributions of source code must retain the above copyright notice, this
* list of conditions and the following disclaimer.
*
* Redistributions in binary form must reproduce the above copyright notice,
* this list of conditions and the following
* disclaimer in the documentation and/or other materials provided with the
* distribution.
*
* Neither the name of the SmartDeviceLink Consortium Inc. nor the names of
* its contributors may be used to endorse or promote products derived
* from this software without specific prior written permission.
*
* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
* AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
* IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
* ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE
* LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
* CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
* SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
* INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
* CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
* ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
* POSSIBILITY OF SUCH DAMAGE.
*/

import { RpcStruct } from '../RpcStruct.js';

class Rectangle extends RpcStruct {
    /**
     * Initializes an instance of Rectangle.
     * @class
     * @param {object} parameters - An object map of parameters.
     * @since SmartDeviceLink 4.5.0
     */
    constructor (parameters) {
        super(parameters);
    }

    /**
     * Set the X
     * @param {Number} x - The upper left X-coordinate of the rectangle - The desired X.
     * @returns {Rectangle} - The class instance for method chaining.
     */
    setX (x) {
        this.setParameter(Rectangle.KEY_X, x);
        return this;
    }

    /**
     * Get the X
     * @returns {Number} - the KEY_X value
     */
    getX () {
        return this.getParameter(Rectangle.KEY_X);
    }

    /**
     * Set the Y
     * @param {Number} y - The upper left Y-coordinate of the rectangle - The desired Y.
     * @returns {Rectangle} - The class instance for method chaining.
     */
    setY (y) {
        this.setParameter(Rectangle.KEY_Y, y);
        return this;
    }

    /**
     * Get the Y
     * @returns {Number} - the KEY_Y value
     */
    getY () {
        return this.getParameter(Rectangle.KEY_Y);
    }

    /**
     * Set the Width
     * @param {Number} width - The width of the rectangle - The desired Width.
     * @returns {Rectangle} - The class instance for method chaining.
     */
    setWidth (width) {
        this.setParameter(Rectangle.KEY_WIDTH, width);
        return this;
    }

    /**
     * Get the Width
     * @returns {Number} - the KEY_WIDTH value
     */
    getWidth () {
        return this.getParameter(Rectangle.KEY_WIDTH);
    }

    /**
     * Set the Height
     * @param {Number} height - The height of the rectangle - The desired Height.
     * @returns {Rectangle} - The class instance for method chaining.
     */
    setHeight (height) {
        this.setParameter(Rectangle.KEY_HEIGHT, height);
        return this;
    }

    /**
     * Get the Height
     * @returns {Number} - the KEY_HEIGHT value
     */
    getHeight () {
        return this.getParameter(Rectangle.KEY_HEIGHT);
    }
}

Rectangle.KEY_X = 'x';
Rectangle.KEY_Y = 'y';
Rectangle.KEY_WIDTH = 'width';
Rectangle.KEY_HEIGHT = 'height';

export { Rectangle };