[page:LineSegments] →

[name]

Helper object to visualize a [page:Plane].

Example

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

Constructor

[name]([param:Plane plane], [param:Float size], [param:Color hex])

[page:Plane plane] -- the plane to visualize.
[page:Float size] -- (optional) side length of plane helper. Default is 1.
[page:Color color] -- (optional) the color of the helper. Default is 0xffff00.

Creates a new wireframe representation of the passed plane.

Properties

See the base [page:LineSegments] class for common properties.

[property:Plane plane]

The [page:Plane plane] being visualized.

[property:Float size]

The side lengths of plane helper.

Methods

See the base [page:LineSegments] class for common methods.

[method:void updateMatrixWorld]([param:Boolean force])

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

[sourceHint]