@xeokit/xeokit-convert/types/geometryBuilders/buildGridGeometry.d.ts

JavaScript utilities to create .XKT files

/**
 * @desc Creates grid-shaped geometry arrays..
 *
 * ## Usage
 *
 * In the example below we'll create an {@link XKTModel}, then create an {@link XKTMesh} with a grid-shaped {@link XKTGeometry}.
 *
 * [[Run this example](http://xeokit.github.io/xeokit-sdk/examples/#geometry_builders_buildGridGeometry)]
 *
 * ````javascript
 * const xktModel = new XKTModel();
 *
 * const grid = buildGridGeometry({
 *      size: 1000,
 *      divisions: 500
 * });
 *
 * const xktGeometry = xktModel.createGeometry({
 *      geometryId: "gridGeometry",
 *      primitiveType: grid.primitiveType, // Will be "lines"
 *      positions: grid.positions,
 *      indices: grid.indices
 * });
 *
 * const xktMesh = xktModel.createMesh({
 *      meshId: "redGridMesh",
 *      geometryId: "gridGeometry",
 *      position: [-4, -6, -4],
 *      scale: [1, 3, 1],
 *      rotation: [0, 0, 0],
 *      color: [1, 0, 0],
 *      opacity: 1
 * });
 *
 * const xktEntity = xktModel.createEntity({
 *      entityId: "redGrid",
 *      meshIds: ["redGridMesh"]
 * });
 *
 * xktModel.finalize();
 * ````
 *
 * @function buildGridGeometry
 * @param {*} [cfg] Configs
 * @param {Number} [cfg.size=1] Dimension on the X and Z-axis.
 * @param {Number} [cfg.divisions=1] Number of divisions on X and Z axis..
 * @returns {Object} Geometry arrays for {@link XKTModel#createGeometry} or {@link XKTModel#createMesh}.
 */
export function buildGridGeometry(cfg?: any): Object;