Class Plane

Hierarchy

Plane

Index

Constructors

constructor

Properties

Methods

Constructors

constructor

new Plane(anchor: VectorOrList, v1: VectorOrList, v2: VectorOrList): Plane

- Defined in src/plane.ts:23
Parameters
- anchor: VectorOrList
- v1: VectorOrList
- Optional v2: VectorOrList
Returns Plane

Properties

anchor

anchor: Vector

normal

normal: Vector

Static XY

XY: Plane = new Plane(Vector.Zero(3), Vector.k)

Static XZ

XZ: Plane = new Plane(Vector.Zero(3), Vector.j)

Static YX

YX: Plane = new Plane(Vector.Zero(3), Vector.k)

Static YZ

YZ: Plane = new Plane(Vector.Zero(3), Vector.i)

Static ZX

ZX: Plane = new Plane(Vector.Zero(3), Vector.j)

Static ZY

ZY: Plane = new Plane(Vector.Zero(3), Vector.i)

Methods

contains

contains(obj: Geometry, epsilon?: number): boolean

- Defined in src/plane.ts:173
Parameters
- obj: Geometry
- Default value epsilon: number = Sylvester.precision
Returns boolean

distanceFrom

distanceFrom(obj: Geometry): number

- Defined in src/plane.ts:146
Parameters
- obj: Geometry
Returns number

eql

eql(plane: unknown, epsilon?: number): boolean

- Defined in src/plane.ts:81
Parameters
- plane: unknown
- Default value epsilon: number = Sylvester.precision
Returns boolean

intersectionWith

intersectionWith(obj: Line | Segment, epsilon: undefined | number): Vector | null
intersectionWith(obj: Plane, epsilon: undefined | number): Line | null

- Defined in src/plane.ts:216
Parameters
- obj: Line | Segment
- Optional epsilon: undefined | number
Returns Vector | null
- Defined in src/plane.ts:217
Parameters
- obj: Plane
- Optional epsilon: undefined | number
Returns Line | null

intersects

intersects(obj: Geometry, epsilon?: number): boolean

- Defined in src/plane.ts:198
Parameters
- obj: Geometry
- Default value epsilon: number = Sylvester.precision
Returns boolean

isParallelTo

isParallelTo(obj: Geometry, epsilon?: number): boolean

- Defined in src/plane.ts:109
Parameters
- obj: Geometry
- Default value epsilon: number = Sylvester.precision
Returns boolean

isPerpendicularTo

isPerpendicularTo(obj: Geometry, epsilon?: number): boolean

- Defined in src/plane.ts:128
Parameters
- obj: Geometry
- Default value epsilon: number = Sylvester.precision
Returns boolean

pointClosestTo

pointClosestTo(point: Line | Segment, epsilon: undefined | number): Vector | null
pointClosestTo(point: VectorOrList, epsilon: undefined | number): Vector

- Defined in src/plane.ts:291
Parameters
- point: Line | Segment
- Optional epsilon: undefined | number
Returns Vector | null
- Defined in src/plane.ts:292
Parameters
- point: VectorOrList
- Optional epsilon: undefined | number
Returns Vector

reflectionIn

reflectionIn(obj: Geometry): Plane

- Defined in src/plane.ts:346
Parameters
- obj: Geometry
Returns Plane

rotate

rotate(t: number | Matrix, line: Line): Plane

- Defined in src/plane.ts:314
Parameters
- t: number | Matrix
- line: Line
Returns Plane

toString

toString(): string

- Defined in src/plane.ts:387
Returns string

translate

translate(vector: VectorOrList): Plane

- Defined in src/plane.ts:91
Parameters
- vector: VectorOrList
Returns Plane

Static fromPoints

fromPoints(points: ReadonlyArray<VectorOrList>): Plane

- Defined in src/plane.ts:396
Parameters
- Rest points: ReadonlyArray<VectorOrList>
Returns Plane

Generated using TypeDoc