import {Plane} from 'math-ds'

public class | source

Plane

A plane.

Constructor Summary

Public Constructor
public	constructor(normal: Vector3, constant: Number) Constructs a new plane.

Member Summary

Public Members
public	constant: Number The constant.
public	normal: Vector3 The normal.

Method Summary

Public Methods
public	clone(): Plane Clones this plane.
public	coplanarPoint(target: Vector3): Vector3 Calculates a coplanar point and returns it.
public	copy(p: Plane): Plane Copies the given plane.
public	distanceToPoint(p: Vector3): Number Calculates the distance from this plane to the given point.
public	distanceToSphere(s: Sphere): Number Calculates the distance from this plane to the given sphere.
public	equals(p: Plane): Boolean Checks if this plane equals the given one.
public	intersectLine(l: Line3, target: Vector3): Vector3 Finds the point of intersection between this plane and a given line.
public	intersectsBox(b: Box3): Boolean Checks if this plane intersects with the given box.
public	intersectsLine(l: Line3): Boolean Checks if this plane intersects with the given line.
public	intersectsSphere(s: Sphere): Boolean Checks if this plane intersects with the given sphere.
public	negate(): Plane Negates this plane.
public	normalize(): Plane Normalizes this plane.
public	projectPoint(p: Vector3, target: Vector3): Vector3 Projects the given point on this plane.
public	set(normal: Vector3, constant: Number): Plane Sets the normal and the constant.
public	setComponents(x: Number, y: Number, z: Number, w: Number): Plane Sets the components of this plane.
public	setFromCoplanarPoints(p0: Vector3, p1: Vector3, p2: Vector3): Plane Sets this plane from three distinct coplanar points.
public	setFromNormalAndCoplanarPoint(n: Vector3, p: Vector3): Sphere Sets this plane from a normal and a coplanar point.
public	translate(offset: Vector3): Plane Translates this plane.

Public Constructors

public constructor(normal: Vector3, constant: Number) source

Constructs a new plane.

Params:

Name	Type	Attribute	Description
normal	Vector3	optional	The normal.
constant	Number	optional	The constant.

Public Members

public constant: Number source

The constant.

public normal: Vector3 source

The normal.

Public Methods

public clone(): Plane source

Clones this plane.

Return:

Plane

The cloned plane.

public coplanarPoint(target: Vector3): Vector3 source

Calculates a coplanar point and returns it.

Params:

Name	Type	Attribute	Description
target	Vector3	optional	A target vector. If none is provided, a new one will be created.

Return:

Vector3

A coplanar plane.

public copy(p: Plane): Plane source

Copies the given plane.

Params:

Name	Type	Attribute	Description
p	Plane		A plane.

Return:

Plane

This plane.

public distanceToPoint(p: Vector3): Number source

Calculates the distance from this plane to the given point.

Params:

Name	Type	Attribute	Description
p	Vector3		A point.

Return:

Number

The length.

public distanceToSphere(s: Sphere): Number source

Calculates the distance from this plane to the given sphere.

Params:

Name	Type	Attribute	Description
s	Sphere		A sphere.

Return:

Number

The length.

public equals(p: Plane): Boolean source

Checks if this plane equals the given one.

Params:

Name	Type	Attribute	Description
p	Plane		A plane.

Return:

Boolean

Whether this plane equals the given one.

public intersectLine(l: Line3, target: Vector3): Vector3 source

Finds the point of intersection between this plane and a given line.

Params:

Name	Type	Attribute	Description
l	Line3		A line.
target	Vector3	optional	A target vector. If none is provided, a new one will be created.

Return:

Vector3

The intersection point.

public intersectsBox(b: Box3): Boolean source

Checks if this plane intersects with the given box.

Params:

Name	Type	Attribute	Description
b	Box3		A box.

Return:

Boolean

Whether this plane intersects with the given box.

public intersectsLine(l: Line3): Boolean source

Checks if this plane intersects with the given line.

Params:

Name	Type	Attribute	Description
l	Line3		A line.

Return:

Boolean

Whether this plane intersects with the given line.

public intersectsSphere(s: Sphere): Boolean source

Checks if this plane intersects with the given sphere.

Params:

Name	Type	Attribute	Description
s	Sphere		A sphere.

Return:

Boolean

Whether this plane intersects with the given sphere.

public negate(): Plane source

Negates this plane.

Return:

Plane

This plane.

public normalize(): Plane source

Normalizes this plane.

Return:

Plane

This plane.

public projectPoint(p: Vector3, target: Vector3): Vector3 source

Projects the given point on this plane.

Params:

Name	Type	Attribute	Description
p	Vector3		A point.
target	Vector3	optional	A target vector. If none is provided, a new one will be created.

Return:

Vector3

The projected point.

public set(normal: Vector3, constant: Number): Plane source

Sets the normal and the constant.

Params:

Name	Type	Attribute	Description
normal	Vector3		The normal.
constant	Number		The constant.

Return:

Plane

This plane.

public setComponents(x: Number, y: Number, z: Number, w: Number): Plane source

Sets the components of this plane.

Params:

Name	Type	Attribute	Description
x	Number		The X component of the normal.
y	Number		The Y component of the normal.
z	Number		The Z component of the normal.
w	Number		The constant.

Return:

Plane

This plane.

public setFromCoplanarPoints(p0: Vector3, p1: Vector3, p2: Vector3): Plane source

Sets this plane from three distinct coplanar points.

Params:

Name	Type	Attribute	Description
p0	Vector3		A coplanar point.
p1	Vector3		A coplanar point.
p2	Vector3		A coplanar point.

Return:

Plane

This plane.

public setFromNormalAndCoplanarPoint(n: Vector3, p: Vector3): Sphere source

Sets this plane from a normal and a coplanar point.

Params:

Name	Type	Attribute	Description
n	Vector3		The normal.
p	Vector3		The coplanar point.

Return:

Sphere

This sphere.

public translate(offset: Vector3): Plane source

Translates this plane.

Params:

Name	Type	Attribute	Description
offset	Vector3		An offset.

Return:

Plane

This plane.