modeling/src/geometries/poly3/create.js

  2. /**
  3.  * Represents a convex 3D polygon. The vertices used to initialize a polygon must
  4.  * be coplanar and form a convex shape. The vertices do not have to be `vec3`
  5.  * instances but they must behave similarly.
  6.  * @typedef {Object} poly3
  7.  * @property {Array} vertices - list of ordered vertices (3D)
  8.  */
  10. /**
  11.  * Creates a new 3D polygon with initial values.
  12.  *
  13.  * @param {Array} [vertices] - a list of vertices (3D)
  14.  * @returns {poly3} a new polygon
  15.  * @alias module:modeling/geometries/poly3.create
  16.  */
  17. const create = (vertices) => {
  18.   if (vertices === undefined || vertices.length < 3) {
  19.     vertices = [] // empty contents
  20.   }
  21.   return { vertices }
  22. }
  24. module.exports = create