BoxGeometry is a geometry class for a rectangular cuboid with a given 'width', 'height', and 'depth'. On creation, the cuboid is centred on the origin, with each edge parallel to one of the axes.
const geometry = new v3d.BoxGeometry(1, 1, 1);
const material = new v3d.MeshBasicMaterial({color: 0x00ff00});
const cube = new v3d.Mesh(geometry, material);
scene.add(cube);
width — Width; that is, the length of the edges parallel to the X axis. Optional; defaults to 1.
height — Height; that is, the length of the edges parallel to the Y axis. Optional; defaults to 1.
depth — Depth; that is, the length of the edges parallel to the Z axis. Optional; defaults to 1.
widthSegments — Number of segmented rectangular faces along the width of the sides. Optional; defaults to 1.
heightSegments — Number of segmented rectangular faces along the height of the sides. Optional; defaults to 1.
depthSegments — Number of segmented rectangular faces along the depth of the sides. Optional; defaults to 1.
See the base Geometry class for common properties.
An object with a property for each of the constructor parameters. Any modification after instantiation does not change the geometry.
Using the above example:
geometry.parameters; // {width: 1, height: 1, depth: 1, widthSegments: undefined, heightSegments: undefined, depthSegments: undefined}
cube.geometry.parameters; // as above
cube.geometry.parameters.width; // === 1
cube.geometry.parameters.widthSegments; // === undefined.
See the base Geometry class for common methods.
For more info on how to obtain the source code of this module see this page.