Interface CellJitter

All Known Implementing Classes:
ConstantCellJitter, DefaultCellJitter
public interface CellJitter

  • Method Summary

    Modifier and Type
    Method
    Description
    double
    getMaxX()
    Returns the maximum amount of x-axis jitter applied by this CellJitter.
    double
    getMaxY()
    Returns the maximum amount of y-axis jitter applied by this CellJitter.
    double
    getMaxZ()
    Returns the maximum amount of z-axis jitter applied by this CellJitter.
    double
    getPointX(int cx, DoubleArray.Double2 vec)
    Returns the x-coordinate of the 2D jittered cell centre-point.
    double
    getPointX(int cx, DoubleArray.Double3 vec)
    Returns the x-coordinate of the 3D jittered cell centre-point.
    double
    getPointY(int cy, DoubleArray.Double2 vec)
    Returns the y-coordinate of the 2D jittered cell centre-point.
    double
    getPointY(int cy, DoubleArray.Double3 vec)
    Returns the x-coordinate of the 3D jittered cell centre-point.
    double
    getPointZ(int cz, DoubleArray.Double3 vec)
    Returns the z-coordinate of the 3D jittered cell centre-point.
    static CellJitter
    of(double x, double y, double z)
     

  • Method Details

    • getMaxX

      double getMaxX()
      Returns the maximum amount of x-axis jitter applied by this CellJitter.
      Returns:
      The maximum amount of x-axis jitter.

    • getMaxY

      double getMaxY()
      Returns the maximum amount of y-axis jitter applied by this CellJitter.
      Returns:
      The maximum amount of y-axis jitter.

    • getMaxZ

      double getMaxZ()
      Returns the maximum amount of z-axis jitter applied by this CellJitter.
      Returns:
      The maximum amount of z-axis jitter.

    • getPointX

      double getPointX(int cx, DoubleArray.Double2 vec)
      Returns the x-coordinate of the 2D jittered cell centre-point.
      Parameters:
      cx - The cell x-index.
      vec - The raw offset values to be applied to the cell index.
      Returns:
      The resulting jittered x-coordinate of the cell centre-point.

    • getPointY

      double getPointY(int cy, DoubleArray.Double2 vec)
      Returns the y-coordinate of the 2D jittered cell centre-point.
      Parameters:
      cy - The cell y-index.
      vec - The raw offset values to be applied to the cell index.
      Returns:
      The resulting jittered y-coordinate of the cell centre-point.

    • getPointX

      double getPointX(int cx, DoubleArray.Double3 vec)
      Returns the x-coordinate of the 3D jittered cell centre-point.
      Parameters:
      cx - The cell y-index.
      vec - The raw offset values to be applied to the cell index.
      Returns:
      The resulting jittered x-coordinate of the cell centre-point.

    • getPointY

      double getPointY(int cy, DoubleArray.Double3 vec)
      Returns the x-coordinate of the 3D jittered cell centre-point.
      Parameters:
      cy - The cell y-index.
      vec - The raw offset values to be applied to the cell index.
      Returns:
      The resulting jittered y-coordinate of the cell centre-point.

    • getPointZ

      double getPointZ(int cz, DoubleArray.Double3 vec)
      Returns the z-coordinate of the 3D jittered cell centre-point.
      Parameters:
      cz - The cell y-index.
      vec - The raw offset values to be applied to the cell index.
      Returns:
      The resulting jittered z-coordinate of the cell centre-point.

    • of

      @Nonnull static CellJitter of(double x, double y, double z)