pex-geom

Geometry intersection and bounding volume helpers for PEX.

Installation

npm install pex-geom

Usage

import { ray, aabb } from "pex-geom";

const box = aabb.fromPoints([
  [-1, -1, -1],
  [1, 1, 1],
]);

const intersect = ray.hitTestAABB(
  [
    [0, 0, 0],
    [0, 1, 0],
  ],
  box
);
console.log(intersect);
// => true

API

Modules

pex-geom
aabb
plane
ray
rect

Typedefs

aabb : Array.<Array.<number>>: An axis-aligned bounding box defined by two min and max 3D points (eg. [[minX, minY, minZ], [maxX, maxY, maxZ]]).
plane : Array.<Array.<number>>: A plane defined by a 3D point and a normal vector perpendicular to the plane’s surface (eg. [[pointX, pointY, pointZ], [normalX, normalY, normalZ]]).
ray : Array.<Array.<number>>: A ray defined by a starting 3D point origin and a 3D direction vector (eg. [[originX, originY, originZ], [directionX, directionY, directionZ]).
rect : Array.<Array.<number>>: A rectangle defined by two diagonally opposite 2D points (eg. [[minX, minY], [maxX, maxY]]).
triangle : Array.<Array.<number>>: A triangle defined by three 3D points.
vec2 : module:pex-math~vec2
vec3 : module:pex-math~vec3
TypedArray : module:pex-math~TypedArray

pex-geom

pex-geom
- .aabb : aabb
- .plane : plane
- .ray : ray
- .rect : rect

pex-geom.aabb : `aabb`

Kind: static property of pex-geom

pex-geom.plane : `plane`

Kind: static property of pex-geom

pex-geom.ray : `ray`

Kind: static property of pex-geom

pex-geom.rect : `rect`

Kind: static property of pex-geom

aabb

aabb
- .create() ⇒ aabb
- .empty(a) ⇒ rect
- .copy(a) ⇒ aabb
- .set(a, b) ⇒ aabb
- .isEmpty(a) ⇒ boolean
- .fromPoints(a, points) ⇒ aabb
- .getCorners(a, [points]) ⇒ Array.<vec3>
- .center(a, out) ⇒ vec3
- .size(a, out) ⇒ vec3
- .containsPoint(a, p) ⇒ boolean
- .includeAABB(a, b) ⇒ aabb
- .includePoint(a, p, [i]) ⇒ vec3
- .toString(a, [precision]) ⇒ string

aabb.create() ⇒ `aabb`

Creates a new bounding box.

Kind: static method of aabb

aabb.empty(a) ⇒ `rect`

Reset a bounding box.

Kind: static method of aabb

Param	Type
a	`aabb`

aabb.copy(a) ⇒ `aabb`

Copies a bounding box.

Kind: static method of aabb

Param	Type
a	`aabb`

aabb.set(a, b) ⇒ `aabb`

Sets a bounding box to another.

Kind: static method of aabb

Param	Type
a	`aabb`
b	`aabb`

aabb.isEmpty(a) ⇒ `boolean`

Checks if a bounding box is empty.

Kind: static method of aabb

Param	Type
a	`aabb`

aabb.fromPoints(a, points) ⇒ `aabb`

Updates a bounding box from a list of points.

Kind: static method of aabb

Param	Type
a	`aabb`
points	`Array.<vec3>` \| `TypedArray`

aabb.getCorners(a, [points]) ⇒ `Array.<vec3>`

Returns a list of 8 points from a bounding box.

Kind: static method of aabb

Param	Type
a	`aabb`
[points]	`Array.<vec3>`

aabb.center(a, out) ⇒ `vec3`

Returns the center of a bounding box.

Kind: static method of aabb

Param	Type
a	`aabb`
out	`vec3`

aabb.size(a, out) ⇒ `vec3`

Returns the size of a bounding box.

Kind: static method of aabb

Param	Type
a	`aabb`
out	`vec3`

aabb.containsPoint(a, p) ⇒ `boolean`

Checks if a point is inside a bounding box.

Kind: static method of aabb

Param	Type
a	`aabb`
p	`vec3`

aabb.includeAABB(a, b) ⇒ `aabb`

Includes a bounding box in another.

Kind: static method of aabb

Param	Type
a	`aabb`
b	`aabb`

aabb.includePoint(a, p, [i]) ⇒ `vec3`

Includes a point in a bounding box.

Kind: static method of aabb

Param	Type	Default	Description
a	`aabb`
p	`vec3`
[i]	`number`	`0`	offset in the point array

aabb.toString(a, [precision]) ⇒ `string`

Prints a bounding box to a string.

Kind: static method of aabb

Param	Type	Default
a	`aabb`
[precision]	`number`	`4`

plane

plane
- .Side : enum
- .create() ⇒ plane
- .side(plane, point) ⇒ number
- .toString(a, [precision]) ⇒ string

plane.Side : `enum`

Enum for different side values

Kind: static enum of plane Read only: true

plane.create() ⇒ `plane`

Creates a new plane

Kind: static method of plane

plane.side(plane, point) ⇒ `number`

Returns on which side a point is.

Kind: static method of plane

Param	Type
plane	`plane`
point	`vec3`

plane.toString(a, [precision]) ⇒ `string`

Prints a plane to a string.

Kind: static method of plane

Param	Type	Default
a	`plane`
[precision]	`number`	`4`

ray

ray
- .Intersections : enum
- .create() ⇒ ray
- .hitTestPlane(ray, plane, out) ⇒ number
- .hitTestTriangle(ray, triangle, out) ⇒ number
- .hitTestAABB(ray, aabb) ⇒ boolean
- .intersectsAABB()
- .toString(a, [precision]) ⇒ string

ray.Intersections : `enum`

Enum for different intersections values

Kind: static enum of ray Read only: true

ray.create() ⇒ `ray`

Creates a new ray

Kind: static method of ray

ray.hitTestPlane(ray, plane, out) ⇒ `number`

Determines if a ray intersect a plane and set intersection point

Kind: static method of ray See: https://www.cs.princeton.edu/courses/archive/fall00/cs426/lectures/raycast/sld017.htm

Param	Type
ray	`ray`
plane	`plane`
out	`vec3`

ray.hitTestTriangle(ray, triangle, out) ⇒ `number`

Determines if a ray intersect a triangle and set intersection point

Kind: static method of ray See: http://geomalgorithms.com/a06-_intersect-2.html#intersect3D_RayTriangle()

Param	Type
ray	`ray`
triangle	`triangle`
out	`vec3`

ray.hitTestAABB(ray, aabb) ⇒ `boolean`

Determines if a ray intersect an AABB bounding box

Kind: static method of ray See: http://gamedev.stackexchange.com/questions/18436/most-efficient-aabb-vs-ray-collision-algorithms

Param	Type
ray	`ray`
aabb	`aabb`

ray.intersectsAABB()

Alias for hitTestAABB

Kind: static method of ray

ray.toString(a, [precision]) ⇒ `string`

Prints a plane to a string.

Kind: static method of ray

Param	Type	Default
a	`ray`
[precision]	`number`	`4`