Chapter 326: PlaneHelper

Core Idea

A helper object to visualize an instance of Plane.

Key Concepts

• plane : Plane: The plane being visualized.
• size : number: The side length of plane helper.

Code Examples

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

• What it demonstrates: Typical usage of PlaneHelper.

Reference Tables

Constructor

Signature
`new PlaneHelper( plane : Plane, size : number, hex : number

Properties

Property	Description
.plane : Plane	The plane being visualized.
.size : number	The side length of plane helper.

Methods

Method	Description
.dispose()	Updates the helper to match the position and direction of the light being visualized.

Key Takeaways

1. PlaneHelper extends: EventDispatcher → Object3D → Line
2. Most relevant properties: plane, size.
3. Key methods: dispose.

Connects To

• EventDispatcher: parent class
• Object3D: parent class
• Line: parent class
• Source: src/helpers/PlaneHelper.js