Shapemetry API

---

Shapemetry API / Plane

Class: Plane

Defined in: core/Plane.ts:10

An infinite plane (origin + unit normal). signedDistance is positive on the normal side.

Constructors

Constructor

new Plane(normal, constant): Plane

Defined in: core/Plane.ts:14

Parameters

normal

Vector

constant

number

Returns

Plane

Properties

normal

normal: Vector

Defined in: core/Plane.ts:11

---

constant

constant: number

Defined in: core/Plane.ts:12

Methods

toJSON()

toJSON(): PlaneJSON

Defined in: core/Plane.ts:19

Returns

PlaneJSON

---

fromJSON()

static fromJSON(d): Plane

Defined in: core/Plane.ts:20

Parameters

d

PlaneJSON

Returns

Plane

---

xy()

static xy(): Plane

Defined in: core/Plane.ts:22

Returns

Plane

---

fromPointNormal()

static fromPointNormal(p, n): Plane

Defined in: core/Plane.ts:24

Parameters

p

x

number

y

number

z

number

n

Vector

Returns

Plane

---

origin()

origin(): Vector

Defined in: core/Plane.ts:28

Returns

Vector

---

coordinateFrame()

coordinateFrame(): object

Defined in: core/Plane.ts:40

Returns

object

toWorld

toWorld: Transformation

toLocal

toLocal: Transformation

---

equals()

equals(other, tol?): boolean

Defined in: core/Plane.ts:55

Parameters

other

Plane

tol?

number = POINT_COINCIDENCE

Returns

boolean

---

closestPoint()

closestPoint(p): Vector

Defined in: core/Plane.ts:71

Parameters

p

Vector

Returns

Vector

---

transform()

transform(tr): Plane

Defined in: core/Plane.ts:77

Parameters

tr

Transformation

Returns

Plane

---

translate()

translate(d): Plane

Defined in: core/Plane.ts:85

Parameters

d

Vector

Returns

Plane

---

rotate()

rotate(orig, axis, rad): Plane

Defined in: core/Plane.ts:89

Parameters

orig

Vector

axis

Vector

rad

number

Returns

Plane

---

flip()

flip(): Plane

Defined in: core/Plane.ts:96

Returns

Plane

---

mirrorPoint()

mirrorPoint(p): Vector

Defined in: core/Plane.ts:98

Parameters

p

Vector

Returns

Vector

---

mirror()

mirror(mirrorPlane): Plane

Defined in: core/Plane.ts:104

Parameters

mirrorPlane

Plane

Returns

Plane

---

intersectPlane()

intersectPlane(other): Line | undefined

Defined in: core/Plane.ts:110

Parameters

other

Plane

Returns

Line | undefined

---

intersectLine()

intersectLine(line): Point | undefined

Defined in: core/Plane.ts:125

Intersect with line. Returns intersection point or undefined if line is parallel to plane.

Parameters

line

Line

Returns

Point | undefined