Class OrientedBox

Oriented Box.

Index

Constructors

Accessors

Methods

containsPoint intersectsBoundingSphere intersectsRay

Constructors

constructor

new OrientedBox(worldTransform?, halfExtents?): OrientedBox
Create a new OrientedBox instance.
Parameters
- OptionalworldTransform: Mat4 = ...
  Transform that has the orientation and position of the box. Scale is assumed to be one.
- OptionalhalfExtents: Vec3 = ...
  Half the distance across the box in each local axis. The constructor takes a reference of this parameter.
Returns OrientedBox
- Defined in submodules/engine/src/core/shape/oriented-box.js:48

Accessors

worldTransform

get worldTransform(): Mat4
Gets the world transform of the OBB.

Returns Mat4
- Defined in submodules/engine/src/core/shape/oriented-box.js:74
set worldTransform(value): void
Sets the world transform of the OBB.
Parameters
- value: Mat4
Returns void
- Defined in submodules/engine/src/core/shape/oriented-box.js:64

Methods

containsPoint

containsPoint(point): boolean
Test if a point is inside a OBB.
Parameters
- point: Vec3
  Point to test.
Returns boolean
True if the point is inside the OBB and false otherwise.
- Defined in submodules/engine/src/core/shape/oriented-box.js:105

intersectsBoundingSphere

intersectsBoundingSphere(sphere): boolean
Test if a Bounding Sphere is overlapping, enveloping, or inside this OBB.
Parameters
- sphere: BoundingSphere
  Bounding Sphere to test.
Returns boolean
True if the Bounding Sphere is overlapping, enveloping or inside this OBB and false otherwise.
- Defined in submodules/engine/src/core/shape/oriented-box.js:117

intersectsRay

intersectsRay(ray, point?): boolean
Test if a ray intersects with the OBB.
Parameters
- ray: Ray
  Ray to test against (direction must be normalized).
- Optionalpoint: Vec3
  If there is an intersection, the intersection point will be copied into here.
Returns boolean
True if there is an intersection.
- Defined in submodules/engine/src/core/shape/oriented-box.js:86