PlaneHelper

Helper object to visualize a Plane.

Code Example


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

Constructor

PlaneHelper(plane : Plane, size : Float, hex : Color | Integer | String)

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

The plane being visualized.

# .size : Float

The side lengths of plane helper.

Methods

See the base LineSegments class for common methods.

# .updateMatrixWorld(force : Boolean)

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()

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

Source

For more info on how to obtain the source code of this module see this page.