Class BoundingBox

Class used to store bounding box information

Hierarchy

BoundingBox

Implements

ICullable

Index

Constructors

constructor

Properties

Methods

Constructors

constructor

new BoundingBox(min: DeepImmutable<Vector3>, max: DeepImmutable<Vector3>, worldMatrix?: DeepImmutable<Matrix>): BoundingBox

- Defined in .temp/docdirectory/doc.d.ts:13750
Creates a new bounding box

Parameters
- min: DeepImmutable<Vector3>
  
  defines the minimum vector (in local space)
- max: DeepImmutable<Vector3>
  
  defines the maximum vector (in local space)
- Optional worldMatrix: DeepImmutable<Matrix>
  
  defines the new world matrix
Returns BoundingBox

Properties

Readonly centerSearch playground for center

center: Vector3

Gets the center of the bounding box in local space

Readonly centerWorldSearch playground for centerWorld

centerWorld: Vector3

Gets the center of the bounding box in world space

Readonly directionsSearch playground for directions

directions: Vector3[]

Gets the OBB (object bounding box) directions

Readonly extendSizeSearch playground for extendSize

extendSize: Vector3

Gets the extend size in local space

Readonly extendSizeWorldSearch playground for extendSizeWorld

extendSizeWorld: Vector3

Gets the extend size in world space

Readonly maximumSearch playground for maximum

maximum: Vector3

Gets the maximum vector in local space

Readonly maximumWorldSearch playground for maximumWorld

maximumWorld: Vector3

Gets the maximum vector in world space

Readonly minimumSearch playground for minimum

minimum: Vector3

Gets the minimum vector in local space

Readonly minimumWorldSearch playground for minimumWorld

minimumWorld: Vector3

Gets the minimum vector in world space

Readonly vectorsSearch playground for vectors

vectors: Vector3[]

Gets the 8 vectors representing the bounding box in local space

Readonly vectorsWorldSearch playground for vectorsWorld

vectorsWorld: Vector3[]

Gets the 8 vectors representing the bounding box in world space

Methods

disposeSearch playground for dispose

dispose(): void

- Defined in .temp/docdirectory/doc.d.ts:13815
Disposes the resources of the class

Returns void

getWorldMatrixSearch playground for getWorldMatrix

getWorldMatrix(): DeepImmutable<Matrix>

- Defined in .temp/docdirectory/doc.d.ts:13775
Gets the world matrix of the bounding box

Returns DeepImmutable<Matrix>

a matrix

intersectsMinMaxSearch playground for intersectsMinMax

intersectsMinMax(min: DeepImmutable<Vector3>, max: DeepImmutable<Vector3>): boolean

- Defined in .temp/docdirectory/doc.d.ts:13811
Tests if the bounding box intersects with a box defined by a min and max vectors

Parameters
- min: DeepImmutable<Vector3>
  
  defines the min vector to use
- max: DeepImmutable<Vector3>
  
  defines the max vector to use
Returns boolean

true if there is an intersection

intersectsPointSearch playground for intersectsPoint

intersectsPoint(point: DeepImmutable<Vector3>): boolean

- Defined in .temp/docdirectory/doc.d.ts:13798
Tests if a point is inside the bounding box

Parameters
- point: DeepImmutable<Vector3>
  
  defines the point to test
Returns boolean

true if the point is inside the bounding box

intersectsSphereSearch playground for intersectsSphere

intersectsSphere(sphere: DeepImmutable<BoundingSphere>): boolean

- Defined in .temp/docdirectory/doc.d.ts:13804
Tests if the bounding box intersects with a bounding sphere

Parameters
- sphere: DeepImmutable<BoundingSphere>
  
  defines the sphere to test
Returns boolean

true if there is an intersection

isCompletelyInFrustumSearch playground for isCompletelyInFrustum

isCompletelyInFrustum(frustumPlanes: Array<DeepImmutable<Plane>>): boolean

- Defined in .temp/docdirectory/doc.d.ts:13792
Tests if the bounding box is entirely inside the frustum planes

Parameters
- frustumPlanes: Array<DeepImmutable<Plane>>
  
  defines the frustum planes to test
Returns boolean

true if there is an inclusion

isInFrustumSearch playground for isInFrustum

isInFrustum(frustumPlanes: Array<DeepImmutable<Plane>>): boolean

- Defined in .temp/docdirectory/doc.d.ts:13786
Tests if the bounding box is intersecting the frustum planes

Parameters
- frustumPlanes: Array<DeepImmutable<Plane>>
  
  defines the frustum planes to test
Returns boolean

true if there is an intersection

reConstructSearch playground for reConstruct

reConstruct(min: DeepImmutable<Vector3>, max: DeepImmutable<Vector3>, worldMatrix?: DeepImmutable<Matrix>): void

- Defined in .temp/docdirectory/doc.d.ts:13764
Recreates the entire bounding box from scratch as if we call the constructor in place

Parameters
- min: DeepImmutable<Vector3>
  
  defines the new minimum vector (in local space)
- max: DeepImmutable<Vector3>
  
  defines the new maximum vector (in local space)
- Optional worldMatrix: DeepImmutable<Matrix>
  
  defines the new world matrix
Returns void

scaleSearch playground for scale

scale(factor: number): BoundingBox

- Defined in .temp/docdirectory/doc.d.ts:13770
Scale the current bounding box by applying a scale factor

Parameters
- factor: number
  
  defines the scale factor to apply
Returns BoundingBox

the current bounding box

Static IntersectsSearch playground for Intersects

Intersects(box0: DeepImmutable<BoundingBox>, box1: DeepImmutable<BoundingBox>): boolean

- Defined in .temp/docdirectory/doc.d.ts:13822
Tests if two bounding boxes are intersections

Parameters
- box0: DeepImmutable<BoundingBox>
  
  defines the first box to test
- box1: DeepImmutable<BoundingBox>
  
  defines the second box to test
Returns boolean

true if there is an intersection

Static IntersectsSphereSearch playground for IntersectsSphere

IntersectsSphere(minPoint: DeepImmutable<Vector3>, maxPoint: DeepImmutable<Vector3>, sphereCenter: DeepImmutable<Vector3>, sphereRadius: number): boolean

- Defined in .temp/docdirectory/doc.d.ts:13831
Tests if a bounding box defines by a min/max vectors intersects a sphere

Parameters
- minPoint: DeepImmutable<Vector3>
  
  defines the minimum vector of the bounding box
- maxPoint: DeepImmutable<Vector3>
  
  defines the maximum vector of the bounding box
- sphereCenter: DeepImmutable<Vector3>
  
  defines the sphere center
- sphereRadius: number
  
  defines the sphere radius
Returns boolean

true if there is an intersection

Static IsCompletelyInFrustumSearch playground for IsCompletelyInFrustum

IsCompletelyInFrustum(boundingVectors: Array<DeepImmutable<Vector3>>, frustumPlanes: Array<DeepImmutable<Plane>>): boolean

- Defined in .temp/docdirectory/doc.d.ts:13838
Tests if a bounding box defined with 8 vectors is entirely inside frustum planes

Parameters
- boundingVectors: Array<DeepImmutable<Vector3>>
  
  defines an array of 8 vectors representing a bounding box
- frustumPlanes: Array<DeepImmutable<Plane>>
  
  defines the frustum planes to test
Returns boolean

true if there is an inclusion

Static IsInFrustumSearch playground for IsInFrustum

IsInFrustum(boundingVectors: Array<DeepImmutable<Vector3>>, frustumPlanes: Array<DeepImmutable<Plane>>): boolean

- Defined in .temp/docdirectory/doc.d.ts:13845
Tests if a bounding box defined with 8 vectors intersects frustum planes

Parameters
- boundingVectors: Array<DeepImmutable<Vector3>>
  
  defines an array of 8 vectors representing a bounding box
- frustumPlanes: Array<DeepImmutable<Plane>>
  
  defines the frustum planes to test
Returns boolean

true if there is an intersection

Hierarchy

Implements

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

min: DeepImmutable<Vector3>

max: DeepImmutable<Vector3>

Optional worldMatrix: DeepImmutable<Matrix>

Returns BoundingBox

Properties

Readonly centerSearch playground for center

Readonly centerWorldSearch playground for centerWorld

Readonly directionsSearch playground for directions

Readonly extendSizeSearch playground for extendSize

Readonly extendSizeWorldSearch playground for extendSizeWorld

Readonly maximumSearch playground for maximum

Readonly maximumWorldSearch playground for maximumWorld

Readonly minimumSearch playground for minimum

Readonly minimumWorldSearch playground for minimumWorld

Readonly vectorsSearch playground for vectors

Readonly vectorsWorldSearch playground for vectorsWorld

Methods

disposeSearch playground for dispose

Returns void

getWorldMatrixSearch playground for getWorldMatrix

Returns DeepImmutable<Matrix>

intersectsMinMaxSearch playground for intersectsMinMax

Parameters

min: DeepImmutable<Vector3>

max: DeepImmutable<Vector3>

Returns boolean

intersectsPointSearch playground for intersectsPoint

Parameters

point: DeepImmutable<Vector3>

Returns boolean

intersectsSphereSearch playground for intersectsSphere

Parameters

sphere: DeepImmutable<BoundingSphere>

Returns boolean

isCompletelyInFrustumSearch playground for isCompletelyInFrustum

Parameters

frustumPlanes: Array<DeepImmutable<Plane>>

Returns boolean

isInFrustumSearch playground for isInFrustum

Parameters

frustumPlanes: Array<DeepImmutable<Plane>>

Returns boolean

reConstructSearch playground for reConstruct

Parameters

min: DeepImmutable<Vector3>

max: DeepImmutable<Vector3>

Optional worldMatrix: DeepImmutable<Matrix>

Returns void

scaleSearch playground for scale

Parameters

factor: number

Returns BoundingBox

Static IntersectsSearch playground for Intersects

Parameters

box0: DeepImmutable<BoundingBox>

box1: DeepImmutable<BoundingBox>

Returns boolean

Static IntersectsSphereSearch playground for IntersectsSphere

Parameters

minPoint: DeepImmutable<Vector3>

maxPoint: DeepImmutable<Vector3>

sphereCenter: DeepImmutable<Vector3>

sphereRadius: number

Returns boolean

Static IsCompletelyInFrustumSearch playground for IsCompletelyInFrustum

Parameters

boundingVectors: Array<DeepImmutable<Vector3>>

frustumPlanes: Array<DeepImmutable<Plane>>

Returns boolean

Static IsInFrustumSearch playground for IsInFrustum

Parameters