Members

center :Vector3

math/OBB.js, line 58

The center of this OBB.

halfSizes :Vector3

math/OBB.js, line 64

The half sizes of the OBB (defines its width, height and depth).

rotation :Matrix3

math/OBB.js, line 70

The rotation of this OBB.

Methods

clampPoint(point, result) → {Vector3}

math/OBB.js, line 142

Ensures the given point is inside this OBB and stores the result in the given vector.

Reference: Closest Point on OBB to Point in Real-Time Collision Detection by Christer Ericson (chapter 5.1.4)

Parameters:

Name	Type	Description
point	Vector3	A point in 3D space.
result	Vector3	The result vector.

Returns:

Vector3 -

The result vector.

clone() → {OBB}

math/OBB.js, line 113

Creates a new OBB and copies all values from this OBB.

Returns:

OBB -

A new OBB.

containsPoint(point) → {Boolean}

math/OBB.js, line 174

Returns true if the given point is inside this OBB.

Parameters:

Name	Type	Description
point	Vector3	A point in 3D space.

Returns:

Boolean -

Whether the given point is inside this OBB or not.

copy(obb) → {OBB}

math/OBB.js, line 98

Copies all values from the given OBB to this OBB.

Parameters:

Name	Type	Description
obb	OBB	The OBB to copy.

Returns:

OBB -

A reference to this OBB.

equals(obb) → {Boolean}

math/OBB.js, line 605

Returns true if the given OBB is deep equal with this OBB.

Parameters:

Name	Type	Description
obb	OBB	The OBB to test.

Returns:

Boolean -

The result of the equality test.

fromAABB(aabb) → {OBB}

math/OBB.js, line 397

Computes the OBB from an AABB.

Parameters:

Name	Type	Description
aabb	AABB	The AABB.

Returns:

OBB -

A reference to this OBB.

fromJSON(json) → {OBB}

math/OBB.js, line 635

Restores this instance from the given JSON object.

Parameters:

Name	Type	Description
json	Object	The JSON object.

Returns:

OBB -

A reference to this OBB.

fromPoints(points) → {OBB}

math/OBB.js, line 425

Computes the minimum enclosing OBB for the given set of points. The method is an implementation of Collision Queries using Oriented Bounding Boxes by Stefan Gottschalk. According to the dissertation, the quality of the fitting process varies from the respective input. This method uses the best approach by computing the covariance matrix based on the triangles of the convex hull (chapter 3.4.3).

However, the implementation is susceptible to regular polygons like cubes or spheres. For such shapes, it's recommended to verify the quality of the produced OBB. Consider to use an AABB or bounding sphere if the result is not satisfying.

Parameters:

Name	Type	Description
points	Array.<Vector3>	An array of 3D vectors representing points in 3D space.

Returns:

OBB -

A reference to this OBB.

getSize(result) → {Vector3}

math/OBB.js, line 125

Computes the size (width, height, depth) of this OBB and stores it into the given vector.

Parameters:

Name	Type	Description
result	Vector3	The result vector.

Returns:

Vector3 -

The result vector.

intersectsAABB(aabb) → {Boolean}

math/OBB.js, line 193

Returns true if the given AABB intersects this OBB.

Parameters:

Name	Type	Description
aabb	AABB	The AABB to test.

Returns:

Boolean -

The result of the intersection test.

intersectsBoundingSphere(sphere) → {Boolean}

math/OBB.js, line 205

Returns true if the given bounding sphere intersects this OBB.

Parameters:

Name	Type	Description
sphere	BoundingSphere	The bounding sphere to test.

Returns:

Boolean -

The result of the intersection test.

intersectsOBB(obb, epsilon) → {Boolean}

math/OBB.js, line 227

Returns true if the given OBB intersects this OBB.

Reference: OBB-OBB Intersection in Real-Time Collision Detection by Christer Ericson (chapter 4.4.1)

Parameters:

Name	Type	Description
obb	OBB	The OBB to test.
epsilon	Number	The epsilon (tolerance) value.

Returns:

Boolean -

The result of the intersection test.

intersectsPlane(plane) → {Boolean}

math/OBB.js, line 371

Returns true if the given plane intersects this OBB.

Reference: Testing Box Against Plane in Real-Time Collision Detection by Christer Ericson (chapter 5.2.3)

Parameters:

Name	Type	Description
plane	Plane	The plane to test.

Returns:

Boolean -

The result of the intersection test.

set(center, halfSizes, rotation) → {OBB}

math/OBB.js, line 82

Sets the given values to this OBB.

Parameters:

Name	Type	Description
center	Vector3	The center of this OBB
halfSizes	Vector3	The half sizes of the OBB (defines its width, height and depth).
rotation	Matrix3	The rotation of this OBB.

Returns:

OBB -

A reference to this OBB.

toJSON() → {Object}

math/OBB.js, line 618

Transforms this instance into a JSON object.

Returns:

Object -

The JSON object.