Plane

class common.Plane()

Object representing a Plane.

Index

Constructors

• constructor

Properties

• d
• normal

Methods

• createFromCoefficients
• createFromPointAndNormal
• createFromPoints
• assign
• copy
• determineSide
• distanceToPoint
• equals
• getCoefficients
• intersectsRay
• rayIntersection
• setFromCoefficients
• setFromPointAndNormal
• setFromPoints

Constructors

common.Plane.constructor()

Plane(): Plane

Returns: Plane

Properties

common.Plane.d

d: number

common.Plane.normal

normal: Point3

Methods

static common.Plane.createFromCoefficients()

static

createFromCoefficients(a: number, b: number, c: number, d: number): Plane

Parameters

a: number

b: number

c: number

d: number

Returns: Plane

static common.Plane.createFromPointAndNormal()

static

createFromPointAndNormal(point: Point3, normal: Point3): Plane

Parameters

point: Point3

normal: Point3

Returns: Plane

static common.Plane.createFromPoints()

static

createFromPoints(p1: Point3, p2: Point3, p3: Point3): Plane

Parameters

p1: Point3

p2: Point3

p3: Point3

Returns: Plane

common.Plane.assign()

assign(plane: Plane): void

Sets this plane equal to another plane

Parameters

plane: Plane

the plane to assign

Returns: void

common.Plane.copy()

copy(): Plane

Creates a copy of this plane

Returns: Plane

a copy of this plane object

common.Plane.determineSide()

determineSide(p: Point3): boolean

Returns true if the point is on the side of the plane that the plane’s normal is directed. Returns false otherwise.

Parameters

p: Point3

The point to test.

Returns: boolean

common.Plane.distanceToPoint()

distanceToPoint(point: Point3): number

Parameters

point: Point3

Returns: number

common.Plane.equals()

equals(plane: Plane): boolean

Returns true if the normal and d value are the same.

Parameters

plane: Plane

Returns: boolean

common.Plane.getCoefficients()

getCoefficients(): [number, number, number, number]

Returns: [number, number, number, number]

common.Plane.intersectsRay()

intersectsRay(ray: Ray, outPoint: Point3): boolean

Parameters

ray: Ray

outPoint: Point3

Returns: boolean

common.Plane.rayIntersection()

rayIntersection(ray: Ray): (None | Point3)

Parameters

ray: Ray

Returns: (None | Point3)

common.Plane.setFromCoefficients()

setFromCoefficients(a: number, b: number, c: number, d: number): void

Parameters

a: number

b: number

c: number

d: number

Returns: void

common.Plane.setFromPointAndNormal()

setFromPointAndNormal(point: Point3, normal: Point3): this

Parameters

point: Point3

normal: Point3

Returns: this

common.Plane.setFromPoints()

setFromPoints(p1: Point3, p2: Point3, p3: Point3): void

Update the plane to pass through the three points

Parameters

p1: Point3

p2: Point3

p3: Point3

Returns: void