Skip to main content

Object3DLine

GridHelper

The GridHelper is an object to define grids. Grids are two-dimensional arrays of lines.

Code Example

const size = 10; const divisions = 10; const gridHelper = new
THREE.GridHelper( size, divisions ); scene.add( gridHelper );

Examples

[example:webgl_helpers WebGL / helpers]

Constructor

GridHelper

function GridHelper( size: number, divisions: Number, colorCenterLine: Color,
colorGrid: Color ): void;

size -- The size of the grid. Default is 10.
divisions -- The number of divisions across the grid. Default is 10.
colorCenterLine -- The color of the centerline. This can be a Color, a hexadecimal value and an CSS-Color name. Default is 0x444444
colorGrid -- The color of the lines of the grid. This can be a Color, a hexadecimal value and an CSS-Color name. Default is 0x888888

Creates a new GridHelper of size 'size' and divided into 'divisions' segments per side. Colors are optional.

Methods

See the base LineSegments class for common methods.

dispose

function dispose( ): undefined;  

Frees the GPU-related resources allocated by this instance. Call this method whenever this instance is no longer used in your app.

Source

src/helpers/GridHelper.js