AABBic (JOML Primitives 1.10.0 API)

All Known Implementing Classes:

AABBi
```
public interface AABBic
```
Interface to a read-only view of an axis-aligned box defined via the minimum and maximum corner coordinates as ints.

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method and Description
`org.joml.Vector3d`	`center(org.joml.Vector3d dest)` Return the center of the aabb
`org.joml.Vector3f`	`center(org.joml.Vector3f dest)` Return the center of the aabb
`boolean`	`containsAABB(AABBdc aabb)` Check if this AABB contains the given `AABB`.
`boolean`	`containsAABB(AABBfc aabb)` Check if this AABB contains the given `AABB`.
`boolean`	`containsAABB(AABBic aabb)` Check if this AABB contains the given `AABB`.
`boolean`	`containsPoint(float x, float y, float z)` Test whether the point `(x, y, z)` lies inside this AABB.
`boolean`	`containsPoint(int x, int y, int z)` Test whether the point `(x, y, z)` lies inside this AABB.
`boolean`	`containsPoint(org.joml.Vector3fc point)` Test whether the given point lies inside this AABB.
`boolean`	`containsPoint(org.joml.Vector3ic point)` Test whether the given point lies inside this AABB.
`org.joml.Vector3d`	`extent(org.joml.Vector3d dest)` Extent of the aabb (max - min) / 2.0.
`org.joml.Vector3f`	`extent(org.joml.Vector3f dest)` Extent of the aabb (max - min) / 2.0.
`int`	`getMax(int component)` Get the maximum corner coordinate of the given component.
`int`	`getMin(int component)` Get the minimum corner coordinate of the given component.
`AABBi`	`intersection(AABBic other, AABBi dest)` Compute the AABB of intersection between `this` and the given AABB.
`int`	`intersectLineSegment(float p0X, float p0Y, float p0Z, float p1X, float p1Y, float p1Z, org.joml.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, org.joml.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`	`intersectsAABB(AABBfc other)` Test whether `this` and `other` intersect.
`boolean`	`intersectsAABB(AABBic other)` Test whether `this` and `other` intersect.
`boolean`	`intersectsPlane(float a, float b, float c, float d)` Test whether the plane given via its plane equation `ax + by + c*z + d = 0` intersects this AABB.
`boolean`	`intersectsPlane(Planef plane)` Test whether the given plane intersects this AABB.
`boolean`	`intersectsRay(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`	`intersectsRay(float originX, float originY, float originZ, float dirX, float dirY, float dirZ, org.joml.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`	`intersectsRay(Rayf ray)` Test whether the given ray intersects this AABB.
`boolean`	`intersectsRay(Rayf ray, org.joml.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.
`boolean`	`intersectsSphere(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`	`intersectsSphere(Spheref sphere)` Test whether this AABB intersects the given sphere.
`boolean`	`isValid()` Check whether `this` AABB represents a valid AABB.
`int`	`maxX()`
`int`	`maxY()`
`int`	`maxZ()`
`int`	`minX()`
`int`	`minY()`
`int`	`minZ()`
`AABBi`	`transform(org.joml.Matrix4fc m, AABBi dest)` Apply the given `affine` transformation to this `AABBi` and store the resulting AABB into `dest`.
`AABBi`	`translate(int x, int y, int z, AABBi dest)` Translate `this` by the vector `(x, y, z)` and store the result in `dest`.
`AABBi`	`union(AABBic other, AABBi dest)` Compute the union of `this` and `other` and store the result in `dest`.
`AABBi`	`union(int x, int y, int z, AABBi dest)` Compute the union of `this` and the given point `(x, y, z)` and store the result in `dest`.
`AABBi`	`union(org.joml.Vector3ic p, AABBi dest)` Compute the union of `this` and the given point `p` and store the result in `dest`.

- Method Detail
  - minX
```
int minX()
```
    Returns:
    
    The x coordinate of the minimum corner.
  - minY
```
int minY()
```
    Returns:
    
    The y coordinate of the minimum corner.
  - minZ
```
int minZ()
```
    Returns:
    
    The z coordinate of the minimum corner.
  - maxX
```
int maxX()
```
    Returns:
    
    The x coordinate of the maximum corner.
  - maxY
```
int maxY()
```
    Returns:
    
    The y coordinate of the maximum corner.
  - maxZ
```
int maxZ()
```
    Returns:
    
    The z coordinate of the maximum corner.
  - isValid
```
boolean isValid()
```
    Check whether this AABB represents a valid AABB.
    
    Returns:
    
    true iff this AABB is valid; false otherwise
  - getMax
```
int getMax(int component)
```
    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
```
int getMin(int component)
```
    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]
  - center
```
org.joml.Vector3f center(org.joml.Vector3f dest)
```
    Return the center of the aabb
    
    Parameters:
    
    dest - will hold the result
    
    Returns:
    
    dest
  - center
```
org.joml.Vector3d center(org.joml.Vector3d dest)
```
    Return the center of the aabb
    
    Parameters:
    
    dest - will hold the result
    
    Returns:
    
    dest
  - extent
```
org.joml.Vector3d extent(org.joml.Vector3d dest)
```
    Extent of the aabb (max - min) / 2.0.
    
    Parameters:
    
    dest - will hold the result
    
    Returns:
    
    dest
  - extent
```
org.joml.Vector3f extent(org.joml.Vector3f dest)
```
    Extent of the aabb (max - min) / 2.0.
    
    Parameters:
    
    dest - will hold the result
    
    Returns:
    
    dest
  - union
```
AABBi union(int x,
            int y,
            int z,
            AABBi 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
```
AABBi union(org.joml.Vector3ic p,
            AABBi 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
```
AABBi union(AABBic other,
            AABBi dest)
```
    Compute the union of this and other and store the result in dest.
    
    Parameters:
    
    other - the other AABBi
    
    dest - will hold the result
    
    Returns:
    
    dest
  - translate
```
AABBi translate(int x,
                int y,
                int z,
                AABBi 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
  - intersection
```
AABBi intersection(AABBic other,
                   AABBi dest)
```
    Compute the AABB of intersection between this and the given AABB.
    If the two AABBs do not intersect, then the minimum coordinates of this will have a value of Integer.MAX_VALUE and the maximum coordinates will have a value of Integer.MIN_VALUE.
    
    Parameters:
    
    other - the other AABB
    
    dest - will hold the result
    
    Returns:
    
    dest
  - containsAABB
```
boolean containsAABB(AABBdc aabb)
```
    Check if this AABB contains the given AABB.
    
    Parameters:
    
    aabb - the AABB to test
    
    Returns:
    
    true iff this AABB contains the AABB; false otherwise
  - containsAABB
```
boolean containsAABB(AABBfc aabb)
```
    Check if this AABB contains the given AABB.
    
    Parameters:
    
    aabb - the AABB to test
    
    Returns:
    
    true iff this AABB contains the AABB; false otherwise
  - containsAABB
```
boolean containsAABB(AABBic aabb)
```
    Check if this AABB contains the given AABB.
    
    Parameters:
    
    aabb - the AABB to test
    
    Returns:
    
    true iff this AABB contains the AABB; false otherwise
  - containsPoint
```
boolean containsPoint(int x,
                      int y,
                      int 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
  - containsPoint
```
boolean containsPoint(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
  - containsPoint
```
boolean containsPoint(org.joml.Vector3ic 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
  - containsPoint
```
boolean containsPoint(org.joml.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
  - intersectsPlane
```
boolean intersectsPlane(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
  - intersectsPlane
```
boolean intersectsPlane(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
  - intersectsAABB
```
boolean intersectsAABB(AABBic other)
```
    Test whether this and other intersect.
    
    Parameters:
    
    other - the other AABB
    
    Returns:
    
    true iff both AABBs intersect; false otherwise
  - intersectsAABB
```
boolean intersectsAABB(AABBfc other)
```
    Test whether this and other intersect.
    
    Parameters:
    
    other - the other AABB
    
    Returns:
    
    true iff both AABBs intersect; false otherwise
  - intersectsSphere
```
boolean intersectsSphere(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
  - intersectsSphere
```
boolean intersectsSphere(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
  - intersectsRay
```
boolean intersectsRay(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
  - intersectsRay
```
boolean intersectsRay(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
  - intersectsRay
```
boolean intersectsRay(float originX,
                      float originY,
                      float originZ,
                      float dirX,
                      float dirY,
                      float dirZ,
                      org.joml.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
  - intersectsRay
```
boolean intersectsRay(Rayf ray,
                      org.joml.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
```
int intersectLineSegment(float p0X,
                         float p0Y,
                         float p0Z,
                         float p1X,
                         float p1Y,
                         float p1Z,
                         org.joml.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
```
int intersectLineSegment(LineSegmentf lineSegment,
                         org.joml.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
```
AABBi transform(org.joml.Matrix4fc m,
                AABBi dest)
```
    Apply the given affine transformation to this AABBi 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

Interface AABBic

Method Summary

Method Detail

minX

minY

minZ

maxX

maxY

maxZ

isValid

getMax

getMin

center

center

extent

extent

union

union

union

translate

intersection

containsAABB

containsAABB

containsAABB

containsPoint

containsPoint

containsPoint

containsPoint

intersectsPlane

intersectsPlane

intersectsAABB

intersectsAABB

intersectsSphere

intersectsSphere

intersectsRay

intersectsRay

intersectsRay

intersectsRay

intersectLineSegment

intersectLineSegment

transform