modeling/src/geometries/poly2/create.js

  1. /**
  2.  * Represents a convex 2D polygon consisting of a list of ordered vertices.
  3.  * @typedef {Object} poly2
  4.  * @property {Array} vertices - list of ordered vertices (2D)
  5.  */
  7. /**
  8.  * Creates a new polygon with initial values.
  9.  *
  10.  * @param {Array} [vertices] - list of vertices (2D)
  11.  * @returns {poly2} a new polygon
  12.  * @alias module:modeling/geometries/poly2.create
  13.  *
  14.  * @example
  15.  * let polygon = create()
  16.  */
  17. const create = (vertices) => {
  18.   if (vertices === undefined || vertices.length < 3) {
  19.     vertices = [] // empty contents
  20.   }
  21.   return { vertices: vertices }
  22. }
  24. module.exports = create