module:extras/meshes/createfloor

Back to documentation index.

### module:extras/meshes/createfloor()

The extras/meshes/createfloor.js module. To import all symbols in this module, either of the following can be used:

import * from "extras/meshes/createfloor.js";
// -- or --
import * as CustomModuleName from "extras/meshes/createfloor.js";

Methods

• createFloor
  Generates a mesh buffer of a tiled floor.

### (static) module:extras/meshes/createfloor.createFloor(three, xStart, yStart, width, height, tileSize, [z])

Generates a mesh buffer of a tiled floor. Texture coordinates of each tile will range from [0,1] across the width and height of that tile. Thus, any texture used to render the mesh buffer should entirely be of a square tile.

Parameters

• three (Type: *)
  Reference to THREE.js.
• xStart (Type: number)
  The x-coordinate of the start of the floor.
• yStart (Type: number)
  The y-coordinate of the start of the floor.
• width (Type: number)
  Total width of the floor.
• height (Type: number)
  Total height of the floor.
• tileSize (Type: number)
  Width and height of each floor tile.
• z (Type: number) (optional)
  The z-coordinate where the floor will be placed. If null, undefined, or omitted, the default is 0.

Return Value

A buffer geometry object. The resulting mesh buffer. (Type: *)

Back to documentation index.