@minecraft/math
    Preparing search index...

    Class AABBUtils

    Utilities operating on AABB objects. All methods are static and do not modify the input objects.

    Index

    Properties

    EPSILON

    Methods

    createFromCornerPoints dilate equals expand getBlockVolume getIntersection getMax getMin getSpan intersects isInside isValid throwErrorIfInvalid translate

    Properties

    EPSILON: number

    EPSILON

    The internal epsilon value that determines validity and used for block volume tolerance.

    Methods

    • createFromCornerPoints

      Gets an AABB from points defining it's corners, the order doesn't matter.

      Parameters

      • pointA: Vector3

        The first corner point.

      • pointB: Vector3

        The second corner point.

      Returns AABB

      • The resulting AABB.

      AABBInvalidExtentError * This exception is thrown if the resulting AABB is invalid. * *

    • dilate

      Creates a dilated AABB given a source AABB and dilation vector.

      Parameters

      • aabb: AABB

        The source AABB.

      • size: Vector3

        The dilation vector to add to the AABBs extent.

      Returns AABB

      • The resulting dilated AABB.

      AABBInvalidExtentError * This exception is thrown if the input AABB is invalid. * *

    • equals

      Compares the equality of two AABBs.

      Parameters

      • aabb: AABB

        The first AABB in the comparison.

      • other: AABB

        The second AABB in the comparison.

      Returns boolean

      • True if the center and extent of both AABBs are equal.

      AABBInvalidExtentError * This exception is thrown if either of the input AABBs are invalid. * *

    • expand

      Creates an expanded AABB given two source AABBs.

      Parameters

      • aabb: AABB

        The first source AABB.

      • other: AABB

        The second source AABB.

      Returns AABB

      • The resulting expanded AABB.

      AABBInvalidExtentError * This exception is thrown if either of the input AABBs are invalid. * *

    • getBlockVolume

      Creates the smallest BlockVolume that includes all of a source AABB.

      Parameters

      • aabb: AABB

        The source AABB.

      Returns BlockVolume

      • The BlockVolume containing the source AABB.

      AABBInvalidExtentError * This exception is thrown if the input AABB is invalid. * *

    • getIntersection

      Creates an AABB of the intersecting area of two source AABBs.

      Parameters

      • aabb: AABB

        The first source AABB.

      • other: AABB

        The second source AABB.

      Returns undefined | AABB

      • The resulting intersecting AABB if they intersect, otherwise returns undefined.

      AABBInvalidExtentError * This exception is thrown if either of the input AABBs are invalid. * *

    • getMax

      Gets the maximum corner of an AABB.

      Parameters

      • aabb: AABB

        The AABB to retrieve the maximum corner of.

      Returns Vector3

      • The maximum corner of the AABB.

      AABBInvalidExtentError * This exception is thrown if the input AABB is invalid. * *

    • getMin

      Gets the minimum corner of an AABB.

      Parameters

      • aabb: AABB

        The AABB to retrieve the minimum corner of.

      Returns Vector3

      • The minimum corner of the AABB.

      AABBInvalidExtentError * This exception is thrown if the input AABB is invalid. * *

    • getSpan

      Gets the span of an AABB.

      Parameters

      • aabb: AABB

        The AABB to retrieve the span of.

      Returns Vector3

      • The span of the AABB.

      AABBInvalidExtentError * This exception is thrown if the input AABB is invalid. * *

    • intersects

      Calculates if two AABBs are intersecting.

      Parameters

      • aabb: AABB

        The first AABB.

      • other: AABB

        The second AABB.

      Returns boolean

      • True if the AABBs are intersecting, otherwise false.

      AABBInvalidExtentError * This exception is thrown if either of the input AABBs are invalid. * *

    • isInside

      Calculates if a position is inside of an AABB.

      Parameters

      • aabb: AABB

        The AABB to test against.

      • pos: Vector3

        The position to test.

      Returns boolean

      True if the position is inside of the AABB, otherwise returns false.

      AABBInvalidExtentError * This exception is thrown if the input AABB is invalid. * *

    • isValid

      Determines if the AABB has non-zero extent on all axes.

      Parameters

      • aabb: AABB

        The AABB to test for validity.

      Returns boolean

      • True if all extent axes are non-zero, otherwise false.

    • throwErrorIfInvalid

      Throws an error if the AABB is invalid.

      Parameters

      • aabb: AABB

        The AABB to test for validity.

      Returns void

      AABBInvalidExtentError * This exception is thrown if the input AABB is invalid.

    • translate

      Creates a translated AABB given a source AABB and translation vector.

      Parameters

      • aabb: AABB

        The source AABB.

      • delta: Vector3

        The translation vector to add to the AABBs center.

      Returns AABB

      • The resulting translated AABB.

      AABBInvalidExtentError * This exception is thrown if the input AABB is invalid. * *

    Settings

    Member Visibility

    On This Page

    Properties
    Methods