Module com.github.stephengold.joltjni
Package com.github.stephengold.joltjni

Class AaBox

java.lang.Object
com.github.stephengold.joltjni.JoltPhysicsObject
com.github.stephengold.joltjni.AaBox
All Implemented Interfaces:
ConstAaBox, ConstJoltPhysicsObject, AutoCloseable, Comparable<JoltPhysicsObject>
public final class AaBox extends JoltPhysicsObject implements ConstAaBox
An axis-aligned box. (native type: AABox)

  • Constructor Details

    • AaBox

      public AaBox()
      Instantiate an invalid box.

    • AaBox

      public AaBox(ConstAaBox original)
      Instantiate a copy of the specified box.
      Parameters:
      original - the box to copy (not null, unaffected)

    • AaBox

      public AaBox(RVec3Arg minimum, RVec3Arg maximum)
      Instantiate a box with the specified minimum and maximum coordinates.
      Parameters:
      minimum - the desired minimum coordinates (not null, unaffected)
      maximum - the desired maximum coordinates (not null, unaffected)

    • AaBox

      public AaBox(Vec3Arg center, float halfExtent)
      Instantiate a cubic box with the specified center coordinates and half extent.
      Parameters:
      center - the desired center coordinates (not null, unaffected)
      halfExtent - the desired half extent

    • AaBox

      public AaBox(Vec3Arg minimum, Vec3Arg maximum)
      Instantiate a box with the specified minimum and maximum coordinates.
      Parameters:
      minimum - the desired minimum coordinates (not null, unaffected)
      maximum - the desired maximum coordinates (not null, unaffected)

  • Method Details

    • encapsulate

      public void encapsulate(ConstAaBox includeBox)
      Enlarge the current box to include the argument box.
      Parameters:
      includeBox - the box to include (not null, unaffected)

    • encapsulate

      public void encapsulate(ConstTriangle triangle)
      Enlarge the box to include the specified triangle.
      Parameters:
      triangle - the triangle to include (not null, unaffected)

    • encapsulate

      public void encapsulate(Vec3Arg location)
      Enlarge the box to include the specified location.
      Parameters:
      location - the location to include (not null, unaffected)

    • encapsulate

      public void encapsulate(ConstVertexList vertices, ConstIndexedTriangle triangle)
      Enlarge the box to include the specified triangle.
      Parameters:
      vertices - array of vertex locations (not null, unaffected)
      triangle - the triangle to include (not null, unaffected)

    • ensureMinimalEdgeLength

      public void ensureMinimalEdgeLength(float minEdgeLength)
      Enlarge the box so that each edge has at least the specified length.
      Parameters:
      minEdgeLength - the desired minimum edge length

    • expandBy

      public void expandBy(Vec3Arg deltas)
      Enlarge the box on all sides by the specified amounts.
      Parameters:
      deltas - the amount to increase the half extent on each axis (not null, unaffected)

    • sBiggest

      public static AaBox sBiggest()
      Instantiate the biggest finite box.
      Returns:
      a new JVM object with a new native object assigned

    • setEmpty

      public void setEmpty()
      Alter the box to be empty.

    • setMax

      public void setMax(Vec3Arg max)
      Alter the maximum coordinates. (native attribute: mMax)
      Parameters:
      max - the desired maximum coordinate for each axis (not null, unaffected)

    • setMin

      public void setMin(Vec3Arg min)
      Alter the minimum coordinates. (native attribute: mMin)
      Parameters:
      min - the desired minimum coordinate for each axis (not null, unaffected)

    • translate

      public void translate(Vec3Arg offset)
      Move by the specified offset.
      Parameters:
      offset - the amount to move (not null, unaffected)

    • contains

      public boolean contains(ConstAaBox other)
      Test whether the current box contains the argument box. The current box is unaffected.
      Specified by:
      contains in interface ConstAaBox
      Parameters:
      other - the other box to check against (not null, unaffected)
      Returns:
      true if contained, otherwise false

    • contains

      public boolean contains(Vec3Arg point)
      Test whether the box contains the specified point. The box is unaffected.
      Specified by:
      contains in interface ConstAaBox
      Parameters:
      point - the point to test (not null, unaffected)
      Returns:
      true if contained, otherwise false

    • getCenter

      public Vec3 getCenter()
      Locate the center of the box. The box is unaffected.
      Specified by:
      getCenter in interface ConstAaBox
      Returns:
      a new location vector

    • getClosestPoint

      public Vec3 getClosestPoint(Vec3Arg location)
      Locate the closest point on or in the box for the specified location. The box is unaffected.
      Specified by:
      getClosestPoint in interface ConstAaBox
      Parameters:
      location - the starting location (not null, unaffected)
      Returns:
      a new vector

    • getExtent

      public Vec3 getExtent()
      Copy the (half) extent of the box. The box is unaffected.
      Specified by:
      getExtent in interface ConstAaBox
      Returns:
      a new vector

    • getMax

      public Vec3 getMax()
      Copy the maximum contained coordinate on each axis. The box is unaffected. (native member: mMax)
      Specified by:
      getMax in interface ConstAaBox
      Returns:
      a new location vector

    • getMin

      public Vec3 getMin()
      Copy the minimum contained coordinate on each axis. The box is unaffected. (native member: mMin)
      Specified by:
      getMin in interface ConstAaBox
      Returns:
      a new location vector

    • getSize

      public Vec3 getSize()
      Copy the size (full extent) on each axis. The box is unaffected.
      Specified by:
      getSize in interface ConstAaBox
      Returns:
      a new vector

    • getSqDistanceTo

      public float getSqDistanceTo(Vec3Arg point)
      Get the squared distance between the box and the specified point.
      Specified by:
      getSqDistanceTo in interface ConstAaBox
      Parameters:
      point - the point to measure from (not null, unaffected)
      Returns:
      the distance, or zero if point lies inside the box

    • getSupport

      public Vec3 getSupport(Vec3Arg direction)
      Calculate the support vector for this convex shape.
      Specified by:
      getSupport in interface ConstAaBox
      Parameters:
      direction - the direction vector
      Returns:
      the support vector

    • getSurfaceArea

      public float getSurfaceArea()
      Get surface area of bounding box.
      Specified by:
      getSurfaceArea in interface ConstAaBox
      Returns:
      the area

    • getVolume

      public float getVolume()
      Return the volume of the box. The box is unaffected.
      Specified by:
      getVolume in interface ConstAaBox
      Returns:
      the volume

    • isValid

      public boolean isValid()
      Test whether the box is valid. It is unaffected.
      Specified by:
      isValid in interface ConstAaBox
      Returns:
      true if valid, otherwise false

    • overlaps

      public boolean overlaps(ConstAaBox other)
      Check if this box overlaps with another box.
      Specified by:
      overlaps in interface ConstAaBox
      Parameters:
      other - the other box to check
      Returns:
      true if they overlap, otherwise false

    • overlaps

      public boolean overlaps(ConstPlane plane)
      Check if this box overlaps with a plane.
      Specified by:
      overlaps in interface ConstAaBox
      Parameters:
      plane - the Plane object to be checked
      Returns:
      true if they overlap, otherwise false

    • scaled

      public AaBox scaled(Vec3Arg factors)
      Return a scaled copy of the box. The current box is unaffected.
      Specified by:
      scaled in interface ConstAaBox
      Parameters:
      factors - the scale factors to apply (not null, unaffected)
      Returns:
      a new object

    • transformed

      public AaBox transformed(Mat44Arg matrix)
      Return a transformed copy of the box. The current box is unaffected.
      Specified by:
      transformed in interface ConstAaBox
      Parameters:
      matrix - the transformation to apply (not null, unaffected)
      Returns:
      a new object