primitives-2d_square.js

import {Rectangle} from "./index";
import {Plane, Vector} from "../math";

/**
 * Creates a square based on the specified parameters.
 * @memberof primitives-2D
 * @alias Square
 * @param {Object} parameters - The parameters for the square.
 * @param {Plane} [parameters.plane=Plane.XY] - The plane in which the square is constructed.
 * @param {Vector} [parameters.center=Vector.ZERO] - The center of the square.
 * @param {number} parameters.size - The length of the square's sides.
 * @returns {Face} A `Face` object representing the constructed square.
 */
const Square = ({plane = Plane.XY, center = Vector.ZERO, size}) => {
  return Rectangle({plane: plane, center: center, width: size, height: size});
};

export {Square};