Geometry intersection and bounding volume helpers for PEX.
npm install pex-geom
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
Array.<Array.<number>>
An axis-aligned bounding box defined by two min and max 3D points (eg. [[minX, minY, minZ], [maxX, maxY, maxZ]]).
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]]).
Array.<Array.<number>>
A ray defined by a starting 3D point origin and a 3D direction vector (eg. [[originX, originY, originZ], [directionX, directionY, directionZ]).
Array.<Array.<number>>
A rectangle defined by two diagonally opposite 2D points (eg. [[minX, minY], [maxX, maxY]]).
Array.<Array.<number>>
A triangle defined by three 3D points.
aabb
rect
aabb
aabb
boolean
aabb
Array.<module:pex-math/types/types~vec3>
module:pex-math/types/types~vec3
module:pex-math/types/types~vec3
boolean
aabb
module:pex-math/types/types~vec3
string
aabb
Creates a new bounding box.
Kind: static method of aabb
rect
Reset a bounding box.
Kind: static method of aabb
Param | Type |
---|---|
a | aabb |
aabb
Copies a bounding box.
Kind: static method of aabb
Param | Type |
---|---|
a | aabb |
aabb
Sets a bounding box to another.
Kind: static method of aabb
Param | Type |
---|---|
a | aabb |
b | aabb |
boolean
Checks if a bounding box is empty.
Kind: static method of aabb
Param | Type |
---|---|
a | aabb |
aabb
Updates a bounding box from a list of points.
Kind: static method of aabb
Param | Type |
---|---|
a | aabb |
points | Array.<module:pex-math/types/types~vec3> | module:pex-math/types/types~TypedArray |
Array.<module:pex-math/types/types~vec3>
Returns a list of 8 points from a bounding box.
Kind: static method of aabb
Param | Type |
---|---|
a | aabb |
[points] | Array.<module:pex-math/types/types~vec3> |
module:pex-math/types/types~vec3
Returns the center of a bounding box.
Kind: static method of aabb
Param | Type |
---|---|
a | aabb |
out | module:pex-math/types/types~vec3 |
module:pex-math/types/types~vec3
Returns the size of a bounding box.
Kind: static method of aabb
Param | Type |
---|---|
a | aabb |
out | module:pex-math/types/types~vec3 |
boolean
Checks if a point is inside a bounding box.
Kind: static method of aabb
Param | Type |
---|---|
a | aabb |
p | module:pex-math/types/types~vec3 |
aabb
Includes a bounding box in another.
Kind: static method of aabb
Param | Type |
---|---|
a | aabb |
b | aabb |
module:pex-math/types/types~vec3
Includes a point in a bounding box.
Kind: static method of aabb
Param | Type | Default | Description |
---|---|---|---|
a | aabb |
||
p | module:pex-math/types/types~vec3 |
||
[i] | number |
0 |
offset in the point array |
string
Prints a bounding box to a string.
Kind: static method of aabb
Param | Type | Default |
---|---|---|
a | aabb |
|
[precision] | number |
4 |
Re-export aabb, plane, ray and rect
enum
plane
number
string
enum
Enum for different side values
Kind: static enum of plane
Read only: true
plane
Creates a new plane
Kind: static method of plane
number
Returns on which side a point is.
Kind: static method of plane
Param | Type |
---|---|
plane | plane |
point | module:pex-math/types/types~vec3 |
string
Prints a plane to a string.
Kind: static method of plane
Param | Type | Default |
---|---|---|
a | plane |
|
[precision] | number |
4 |
enum
ray
number
number
boolean
string
enum
Enum for different intersections values
Kind: static enum of ray
Read only: true
ray
Creates a new ray
Kind: static method of ray
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 | module:pex-math/types/types~vec3 |
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()](http://geomalgorithms.com/a06-_intersect-2.html#intersect3D_RayTriangle())
Param | Type |
---|---|
ray | ray |
triangle | triangle |
out | module:pex-math/types/types~vec3 |
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 |
Alias for hitTestAABB
Kind: static method of ray
string
Prints a plane to a string.
Kind: static method of ray
Param | Type | Default |
---|---|---|
a | ray |
|
[precision] | number |
4 |
rect
rect
rect
rect
boolean
rect
Array.<module:pex-math/types/types~vec2>
rect
rect
module:pex-math/types/types~vec2
number
number
number
rect
rect
boolean
boolean
rect
rect
module:pex-math/types/types~vec2
module:pex-math/types/types~vec2
string
rect
Creates a new rectangle.
Kind: static method of rect
rect
Reset a rectangle.
Kind: static method of rect
Param | Type |
---|---|
a | rect |
rect
Copies a rectangle.
Kind: static method of rect
Param | Type |
---|---|
a | rect |
rect
Sets a rectangle to another.
Kind: static method of rect
Param | Type |
---|---|
a | rect |
b | rect |
boolean
Checks if a rectangle is empty.
Kind: static method of rect
Param | Type |
---|---|
a | rect |
rect
Updates a rectangle from a list of points.
Kind: static method of rect
Param | Type |
---|---|
a | rect |
points | Array.<module:pex-math/types/types~vec2> | module:pex-math/types/types~TypedArray |
Array.<module:pex-math/types/types~vec2>
Returns a list of 4 points from a rectangle.
Kind: static method of rect
Param | Type |
---|---|
a | rect |
points | Array.<module:pex-math/types/types~vec2> |
rect
Scales a rectangle.
Kind: static method of rect
Param | Type |
---|---|
a | rect |
n | number |
rect
Sets the size of a rectangle using width and height.
Kind: static method of rect
Param | Type |
---|---|
a | rect |
size | module:pex-math/types/types~vec2 |
module:pex-math/types/types~vec2
Returns the size of a rectangle.
Kind: static method of rect
Param | Type |
---|---|
a | rect |
out | module:pex-math/types/types~vec2 |
number
Returns the width of a rectangle.
Kind: static method of rect
Param | Type |
---|---|
a | rect |
number
Returns the height of a rectangle.
Kind: static method of rect
Param | Type |
---|---|
a | rect |
number
Returns the aspect ratio of a rectangle.
Kind: static method of rect
Param | Type |
---|---|
a | rect |
rect
Sets the position of a rectangle.
Kind: static method of rect
Param | Type |
---|---|
a | rect |
p | module:pex-math/types/types~vec2 |
rect
Returns the center of a rectangle.
Kind: static method of rect
Param | Type |
---|---|
a | rect |
out | module:pex-math/types/types~vec2 |
boolean
Checks if a point is inside a rectangle.
Kind: static method of rect
Param | Type |
---|---|
a | rect |
p | module:pex-math/types/types~vec2 |
boolean
Checks if a rectangle is inside another rectangle.
Kind: static method of rect
Param | Type |
---|---|
a | rect |
b | rect |
rect
Includes a point in a rectangle.
Kind: static method of rect
Param | Type |
---|---|
a | rect |
p | module:pex-math/types/types~vec2 |
rect
Includes a rectangle in another rectangle.
Kind: static method of rect
Param | Type |
---|---|
a | rect |
b | rect |
module:pex-math/types/types~vec2
Maps a point into the dimensions of a rectangle.
Kind: static method of rect
Param | Type |
---|---|
a | rect |
p | module:pex-math/types/types~vec2 |
module:pex-math/types/types~vec2
Clamps a point into the dimensions of a rectangle.
Kind: static method of rect
Param | Type |
---|---|
a | rect |
p | module:pex-math/types/types~vec2 |
string
Prints a rect to a string.
Kind: static method of rect
Param | Type | Default |
---|---|---|
a | rect |
|
[precision] | number |
4 |
Array.<Array.<number>>
An axis-aligned bounding box defined by two min and max 3D points (eg. [[minX, minY, minZ], [maxX, maxY, maxZ]]).
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]]).
Array.<Array.<number>>
A ray defined by a starting 3D point origin and a 3D direction vector (eg. [[originX, originY, originZ], [directionX, directionY, directionZ]).
Array.<Array.<number>>
A rectangle defined by two diagonally opposite 2D points (eg. [[minX, minY], [maxX, maxY]]).
Array.<Array.<number>>
A triangle defined by three 3D points.
Kind: global typedef
MIT. See license file.