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

Interface ConstPlane

All Known Implementing Classes:
Plane
public interface ConstPlane
Read-only access to an Plane. (native type: const Plane)

  • Method Summary

    Modifier and Type
    Method
    Description
    float
    getConstant()
    Return the constant in single precision.
    Vec3
    getNormal()
    Copy the normal direction.
    float
    getNormalX()
    Return the first (X) component of the normal direction.
    float
    getNormalY()
    Return the 2nd (Y) component of the normal direction.
    float
    getNormalZ()
    Return the 3rd (Z) component of the normal direction.
    float
    signedDistance(Vec3Arg point)
    Return the signed distance of the specified point.

  • Method Details

    • getConstant

      float getConstant()
      Return the constant in single precision. The plane is unaffected.
      Returns:
      the constant value

    • getNormal

      Vec3 getNormal()
      Copy the normal direction. The plane is unaffected.
      Returns:
      a new direction vector

    • getNormalX

      float getNormalX()
      Return the first (X) component of the normal direction. The plane is unaffected.
      Returns:
      the component value

    • getNormalY

      float getNormalY()
      Return the 2nd (Y) component of the normal direction. The plane is unaffected.
      Returns:
      the component value

    • getNormalZ

      float getNormalZ()
      Return the 3rd (Z) component of the normal direction. The plane is unaffected.
      Returns:
      the component value

    • signedDistance

      float signedDistance(Vec3Arg point)
      Return the signed distance of the specified point.
      Parameters:
      point - the point to measure (not null, unaffected)
      Returns:
      the signed distance