Skip to main content

Object3D → Line → LineSegments →

PlaneHelper

Helper object to visualize a Plane.

Code Example​

const plane = new THREE.Plane( new THREE.Vector3( 1, 1, 0.2 ), 3 ); const
helper = new THREE.PlaneHelper( plane, 1, 0xffff00 ); scene.add( helper );

Constructor​

PlaneHelper​

function PlaneHelper( plane: Plane, size: Float, hex: Color ): void;

plane -- the plane to visualize.
size -- (optional) side length of plane helper. Default is 1.
color -- (optional) the color of the helper. Default is 0xffff00.

Creates a new wireframe representation of the passed plane.

Properties​

See the base Line class for common properties.

plane​

plane: Plane;

The plane being visualized.

size​

size: Float;

The side lengths of plane helper.

Methods​

See the base LineSegments class for common methods.

updateMatrixWorld​

function updateMatrixWorld( force: Boolean ): undefined;

This overrides the method in the base Object3D class so that it also updates the helper object according to the .plane and .size properties.

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/PlaneHelper.js