Package org.joml

Class AABBf

    • Field Summary

      Fields 
      Modifier and Type Field Description
      float maxX
      The x coordinate of the maximum corner.
      float maxY
      The y coordinate of the maximum corner.
      float maxZ
      The z coordinate of the maximum corner.
      float minX
      The x coordinate of the minimum corner.
      float minY
      The y coordinate of the minimum corner.
      float minZ
      The z coordinate of the minimum corner.

    • Constructor Summary

      Constructors 
      Constructor Description
      AABBf​()
      Create a new AABBf representing the box with (minX, minY, minZ)=(+inf, +inf, +inf) and (maxX, maxY, maxZ)=(-inf, -inf, -inf).
      AABBf​(float minX, float minY, float minZ, float maxX, float maxY, float maxZ)
      Create a new AABBf with the given minimum and maximum corner coordinates.
      AABBf​(AABBf source)
      Create a new AABBf as a copy of the given source.
      AABBf​(Vector3fc min, Vector3fc max)
      Create a new AABBf with the given minimum and maximum corner coordinates.

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      AABBf correctBounds​()
      Ensure that the minimum coordinates are strictly less than or equal to the maximum coordinates by swapping them if necessary.
      boolean equals​(Object obj)  
      float getMax​(int component)
      Get the maximum corner coordinate of the given component.
      float getMin​(int component)
      Get the minimum corner coordinate of the given component.
      int hashCode​()  
      int intersectLineSegment​(float p0X, float p0Y, float p0Z, float p1X, float p1Y, float p1Z, Vector2f result)
      Determine whether the undirected line segment with the end points (p0X, p0Y, p0Z) and (p1X, p1Y, p1Z) intersects this AABB, and return the values of the parameter t in the ray equation p(t) = origin + p0 * (p1 - p0) of the near and far point of intersection.
      int intersectLineSegment​(LineSegmentf lineSegment, Vector2f result)
      Determine whether the given undirected line segment intersects this AABB, and return the values of the parameter t in the ray equation p(t) = origin + p0 * (p1 - p0) of the near and far point of intersection.
      boolean intersectRay​(float originX, float originY, float originZ, float dirX, float dirY, float dirZ, Vector2f result)
      Determine whether the given ray with the origin (originX, originY, originZ) and direction (dirX, dirY, dirZ) intersects this AABB, and return the values of the parameter t in the ray equation p(t) = origin + t * dir of the near and far point of intersection.
      boolean intersectRay​(Rayf ray, Vector2f result)
      Determine whether the given ray intersects this AABB, and return the values of the parameter t in the ray equation p(t) = origin + t * dir of the near and far point of intersection.
      void readExternal​(ObjectInput in)  
      AABBf setMax​(float maxX, float maxY, float maxZ)
      Set the maximum corner coordinates.
      AABBf setMax​(Vector3fc max)
      Set the maximum corner coordinates.
      AABBf setMin​(float minX, float minY, float minZ)
      Set the minimum corner coordinates.
      AABBf setMin​(Vector3fc min)
      Set the minimum corner coordinates.
      boolean testAABB​(AABBf other)
      Test whether this and other intersect.
      boolean testPlane​(float a, float b, float c, float d)
      Test whether the plane given via its plane equation a*x + b*y + c*z + d = 0 intersects this AABB.
      boolean testPlane​(Planef plane)
      Test whether the given plane intersects this AABB.
      boolean testPoint​(float x, float y, float z)
      Test whether the point (x, y, z) lies inside this AABB.
      boolean testPoint​(Vector3fc point)
      Test whether the given point lies inside this AABB.
      boolean testRay​(float originX, float originY, float originZ, float dirX, float dirY, float dirZ)
      Test whether the given ray with the origin (originX, originY, originZ) and direction (dirX, dirY, dirZ) intersects this AABB.
      boolean testRay​(Rayf ray)
      Test whether the given ray intersects this AABB.
      boolean testSphere​(float centerX, float centerY, float centerZ, float radiusSquared)
      Test whether this AABB intersects the given sphere with equation (x - centerX)^2 + (y - centerY)^2 + (z - centerZ)^2 - radiusSquared = 0.
      boolean testSphere​(Spheref sphere)
      Test whether this AABB intersects the given sphere.
      String toString​()
      Return a string representation of this AABB.
      String toString​(NumberFormat formatter)
      Return a string representation of this AABB by formatting the vector components with the given NumberFormat.
      AABBf transform​(Matrix4fc m)
      Apply the given affine transformation to this AABBf.
      AABBf transform​(Matrix4fc m, AABBf dest)
      Apply the given affine transformation to this AABBf and store the resulting AABB into dest.
      AABBf translate​(float x, float y, float z)
      Translate this by the vector (x, y, z).
      AABBf translate​(float x, float y, float z, AABBf dest)
      Translate this by the vector (x, y, z) and store the result in dest.
      AABBf translate​(Vector3fc xyz)
      Translate this by the given vector xyz.
      AABBf translate​(Vector3fc xyz, AABBf dest)
      Translate this by the given vector xyz and store the result in dest.
      AABBf union​(float x, float y, float z)
      Set this to the union of this and the given point (x, y, z).
      AABBf union​(float x, float y, float z, AABBf dest)
      Compute the union of this and the given point (x, y, z) and store the result in dest.
      AABBf union​(AABBf other)
      Set this to the union of this and other.
      AABBf union​(AABBf other, AABBf dest)
      Compute the union of this and other and store the result in dest.
      AABBf union​(Vector3fc p)
      Set this to the union of this and the given point p.
      AABBf union​(Vector3fc p, AABBf dest)
      Compute the union of this and the given point p and store the result in dest.
      void writeExternal​(ObjectOutput out)  

    • Field Detail

      • minX

        public float minX
        The x coordinate of the minimum corner.

      • minY

        public float minY
        The y coordinate of the minimum corner.

      • minZ

        public float minZ
        The z coordinate of the minimum corner.

      • maxX

        public float maxX
        The x coordinate of the maximum corner.

      • maxY

        public float maxY
        The y coordinate of the maximum corner.

      • maxZ

        public float maxZ
        The z coordinate of the maximum corner.

    • Constructor Detail

      • AABBf

        public AABBf​()
        Create a new AABBf representing the box with (minX, minY, minZ)=(+inf, +inf, +inf) and (maxX, maxY, maxZ)=(-inf, -inf, -inf).

      • AABBf

        public AABBf​(AABBf source)
        Create a new AABBf as a copy of the given source.
        Parameters:
        source - the AABBf to copy from

      • AABBf

        public AABBf​(Vector3fc min,
             Vector3fc max)
        Create a new AABBf with the given minimum and maximum corner coordinates.
        Parameters:
        min - the minimum coordinates
        max - the maximum coordinates

      • AABBf

        public AABBf​(float minX,
             float minY,
             float minZ,
             float maxX,
             float maxY,
             float maxZ)
        Create a new AABBf with the given minimum and maximum corner coordinates.
        Parameters:
        minX - the x coordinate of the minimum corner
        minY - the y coordinate of the minimum corner
        minZ - the z coordinate of the minimum corner
        maxX - the x coordinate of the maximum corner
        maxY - the y coordinate of the maximum corner
        maxZ - the z coordinate of the maximum corner

    • Method Detail

      • setMin

        public AABBf setMin​(float minX,
                    float minY,
                    float minZ)
        Set the minimum corner coordinates.
        Parameters:
        minX - the x coordinate of the minimum corner
        minY - the y coordinate of the minimum corner
        minZ - the z coordinate of the minimum corner
        Returns:
        this

      • setMax

        public AABBf setMax​(float maxX,
                    float maxY,
                    float maxZ)
        Set the maximum corner coordinates.
        Parameters:
        maxX - the x coordinate of the maximum corner
        maxY - the y coordinate of the maximum corner
        maxZ - the z coordinate of the maximum corner
        Returns:
        this

      • setMin

        public AABBf setMin​(Vector3fc min)
        Set the minimum corner coordinates.
        Parameters:
        min - the minimum coordinates
        Returns:
        this

      • setMax

        public AABBf setMax​(Vector3fc max)
        Set the maximum corner coordinates.
        Parameters:
        max - the maximum coordinates
        Returns:
        this

      • getMax

        public float getMax​(int component)
             throws IllegalArgumentException
        Get the maximum corner coordinate of the given component.
        Parameters:
        component - the component, within [0..2]
        Returns:
        the maximum coordinate
        Throws:
        IllegalArgumentException - if component is not within [0..2]

      • getMin

        public float getMin​(int component)
             throws IllegalArgumentException
        Get the minimum corner coordinate of the given component.
        Parameters:
        component - the component, within [0..2]
        Returns:
        the maximum coordinate
        Throws:
        IllegalArgumentException - if component is not within [0..2]

      • union

        public AABBf union​(float x,
                   float y,
                   float z)
        Set this to the union of this and the given point (x, y, z).
        Parameters:
        x - the x coordinate of the point
        y - the y coordinate of the point
        z - the z coordinate of the point
        Returns:
        this

      • union

        public AABBf union​(Vector3fc p)
        Set this to the union of this and the given point p.
        Parameters:
        p - the point
        Returns:
        this

      • union

        public AABBf union​(float x,
                   float y,
                   float z,
                   AABBf dest)
        Compute the union of this and the given point (x, y, z) and store the result in dest.
        Parameters:
        x - the x coordinate of the point
        y - the y coordinate of the point
        z - the z coordinate of the point
        dest - will hold the result
        Returns:
        dest

      • union

        public AABBf union​(Vector3fc p,
                   AABBf dest)
        Compute the union of this and the given point p and store the result in dest.
        Parameters:
        p - the point
        dest - will hold the result
        Returns:
        dest

      • union

        public AABBf union​(AABBf other)
        Set this to the union of this and other.
        Parameters:
        other - the other AABBf
        Returns:
        this

      • union

        public AABBf union​(AABBf other,
                   AABBf dest)
        Compute the union of this and other and store the result in dest.
        Parameters:
        other - the other AABBf
        dest - will hold the result
        Returns:
        dest

      • correctBounds

        public AABBf correctBounds​()
        Ensure that the minimum coordinates are strictly less than or equal to the maximum coordinates by swapping them if necessary.
        Returns:
        this

      • translate

        public AABBf translate​(Vector3fc xyz)
        Translate this by the given vector xyz.
        Parameters:
        xyz - the vector to translate by
        Returns:
        this

      • translate

        public AABBf translate​(Vector3fc xyz,
                       AABBf dest)
        Translate this by the given vector xyz and store the result in dest.
        Parameters:
        xyz - the vector to translate by
        dest - will hold the result
        Returns:
        dest

      • translate

        public AABBf translate​(float x,
                       float y,
                       float z)
        Translate this by the vector (x, y, z).
        Parameters:
        x - the x coordinate to translate by
        y - the y coordinate to translate by
        z - the z coordinate to translate by
        Returns:
        this

      • translate

        public AABBf translate​(float x,
                       float y,
                       float z,
                       AABBf dest)
        Translate this by the vector (x, y, z) and store the result in dest.
        Parameters:
        x - the x coordinate to translate by
        y - the y coordinate to translate by
        z - the z coordinate to translate by
        dest - will hold the result
        Returns:
        dest

      • testPoint

        public boolean testPoint​(float x,
                         float y,
                         float z)
        Test whether the point (x, y, z) lies inside this AABB.
        Parameters:
        x - the x coordinate of the point
        y - the y coordinate of the point
        z - the z coordinate of the point
        Returns:
        true iff the given point lies inside this AABB; false otherwise

      • testPoint

        public boolean testPoint​(Vector3fc point)
        Test whether the given point lies inside this AABB.
        Parameters:
        point - the coordinates of the point
        Returns:
        true iff the given point lies inside this AABB; false otherwise

      • testPlane

        public boolean testPlane​(float a,
                         float b,
                         float c,
                         float d)
        Test whether the plane given via its plane equation a*x + b*y + c*z + d = 0 intersects this AABB.

        Reference: http://www.lighthouse3d.com ("Geometric Approach - Testing Boxes II")

        Parameters:
        a - the x factor in the plane equation
        b - the y factor in the plane equation
        c - the z factor in the plane equation
        d - the constant in the plane equation
        Returns:
        true iff the plane intersects this AABB; false otherwise

      • testPlane

        public boolean testPlane​(Planef plane)
        Test whether the given plane intersects this AABB.

        Reference: http://www.lighthouse3d.com ("Geometric Approach - Testing Boxes II")

        Parameters:
        plane - the plane
        Returns:
        true iff the plane intersects this AABB; false otherwise

      • testAABB

        public boolean testAABB​(AABBf other)
        Test whether this and other intersect.
        Parameters:
        other - the other AABB
        Returns:
        true iff both AABBs intersect; false otherwise

      • testSphere

        public boolean testSphere​(float centerX,
                          float centerY,
                          float centerZ,
                          float radiusSquared)
        Test whether this AABB intersects the given sphere with equation (x - centerX)^2 + (y - centerY)^2 + (z - centerZ)^2 - radiusSquared = 0.

        Reference: http://stackoverflow.com

        Parameters:
        centerX - the x coordinate of the center of the sphere
        centerY - the y coordinate of the center of the sphere
        centerZ - the z coordinate of the center of the sphere
        radiusSquared - the square radius of the sphere
        Returns:
        true iff this AABB and the sphere intersect; false otherwise

      • testSphere

        public boolean testSphere​(Spheref sphere)
        Test whether this AABB intersects the given sphere.

        Reference: http://stackoverflow.com

        Parameters:
        sphere - the sphere
        Returns:
        true iff this AABB and the sphere intersect; false otherwise

      • testRay

        public boolean testRay​(float originX,
                       float originY,
                       float originZ,
                       float dirX,
                       float dirY,
                       float dirZ)
        Test whether the given ray with the origin (originX, originY, originZ) and direction (dirX, dirY, dirZ) intersects this AABB.

        This method returns true for a ray whose origin lies inside this AABB.

        Reference: An Efficient and Robust Ray–Box Intersection

        Parameters:
        originX - the x coordinate of the ray's origin
        originY - the y coordinate of the ray's origin
        originZ - the z coordinate of the ray's origin
        dirX - the x coordinate of the ray's direction
        dirY - the y coordinate of the ray's direction
        dirZ - the z coordinate of the ray's direction
        Returns:
        true if this AABB and the ray intersect; false otherwise

      • testRay

        public boolean testRay​(Rayf ray)
        Test whether the given ray intersects this AABB.

        This method returns true for a ray whose origin lies inside this AABB.

        Reference: An Efficient and Robust Ray–Box Intersection

        Parameters:
        ray - the ray
        Returns:
        true if this AABB and the ray intersect; false otherwise

      • intersectRay

        public boolean intersectRay​(float originX,
                            float originY,
                            float originZ,
                            float dirX,
                            float dirY,
                            float dirZ,
                            Vector2f result)
        Determine whether the given ray with the origin (originX, originY, originZ) and direction (dirX, dirY, dirZ) intersects this AABB, and return the values of the parameter t in the ray equation p(t) = origin + t * dir of the near and far point of intersection.

        This method returns true for a ray whose origin lies inside this AABB.

        Reference: An Efficient and Robust Ray–Box Intersection

        Parameters:
        originX - the x coordinate of the ray's origin
        originY - the y coordinate of the ray's origin
        originZ - the z coordinate of the ray's origin
        dirX - the x coordinate of the ray's direction
        dirY - the y coordinate of the ray's direction
        dirZ - the z coordinate of the ray's direction
        result - a vector which will hold the resulting values of the parameter t in the ray equation p(t) = origin + t * dir of the near and far point of intersection iff the ray intersects this AABB
        Returns:
        true if the given ray intersects this AABB; false otherwise

      • intersectRay

        public boolean intersectRay​(Rayf ray,
                            Vector2f result)
        Determine whether the given ray intersects this AABB, and return the values of the parameter t in the ray equation p(t) = origin + t * dir of the near and far point of intersection.

        This method returns true for a ray whose origin lies inside this AABB.

        Reference: An Efficient and Robust Ray–Box Intersection

        Parameters:
        ray - the ray
        result - a vector which will hold the resulting values of the parameter t in the ray equation p(t) = origin + t * dir of the near and far point of intersection iff the ray intersects this AABB
        Returns:
        true if the given ray intersects this AABB; false otherwise

      • intersectLineSegment

        public int intersectLineSegment​(float p0X,
                                float p0Y,
                                float p0Z,
                                float p1X,
                                float p1Y,
                                float p1Z,
                                Vector2f result)
        Determine whether the undirected line segment with the end points (p0X, p0Y, p0Z) and (p1X, p1Y, p1Z) intersects this AABB, and return the values of the parameter t in the ray equation p(t) = origin + p0 * (p1 - p0) of the near and far point of intersection.

        This method returns true for a line segment whose either end point lies inside this AABB.

        Reference: An Efficient and Robust Ray–Box Intersection

        Parameters:
        p0X - the x coordinate of the line segment's first end point
        p0Y - the y coordinate of the line segment's first end point
        p0Z - the z coordinate of the line segment's first end point
        p1X - the x coordinate of the line segment's second end point
        p1Y - the y coordinate of the line segment's second end point
        p1Z - the z coordinate of the line segment's second end point
        result - a vector which will hold the resulting values of the parameter t in the ray equation p(t) = p0 + t * (p1 - p0) of the near and far point of intersection iff the line segment intersects this AABB
        Returns:
        Intersectionf.INSIDE if the line segment lies completely inside of this AABB; or Intersectionf.OUTSIDE if the line segment lies completely outside of this AABB; or Intersectionf.ONE_INTERSECTION if one of the end points of the line segment lies inside of this AABB; or Intersectionf.TWO_INTERSECTION if the line segment intersects two sides of this AABB or lies on an edge or a side of this AABB

      • intersectLineSegment

        public int intersectLineSegment​(LineSegmentf lineSegment,
                                Vector2f result)
        Determine whether the given undirected line segment intersects this AABB, and return the values of the parameter t in the ray equation p(t) = origin + p0 * (p1 - p0) of the near and far point of intersection.

        This method returns true for a line segment whose either end point lies inside this AABB.

        Reference: An Efficient and Robust Ray–Box Intersection

        Parameters:
        lineSegment - the line segment
        result - a vector which will hold the resulting values of the parameter t in the ray equation p(t) = p0 + t * (p1 - p0) of the near and far point of intersection iff the line segment intersects this AABB
        Returns:
        Intersectionf.INSIDE if the line segment lies completely inside of this AABB; or Intersectionf.OUTSIDE if the line segment lies completely outside of this AABB; or Intersectionf.ONE_INTERSECTION if one of the end points of the line segment lies inside of this AABB; or Intersectionf.TWO_INTERSECTION if the line segment intersects two sides of this AABB or lies on an edge or a side of this AABB

      • transform

        public AABBf transform​(Matrix4fc m)
        Apply the given affine transformation to this AABBf.

        The matrix in m must be affine.

        Parameters:
        m - the affine transformation matrix
        Returns:
        this

      • transform

        public AABBf transform​(Matrix4fc m,
                       AABBf dest)
        Apply the given affine transformation to this AABBf and store the resulting AABB into dest.

        The matrix in m must be affine.

        Parameters:
        m - the affine transformation matrix
        dest - will hold the result
        Returns:
        dest

      • hashCode

        public int hashCode​()
        Overrides:
        hashCode in class Object

      • toString

        public String toString​()
        Return a string representation of this AABB.

        This method creates a new DecimalFormat on every invocation with the format string "0.000E0;-".

        Overrides:
        toString in class Object
        Returns:
        the string representation

      • toString

        public String toString​(NumberFormat formatter)
        Return a string representation of this AABB by formatting the vector components with the given NumberFormat.
        Parameters:
        formatter - the NumberFormat used to format the vector components with
        Returns:
        the string representation