Class AABB

An axis aligned Bounding Box.

This object contains a center and the half extent of the resulting box.


Maths

Hierarchy

  • AABB

Constructors

constructor

Properties

mCenter mHalfExtent

Methods

clampAABB equals getRadius grow growAABB growAABBCenterExtent growVector isValid setMinMax testPosition transformBy whichSide

Constructors

constructor

  • Creates an axis aligned bounding box.

    If omitted, pCenter will be set to the origin (0,0,0). If omitted, pHalfExtent will be set to (0,0,0), this is an invalid box.

    Returns

    The newly constructed AABB.

    Parameters

    • Optional pCenter: Vector3
      in
      The center of the AABB.
    • Optional pHalfExtent: Vector3
      in
      The half extent on each axis of the AABB.

    Returns AABB

Properties

mCenter

mCenter: Vector3

The center of the axis aligned bounding box (x,y and z in this order).

mHalfExtent

mHalfExtent: Vector3

The half extent on each axis (x,y and z in this order).

Methods

clampAABB

  • Clamps the given AABB with the given limit AABB.

    If the boxes intersect, then the result is the intersection of the 2 boxes. If the 2 boxes do not intersect, then the AABB is restricted to the intersection of each axis in each direction. The result is therefore not the intersection of the two boxes, but the union of the intersection in each axis. If there is no intersection in this axis, the extent in this axis is left unchanged.

    Returns

    true if pLimitAABB is valid.

    Parameters

    • pLimitAABB: AABB
      in
      The AABB to clamp with.

    Returns boolean

equals

  • Tells if the two AABB are strictly identical.

    Returns

    true if the two AABB are strictly identical.

    Parameters

    • pOtherAABB: AABB
      in
      The other AABB to compare to.

    Returns boolean

getRadius

  • Gets the radius of the sphere centered on the center of the box which contains the box.

    This is equal to √(mHalfExtent.mHalfExtent).

    Returns

    The box radius.

    Returns number

grow

  • Grows the AABB to contain the box defined by Min : (pMinX,pMinY,pMinZ), Max : (pMaxX,pMaxY,pMaxZ).

    There is no check that pMinX <= pMaxX, pMinY <= pMaxY, pMinZ <= pMaxZ.

    Returns

    false is the pMax is lower than pMin else true.

    Parameters

    • pMinX: number
      in
      Min x coordinate of the box to include.
    • pMinY: number
      in
      Min y coordinate of the box to include.
    • pMinZ: number
      in
      Min z coordinate of the box to include.
    • pMaxX: number
      in
      Max x coordinate of the box to include.
    • pMaxY: number
      in
      Max y coordinate of the box to include.
    • pMaxZ: number
      in
      Max z coordinate of the box to include.

    Returns boolean

growAABB

  • Grows the AABB to contain the box pBox.

    Returns

    false is the pBox is invalid else true.

    Parameters

    • pBox: AABB
      in
      The box to include.

    Returns boolean

growAABBCenterExtent

  • Grows the AABB to contain the box expressed as center pBoxCenter and half extent pHalfExtent.

    Returns

    false if the pHalfExtent contains negative value else true.

    Parameters

    • pBoxCenter: Vector3
      in
      The center of the box to include.
    • pHalfExtent: Vector3
      in
      The half extent of the box to include.

    Returns boolean

growVector

  • Grows the AABB to contain the box defined by pMin, pMax.

    There is no check that pMin <= pMax.

    Returns

    false if pMax is lower than pMin else true.

    Parameters

    • pMin: Vector3
      in
      Min point of the box to include.
    • pMax: Vector3
      in
      Max point of the box to include.

    Returns boolean

isValid

  • Return if the AABB is valid ie all values of the half extent must be positive.

    Returns

    true if all HalfExtent values are positive.

    Returns boolean

setMinMax

  • Initializes the AABB with pMin,pMax.

    Returns

    false if the pMax is lower than pMin else true.

    Parameters

    • pMin: Vector3
      in
      The min point of the AABB.
    • pMax: Vector3
      in
      The max point of the AABB.

    Returns boolean

testPosition

  • Tests if a point is in the box.

    Returns

    true if point is in the AABB, else false.

    Parameters

    • pPosition: Vector3
      in
      The point to test.

    Returns boolean

transformBy

  • Transforms the given AABB by multiplying all the extent points of the given AABB, and stores the AABB that contains this Oriented Bounding Box (OBB).

    If pOut is omitted, then the resulting AABB is stored in "this".

    Returns

    The transformed AABB pOut.

    Parameters

    • pXForm: Matrix4
      in
      The matrix to multiply the extents point with.
    • Optional pOut: AABB
      out
      The resulting AABB ("this" if omitted).

    Returns AABB

whichSide

  • Tells where the box is located relative to the plane defined by the equation pPlane : (ax+by+cz=d).

    The positive side is given by the normal vector of the plane : (a,b,c) which are the three first parameters of pPlane. If the box is strictly included in the area of the normal, then 1 is returned, if the box is strictly included in the area opposite to the normal of the plane, -1 is returned. If the box intersects the plan, 0 is returned.

    Returns

    1 on positive side, -1 on negative side, 0 if it intersects the plane.

    See

    Vector4

    Parameters

    • pPlane: Vector4
      in
      The plan to test with (equation of the plane ax+by+cz=d).

    Returns 0 | 1 | -1

Settings

Member Visibility

Theme