Class BoundingBox

constructor

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

  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)

  • OptionalworldMatrix: DeepImmutableObject<Matrix>

    defines the new world matrix

  Returns BoundingBox

Readonlycenter

ReadonlycenterWorld

Readonlydirections

ReadonlyextendSize

ReadonlyextendSizeWorld

Readonlymaximum

ReadonlymaximumWorld

Readonlyminimum

ReadonlyminimumWorld

Readonlyvectors

ReadonlyvectorsWorld

dispose

• dispose(): void

  Disposes the resources of the class

  Returns void

getWorldMatrix

• getWorldMatrix(): DeepImmutable<Matrix>

  Gets the world matrix of the bounding box

  Returns DeepImmutable<Matrix>

  a matrix

intersectsMinMax

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

  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

intersectsPoint

• intersectsPoint(point: DeepImmutable<Vector3>): boolean

  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

intersectsSphere

• intersectsSphere(sphere: DeepImmutable<BoundingSphere>): boolean

  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

isCompletelyInFrustum

• isCompletelyInFrustum(frustumPlanes: DeepImmutableObject<Plane>[]): boolean

  Tests if the bounding box is entirely inside the frustum planes

  Parameters

  • frustumPlanes: DeepImmutableObject<Plane>[]

    defines the frustum planes to test

  Returns boolean

  true if there is an inclusion

isInFrustum

• isInFrustum(frustumPlanes: DeepImmutableObject<Plane>[]): boolean

  Tests if the bounding box is intersecting the frustum planes

  Parameters

  • frustumPlanes: DeepImmutableObject<Plane>[]

    defines the frustum planes to test

  Returns boolean

  true if there is an intersection

reConstruct

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

  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)

  • OptionalworldMatrix: DeepImmutableObject<Matrix>

    defines the new world matrix

  Returns void

scale

• scale(factor: number): BoundingBox

  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

StaticIntersects

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

  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

StaticIntersectsSphere

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

  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

StaticIsCompletelyInFrustum

• IsCompletelyInFrustum(
      boundingVectors: DeepImmutableObject<Vector3>[],
      frustumPlanes: DeepImmutableObject<Plane>[],
  ): boolean

  Tests if a bounding box defined with 8 vectors is entirely inside frustum planes

  Parameters

  • boundingVectors: DeepImmutableObject<Vector3>[]

    defines an array of 8 vectors representing a bounding box

  • frustumPlanes: DeepImmutableObject<Plane>[]

    defines the frustum planes to test

  Returns boolean

  true if there is an inclusion

StaticIsInFrustum

• IsInFrustum(
      boundingVectors: DeepImmutableObject<Vector3>[],
      frustumPlanes: DeepImmutableObject<Plane>[],
  ): boolean

  Tests if a bounding box defined with 8 vectors intersects frustum planes

  Parameters

  • boundingVectors: DeepImmutableObject<Vector3>[]

    defines an array of 8 vectors representing a bounding box

  • frustumPlanes: DeepImmutableObject<Plane>[]

    defines the frustum planes to test

  Returns boolean

  true if there is an intersection