Class BoundingInfo

Info for a bounding data of a mesh

Hierarchy

BoundingInfo

Implements

ICullable

Index

Constructors

constructor

Properties

Accessors

Methods

Constructors

constructor

new BoundingInfo(minimum: DeepImmutable<Vector3>, maximum: DeepImmutable<Vector3>, worldMatrix?: DeepImmutable<Matrix>): BoundingInfo

- Defined in .temp/docdirectory/doc.d.ts:13881
Constructs bounding info

Parameters
- minimum: DeepImmutable<Vector3>
  
  min vector of the bounding box/sphere
- maximum: DeepImmutable<Vector3>
  
  max vector of the bounding box/sphere
- Optional worldMatrix: DeepImmutable<Matrix>
  
  defines the new world matrix
Returns BoundingInfo

Properties

Readonly boundingBoxSearch playground for boundingBox

boundingBox: BoundingBox

Bounding box for the mesh

Readonly boundingSphereSearch playground for boundingSphere

boundingSphere: BoundingSphere

Bounding sphere for the mesh

Accessors

diagonalLength

get diagonalLength(): number

- Defined in .temp/docdirectory/doc.d.ts:13949
Gets the world distance between the min and max points of the bounding box

Returns number

isLocked

get isLocked(): boolean
set isLocked(value: boolean): any

- Defined in .temp/docdirectory/doc.d.ts:13907
If the info is locked and won't be updated to avoid perf overhead

Returns boolean
- Defined in .temp/docdirectory/doc.d.ts:13908
If the info is locked and won't be updated to avoid perf overhead

Parameters
- value: boolean
Returns any

maximum

get maximum(): Vector3

- Defined in .temp/docdirectory/doc.d.ts:13903
max vector of the bounding box/sphere

Returns Vector3

minimum

get minimum(): Vector3

- Defined in .temp/docdirectory/doc.d.ts:13899
min vector of the bounding box/sphere

Returns Vector3

Methods

centerOnSearch playground for centerOn

centerOn(center: DeepImmutable<Vector3>, extend: DeepImmutable<Vector3>): BoundingInfo

- Defined in .temp/docdirectory/doc.d.ts:13920
Recreate the bounding info to be centered around a specific point given a specific extend.

Parameters
- center: DeepImmutable<Vector3>
  
  New center of the bounding info
- extend: DeepImmutable<Vector3>
  
  New extend of the bounding info
Returns BoundingInfo

the current bounding info

encapsulateSearch playground for encapsulate

encapsulate(point: Vector3): BoundingInfo

- Defined in .temp/docdirectory/doc.d.ts:13926
Grows the bounding info to include the given point.

Parameters
- point: Vector3
  
  The point that will be included in the current bounding info
Returns BoundingInfo

the current bounding info

encapsulateBoundingInfoSearch playground for encapsulateBoundingInfo

encapsulateBoundingInfo(toEncapsulate: BoundingInfo): BoundingInfo

- Defined in .temp/docdirectory/doc.d.ts:13932
Grows the bounding info to encapsulate the given bounding info.

Parameters
- toEncapsulate: BoundingInfo
  
  The bounding info that will be encapsulated in the current bounding info
Returns BoundingInfo

the current bounding info

intersectsSearch playground for intersects

intersects(boundingInfo: DeepImmutable<BoundingInfo>, precise: boolean): boolean

- Defined in .temp/docdirectory/doc.d.ts:13976
Checks if another bounding info intersects the bounding box and bounding sphere or the mesh

see

https://doc.babylonjs.com/babylon101/intersect_collisions_-_mesh

Parameters
- boundingInfo: DeepImmutable<BoundingInfo>
  
  the bounding info to check intersection with
- precise: boolean
  
  if the intersection should be done using OBB
Returns boolean

if the bounding info intersects

intersectsPointSearch playground for intersectsPoint

intersectsPoint(point: DeepImmutable<Vector3>): boolean

- Defined in .temp/docdirectory/doc.d.ts:13968
Checks if a point is inside the bounding box and bounding sphere or the mesh

see

https://doc.babylonjs.com/babylon101/intersect_collisions_-_mesh

Parameters
- point: DeepImmutable<Vector3>
  
  the point to check intersection with
Returns boolean

if the point intersects

isCompletelyInFrustumSearch playground for isCompletelyInFrustum

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

- Defined in .temp/docdirectory/doc.d.ts:13956
Checks if a cullable object (mesh...) is in the camera frustum Unlike isInFrustum this checks the full bounding box

Parameters
- frustumPlanes: Array<DeepImmutable<Plane>>
  
  Camera near/planes
Returns boolean

true if the object is in frustum otherwise false

isInFrustumSearch playground for isInFrustum

isInFrustum(frustumPlanes: Array<DeepImmutable<Plane>>, strategy?: number): boolean

- Defined in .temp/docdirectory/doc.d.ts:13945
Returns true if the bounding info is within the frustum defined by the passed array of planes.

Parameters
- frustumPlanes: Array<DeepImmutable<Plane>>
  
  defines the frustum to test
- Optional strategy: number
  
  defines the strategy to use for the culling (default is BABYLON.AbstractMesh.CULLINGSTRATEGY_STANDARD)
Returns boolean

true if the bounding info is in the frustum planes

reConstructSearch playground for reConstruct

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

- Defined in .temp/docdirectory/doc.d.ts:13895
Recreates the entire bounding info 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): BoundingInfo

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

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

the current bounding info

updateSearch playground for update

update(world: DeepImmutable<Matrix>): void

- Defined in .temp/docdirectory/doc.d.ts:13913
Updates the bounding sphere and box

Parameters
- world: DeepImmutable<Matrix>
  
  world matrix to be used to update
Returns void