Record Class Pos

java.lang.Object
java.lang.Record
net.minestom.server.coordinate.Pos
Record Components:
x - the X coordinate
y - the Y coordinate
z - the Z coordinate
yaw - the yaw (rotation around vertical axis) in degrees (-180, 180]
pitch - the pitch (rotation around lateral axis) in degrees [-90, 90]
All Implemented Interfaces:
Point
public record Pos(double x, double y, double z, float yaw, float pitch) extends Record implements Point
Represents a 3D position with double-precision coordinates and viewing direction.

Combines Vec with yaw and pitch angles, making it suitable for entities and cameras that need both location and orientation.

View angles are automatically normalized.

  • Nested Class Summary

    Nested Classes
    Modifier and Type
    Class
    Description
    static interface 
    Pos.Operator
    A functional interface representing an operation on the components of a Pos.

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    static final float
    VIEW_EPSILON
    The epsilon used to compare two views (yaw/pitch) if applicable.
    static final Pos
    ZERO
     

    Fields inherited from interface Point

    EPSILON, REGION_SIZE, SECTION_SIZE

  • Constructor Summary

    Constructors
    Constructor
    Description
    Pos(double x, double y, double z)
    Creates a position with the given coordinates (x/y/z) and default view (yaw/pitch = 0).
    Pos(double x, double y, double z, float yaw, float pitch)
    Creates an instance of a Pos record class.
    Pos(Point point)
    Deprecated.
    Use Point.asPos() instead
    Pos(Point point, float yaw, float pitch)
    Deprecated.
    Use Point.asPos() instead with withView(float, float)

  • Method Summary

    Modifier and Type
    Method
    Description
    Pos
    abs()
    Represents this point with all coordinates as their absolute values.
    Pos
    absView()
    Returns the absolute value of the view (yaw/pitch).
    Pos
    add(double value)
    Creates a new point by adding the provided value to this point coordinates for all XYZ.
    Pos
    add(double x, double y, double z)
    Creates a new point by adding the provided values to this point coordinates.
    Pos
    add(Point point)
    Creates a new point by adding another point coordinates to this point coordinates.
    Pos
    apply(Pos.Operator operator)
    Returns a new position based on this position fields.
    Pos
    asPos()
    Deprecated.
    Pos
    asPos(float yaw, float pitch)
    Deprecated.
    Pos
    cross(Point point)
    Calculates the cross product of this point with another.
    Vec
    direction()
    Gets a unit-vector pointing in the direction that this Location is facing.
    Pos
    div(double value)
    Creates a new point by dividing the provided value to this point coordinates for all XYZ.
    Pos
    div(double x, double y, double z)
    Creates a new point by dividing the provided values to this point coordinates.
    Pos
    div(Point point)
    Creates a new point by dividing another point coordinates to this point coordinates.
    final boolean
    equals(Object o)
    Indicates whether some other object is "equal to" this one.
    Direction
    facing()
    Gets the closest direction yaw() and pitch() are facing to.
    static float
    fixPitch(float pitch)
    Fixes a pitch value that is not between -90.0f and 90.0f So for example, -135.0f becomes -90.0f and 225.0f becomes 90.0f
    static float
    fixYaw(float yaw)
    Fixes a yaw value that is not between -180.0f (exclusive) and 180.0f (inclusive).
    static Pos
    fromPoint(Point point)
    Deprecated, for removal: This API element is subject to removal in a future version.
    use Point.asPos() instead
    final int
    hashCode()
    Returns a hash code value for this object.
    Pos
    lerp(Point point, double alpha)
    Calculates a linear interpolation between this point with another point (x/y/z).
    Pos
    lerpView(Pos pos, float alpha)
    Calculates a linear interpolation between this position's view and another position's view (yaw/pitch).
    Pos
    max(double value)
    Gets a point representing the maximum values between this point and the provided value for all coordinates.
    Pos
    max(double x, double y, double z)
    Gets a point representing the maximum values between this point and the provided coordinates (x/y/z).
    Pos
    max(Point point)
    Gets a point representing the maximum values between this point and the provided one (x/y/z).
    Pos
    min(double value)
    Gets a point representing the minimum values between this point and the provided value for all coordinates.
    Pos
    min(double x, double y, double z)
    Gets a point representing the minimum values between this point and the provided coordinates (x/y/z).
    Pos
    min(Point point)
    Gets a point representing the minimum values between this point and the provided one (x/y/z).
    Pos
    mul(double value)
    Creates a new point by multiplying the provided value to this point coordinates for all XYZ.
    Pos
    mul(double x, double y, double z)
    Creates a new point by multiplying the provided values to this point coordinates.
    Pos
    mul(Point point)
    Creates a new point by multiplying another point coordinates to this point coordinates.
    Pos
    neg()
    Represents this point with all coordinates negated.
    Pos
    negView()
    Negates the view (yaw/pitch) of this position.
    Pos
    normalize()
    Converts this point to a unit point (a point with length of 1).
    float
    pitch()
    Returns the value of the pitch record component.
    Pos
    relative(BlockFace face)
    Creates a new point relative to this point based on the provided block face.
    boolean
    sameView(float yaw, float pitch)
    Checks if the yaw and pitch are the same as the given ones.
    boolean
    sameView(Pos position)
    Checks if two positions have a similar view (yaw/pitch).
    boolean
    similarView(float yaw, float pitch)
    Checks if the yaw and pitch are approximately the same as the given ones.
    boolean
    similarView(float yaw, float pitch, float epsilon)
    Checks if the yaw and pitch are approximately the same as the given ones.
    boolean
    similarView(Pos position)
    Checks if two positions have approximately similar views (yaw/pitch).
    boolean
    similarView(Pos position, float epsilon)
    Checks if two positions have approximately similar views (yaw/pitch).
    Pos
    sub(double value)
    Creates a new point by subtracting the provided value to this point coordinates for all XYZ.
    Pos
    sub(double x, double y, double z)
    Creates a new point by subtracting the provided values to this point coordinates.
    Pos
    sub(Point point)
    Creates a new point by subtracting another point coordinates to this point coordinates.
    final String
    toString()
    Returns a string representation of this record class.
    Pos
    withCoord(double x, double y, double z)
    Changes the 3 coordinates of this position (x/y/z).
    Pos
    withCoord(Point point)
    Changes the coordinates to match the provided point.
    Pos
    withDirection(Point point)
    Sets the yaw and pitch to point in the direction of the point.
    Pos
    withLookAt(Point point)
    Changes the view to look at a specific point.
    Pos
    withPitch(float pitch)
    Changes the pitch of this position.
    Pos
    withPitch(DoubleUnaryOperator operator)
    Applies an operator to the pitch of this position.
    Pos
    withView(float yaw, float pitch)
    Changes the view of this position (yaw/pitch).
    Pos
    withView(Pos pos)
    Changes the view to match the provided position.
    Pos
    withX(double x)
    Creates a point with the specified X coordinate.
    Pos
    withX(DoubleUnaryOperator operator)
    Creates a point with a modified X coordinate based on its value.
    Pos
    withY(double y)
    Creates a point with the specified Y coordinate.
    Pos
    withY(DoubleUnaryOperator operator)
    Creates a point with a modified Y coordinate based on its value.
    Pos
    withYaw(float yaw)
    Changes the yaw of this position.
    Pos
    withYaw(DoubleUnaryOperator operator)
    Applies an operator to the yaw of this position.
    Pos
    withZ(double z)
    Creates a point with the specified Z coordinate.
    Pos
    withZ(DoubleUnaryOperator operator)
    Creates a point with a modified Z coordinate based on its value.
    double
    x()
    Returns the value of the x record component.
    double
    y()
    Returns the value of the y record component.
    float
    yaw()
    Returns the value of the yaw record component.
    double
    z()
    Returns the value of the z record component.

    Methods inherited from class Object

    clone, finalize, getClass, notify, notifyAll, wait, wait, wait

    Methods inherited from interface Point

    angle, asBlockVec, asVec, blockX, blockY, blockZ, chunkX, chunkZ, distance, distance, distanceSquared, distanceSquared, dot, isNormalized, isZero, length, lengthSquared, regionX, regionZ, sameBlock, sameBlock, sameChunk, samePoint, samePoint, samePoint, samePoint, section, sectionX, sectionY, sectionZ, similarPoint, similarPoint

  • Field Details

    • ZERO

      public static final Pos ZERO

    • VIEW_EPSILON

      public static final float VIEW_EPSILON
      The epsilon used to compare two views (yaw/pitch) if applicable.
      See Also:

  • Constructor Details

    • Pos

      public Pos(double x, double y, double z, float yaw, float pitch)
      Creates an instance of a Pos record class.
      Parameters:
      x - the value for the x record component
      y - the value for the y record component
      z - the value for the z record component
      yaw - the value for the yaw record component
      pitch - the value for the pitch record component

    • Pos

      public Pos(double x, double y, double z)
      Creates a position with the given coordinates (x/y/z) and default view (yaw/pitch = 0).
      Parameters:
      x - the X coordinate
      y - the Y coordinate
      z - the Z coordinate

    • Pos

      @Deprecated public Pos(Point point, float yaw, float pitch)
      Deprecated.
      Use Point.asPos() instead with withView(float, float)
      Creates a position from a point with the given view (yaw/pitch).
      Parameters:
      point - the point containing the coordinates (x/y/z)
      yaw - the yaw
      pitch - the pitch

    • Pos

      @Deprecated public Pos(Point point)
      Deprecated.
      Use Point.asPos() instead
      Creates a position from a point with the default view (yaw/pitch = 0).
      Parameters:
      point - the point containing the coordinates (x/y/z)

  • Method Details

    • fromPoint

      @Deprecated(forRemoval=true) public static Pos fromPoint(Point point)
      Deprecated, for removal: This API element is subject to removal in a future version.
      use Point.asPos() instead
      Converts a Point into a Pos. Will cast if possible, or instantiate a new object.
      Parameters:
      point - the point to convert
      Returns:
      the converted position

    • fixPitch

      public static float fixPitch(float pitch)
      Fixes a pitch value that is not between -90.0f and 90.0f So for example, -135.0f becomes -90.0f and 225.0f becomes 90.0f
      Parameters:
      pitch - The possible "wrong" pitch
      Returns:
      a fixed pitch in the range [-90.0f, 90.0f]

    • fixYaw

      public static float fixYaw(float yaw)
      Fixes a yaw value that is not between -180.0f (exclusive) and 180.0f (inclusive). Wraps the yaw to the nearest equivalent angle in this range. For example, -1355.0f becomes 85.0f and 225.0f becomes -135.0f.
      Parameters:
      yaw - The possible "wrong" yaw
      Returns:
      a fixed yaw in the range (-180.0f, 180.0f]

    • withCoord

      @Contract(pure=true) public Pos withCoord(double x, double y, double z)
      Changes the 3 coordinates of this position (x/y/z).
      Parameters:
      x - the X coordinate
      y - the Y coordinate
      z - the Z coordinate
      Returns:
      a new position

    • withCoord

      @Contract(pure=true) public Pos withCoord(Point point)
      Changes the coordinates to match the provided point.
      Parameters:
      point - the point to use for coordinates (x/y/z)
      Returns:
      a new position

    • withView

      @Contract(pure=true) public Pos withView(float yaw, float pitch)
      Changes the view of this position (yaw/pitch).
      Parameters:
      yaw - the yaw
      pitch - the pitch
      Returns:
      a new position

    • withView

      @Contract(pure=true) public Pos withView(Pos pos)
      Changes the view to match the provided position.
      Parameters:
      pos - the position to use for the view (yaw/pitch)
      Returns:
      a new position

    • withDirection

      @Contract(pure=true, value="_ -> new") public Pos withDirection(Point point)
      Sets the yaw and pitch to point in the direction of the point.
      Parameters:
      point - the point to look at
      Returns:
      a new position

    • withYaw

      @Contract(pure=true) public Pos withYaw(float yaw)
      Changes the yaw of this position.
      Parameters:
      yaw - the new yaw
      Returns:
      a new position

    • withYaw

      @Contract(pure=true) public Pos withYaw(DoubleUnaryOperator operator)
      Applies an operator to the yaw of this position.
      Parameters:
      operator - the operator to apply to the yaw
      Returns:
      a new position

    • withPitch

      @Contract(pure=true) public Pos withPitch(float pitch)
      Changes the pitch of this position.
      Parameters:
      pitch - the new pitch
      Returns:
      a new position

    • withLookAt

      @Contract(pure=true) public Pos withLookAt(Point point)
      Changes the view to look at a specific point.
      Parameters:
      point - the point to look at
      Returns:
      a new position

    • withPitch

      @Contract(pure=true) public Pos withPitch(DoubleUnaryOperator operator)
      Applies an operator to the pitch of this position.
      Parameters:
      operator - the operator to apply to the pitch
      Returns:
      a new position

    • sameView

      public boolean sameView(Pos position)
      Checks if two positions have a similar view (yaw/pitch).
      Parameters:
      position - the position to compare
      Returns:
      true if the two positions have the same view

    • sameView

      public boolean sameView(float yaw, float pitch)
      Checks if the yaw and pitch are the same as the given ones.
      Parameters:
      yaw - the yaw
      pitch - the pitch
      Returns:
      true if the yaw and pitch are the same

    • similarView

      public boolean similarView(float yaw, float pitch, float epsilon)
      Checks if the yaw and pitch are approximately the same as the given ones.
      Parameters:
      yaw - the yaw
      pitch - the pitch
      epsilon - the maximum difference to consider the values equal
      Returns:
      true if the yaw and pitch are approximately the same

    • similarView

      public boolean similarView(Pos position, float epsilon)
      Checks if two positions have approximately similar views (yaw/pitch).
      Parameters:
      position - the position to compare
      epsilon - the maximum difference to consider the values equal
      Returns:
      true if the two positions have a similar view

    • similarView

      public boolean similarView(Pos position)
      Checks if two positions have approximately similar views (yaw/pitch).

      Uses VIEW_EPSILON as epsilon.

      Parameters:
      position - the position to compare
      Returns:
      true if the two positions have a similar view

    • similarView

      public boolean similarView(float yaw, float pitch)
      Checks if the yaw and pitch are approximately the same as the given ones.

      Uses VIEW_EPSILON as epsilon.

      Parameters:
      yaw - the yaw
      pitch - the pitch
      Returns:
      true if the yaw and pitch are approximately the same

    • direction

      public Vec direction()
      Gets a unit-vector pointing in the direction that this Location is facing.
      Returns:
      a vector pointing the direction of this location's pitch and yaw

    • facing

      public Direction facing()
      Gets the closest direction yaw() and pitch() are facing to.
      Returns:
      the direction this position is facing

    • apply

      public Pos apply(Pos.Operator operator)
      Returns a new position based on this position fields.
      Parameters:
      operator - the operator deconstructing this object and providing a new position
      Returns:
      the new position

    • withX

      @Contract("_ -> new") public Pos withX(DoubleUnaryOperator operator)
      Description copied from interface: Point
      Creates a point with a modified X coordinate based on its value.
      Specified by:
      withX in interface Point
      Parameters:
      operator - the operator providing the current X coordinate and returning the new
      Returns:
      a new point

    • withX

      @Contract(pure=true, value="_ -> new") public Pos withX(double x)
      Description copied from interface: Point
      Creates a point with the specified X coordinate.
      Specified by:
      withX in interface Point
      Parameters:
      x - the new X coordinate
      Returns:
      a new point

    • withY

      @Contract("_ -> new") public Pos withY(DoubleUnaryOperator operator)
      Description copied from interface: Point
      Creates a point with a modified Y coordinate based on its value.
      Specified by:
      withY in interface Point
      Parameters:
      operator - the operator providing the current Y coordinate and returning the new
      Returns:
      a new point

    • withY

      @Contract(pure=true, value="_ -> new") public Pos withY(double y)
      Description copied from interface: Point
      Creates a point with the specified Y coordinate.
      Specified by:
      withY in interface Point
      Parameters:
      y - the new Y coordinate
      Returns:
      a new point

    • withZ

      @Contract("_ -> new") public Pos withZ(DoubleUnaryOperator operator)
      Description copied from interface: Point
      Creates a point with a modified Z coordinate based on its value.
      Specified by:
      withZ in interface Point
      Parameters:
      operator - the operator providing the current Z coordinate and returning the new
      Returns:
      a new point

    • withZ

      @Contract(pure=true, value="_ -> new") public Pos withZ(double z)
      Description copied from interface: Point
      Creates a point with the specified Z coordinate.
      Specified by:
      withZ in interface Point
      Parameters:
      z - the new Z coordinate
      Returns:
      a new point

    • add

      @Contract(pure=true, value="_, _, _ -> new") public Pos add(double x, double y, double z)
      Description copied from interface: Point
      Creates a new point by adding the provided values to this point coordinates.
      Specified by:
      add in interface Point
      Parameters:
      x - the x to add
      y - the y to add
      z - the z to add
      Returns:
      the new point

    • add

      @Contract(pure=true, value="_ -> new") public Pos add(Point point)
      Description copied from interface: Point
      Creates a new point by adding another point coordinates to this point coordinates.
      Specified by:
      add in interface Point
      Parameters:
      point - the point decomposed by Point.x(), Point.y() and Point.z()
      Returns:
      the new point

    • add

      @Contract(pure=true, value="_ -> new") public Pos add(double value)
      Description copied from interface: Point
      Creates a new point by adding the provided value to this point coordinates for all XYZ.
      Specified by:
      add in interface Point
      Parameters:
      value - the value to add
      Returns:
      the new point

    • sub

      @Contract(pure=true, value="_, _, _ -> new") public Pos sub(double x, double y, double z)
      Description copied from interface: Point
      Creates a new point by subtracting the provided values to this point coordinates.
      Specified by:
      sub in interface Point
      Parameters:
      x - the x to subtract
      y - the y to subtract
      z - the z to subtract
      Returns:
      the new point

    • sub

      @Contract(pure=true, value="_ -> new") public Pos sub(Point point)
      Description copied from interface: Point
      Creates a new point by subtracting another point coordinates to this point coordinates.
      Specified by:
      sub in interface Point
      Parameters:
      point - the point decomposed by Point.x(), Point.y() and Point.z()
      Returns:
      the new point

    • sub

      @Contract(pure=true, value="_ -> new") public Pos sub(double value)
      Description copied from interface: Point
      Creates a new point by subtracting the provided value to this point coordinates for all XYZ.
      Specified by:
      sub in interface Point
      Parameters:
      value - the value to subtract
      Returns:
      the new point

    • mul

      @Contract(pure=true, value="_, _, _ -> new") public Pos mul(double x, double y, double z)
      Description copied from interface: Point
      Creates a new point by multiplying the provided values to this point coordinates.
      Specified by:
      mul in interface Point
      Parameters:
      x - the x to multiply
      y - the y to multiply
      z - the z to multiply
      Returns:
      the new point

    • mul

      @Contract(pure=true, value="_ -> new") public Pos mul(Point point)
      Description copied from interface: Point
      Creates a new point by multiplying another point coordinates to this point coordinates.
      Specified by:
      mul in interface Point
      Parameters:
      point - the point decomposed by Point.x(), Point.y() and Point.z()
      Returns:
      the new point

    • mul

      @Contract(pure=true, value="_ -> new") public Pos mul(double value)
      Description copied from interface: Point
      Creates a new point by multiplying the provided value to this point coordinates for all XYZ.
      Specified by:
      mul in interface Point
      Parameters:
      value - the value to multiply
      Returns:
      the new point

    • div

      @Contract(pure=true, value="_, _, _ -> new") public Pos div(double x, double y, double z)
      Description copied from interface: Point
      Creates a new point by dividing the provided values to this point coordinates.

      Warning: division by zero will not error.

      Specified by:
      div in interface Point
      Parameters:
      x - the x to divide
      y - the y to divide
      z - the z to divide
      Returns:
      the new point

    • div

      @Contract(pure=true, value="_ -> new") public Pos div(Point point)
      Description copied from interface: Point
      Creates a new point by dividing another point coordinates to this point coordinates.

      Warning: division by zero will not error.

      Specified by:
      div in interface Point
      Parameters:
      point - the point decomposed by Point.x(), Point.y() and Point.z()
      Returns:
      the new point

    • div

      @Contract(pure=true, value="_ -> new") public Pos div(double value)
      Description copied from interface: Point
      Creates a new point by dividing the provided value to this point coordinates for all XYZ.

      Warning: division by zero will not error.

      Specified by:
      div in interface Point
      Parameters:
      value - the value to divide
      Returns:
      the new point

    • relative

      @Contract(pure=true, value="_ -> new") public Pos relative(BlockFace face)
      Description copied from interface: Point
      Creates a new point relative to this point based on the provided block face.
      Specified by:
      relative in interface Point
      Parameters:
      face - the face
      Returns:
      the new point

    • asPos

      @Deprecated @Contract(pure=true, value="-> this") public Pos asPos()
      Deprecated.
      Does nothing as this is already a Pos.

      Marked as deprecated to warn against redundant usage.

      Specified by:
      asPos in interface Point
      Returns:
      this position

    • asPos

      @Deprecated @Contract(pure=true, value="_, _ -> new") public Pos asPos(float yaw, float pitch)
      Deprecated.
      Equivalent to withView(float, float) as this is already a Pos.

      Marked as deprecated to warn against redundant usage.

      Specified by:
      asPos in interface Point
      Parameters:
      yaw - the yaw
      pitch - the pitch
      Returns:
      a new position with the provided view

    • normalize

      @Contract(pure=true, value="-> new") public Pos normalize()
      Description copied from interface: Point
      Converts this point to a unit point (a point with length of 1).
      Specified by:
      normalize in interface Point
      Returns:
      the same point

    • cross

      @Contract(pure=true, value="_ -> new") public Pos cross(Point point)
      Description copied from interface: Point
      Calculates the cross product of this point with another. The cross product is defined as:
      • x = y1 * z2 - y2 * z1
      • y = z1 * x2 - z2 * x1
      • z = x1 * y2 - x2 * y1
      Specified by:
      cross in interface Point
      Parameters:
      point - the other point
      Returns:
      the cross product point

    • lerp

      @Contract(pure=true, value="_, _ -> new") public Pos lerp(Point point, double alpha)
      Description copied from interface: Point
      Calculates a linear interpolation between this point with another point (x/y/z).
      Specified by:
      lerp in interface Point
      Parameters:
      point - the other point
      alpha - The alpha value, must be between 0.0 and 1.0
      Returns:
      Linear interpolated point

    • lerpView

      @Contract(pure=true, value="_, _ -> new") public Pos lerpView(Pos pos, float alpha)
      Calculates a linear interpolation between this position's view and another position's view (yaw/pitch). The coordinates (x/y/z) remain unchanged.
      Parameters:
      pos - the other position
      alpha - the alpha value, must be between 0.0 and 1.0
      Returns:
      a new position with interpolated view

    • neg

      @Contract(pure=true, value="-> new") public Pos neg()
      Description copied from interface: Point
      Represents this point with all coordinates negated. For example, (x, y, z) becomes (-x, -y, -z).
      Specified by:
      neg in interface Point
      Returns:
      the negated point

    • negView

      @Contract(pure=true, value="-> new") public Pos negView()
      Negates the view (yaw/pitch) of this position.
      Returns:
      a new position

    • abs

      @Contract(pure=true, value="-> new") public Pos abs()
      Description copied from interface: Point
      Represents this point with all coordinates as their absolute values. For example, (x, y, z) becomes (|x|, |y|, |z|).
      Specified by:
      abs in interface Point
      Returns:
      the absolute point

    • absView

      @Contract(pure=true, value="-> new") public Pos absView()
      Returns the absolute value of the view (yaw/pitch).
      Returns:
      a new position

    • min

      @Contract(pure=true, value="_ -> new") public Pos min(Point point)
      Description copied from interface: Point
      Gets a point representing the minimum values between this point and the provided one (x/y/z).
      Specified by:
      min in interface Point
      Parameters:
      point - the other point
      Returns:
      the minimum point

    • min

      @Contract(pure=true, value="_, _, _ -> new") public Pos min(double x, double y, double z)
      Description copied from interface: Point
      Gets a point representing the minimum values between this point and the provided coordinates (x/y/z).
      Specified by:
      min in interface Point
      Parameters:
      x - the x coordinate
      y - the y coordinate
      z - the z coordinate
      Returns:
      the minimum point

    • min

      @Contract(pure=true, value="_ -> new") public Pos min(double value)
      Description copied from interface: Point
      Gets a point representing the minimum values between this point and the provided value for all coordinates.
      Specified by:
      min in interface Point
      Parameters:
      value - the value
      Returns:
      the minimum point

    • max

      @Contract(pure=true, value="_ -> new") public Pos max(Point point)
      Description copied from interface: Point
      Gets a point representing the maximum values between this point and the provided one (x/y/z).
      Specified by:
      max in interface Point
      Parameters:
      point - the other point
      Returns:
      the maximum point

    • max

      @Contract(pure=true, value="_, _, _ -> new") public Pos max(double x, double y, double z)
      Description copied from interface: Point
      Gets a point representing the maximum values between this point and the provided coordinates (x/y/z).
      Specified by:
      max in interface Point
      Parameters:
      x - the x coordinate
      y - the y coordinate
      z - the z coordinate
      Returns:
      the maximum point

    • max

      @Contract(pure=true, value="_ -> new") public Pos max(double value)
      Description copied from interface: Point
      Gets a point representing the maximum values between this point and the provided value for all coordinates.
      Specified by:
      max in interface Point
      Parameters:
      value - the value
      Returns:
      the maximum point

    • toString

      public final String toString()
      Returns a string representation of this record class. The representation contains the name of the class, followed by the name and value of each of the record components.
      Specified by:
      toString in class Record
      Returns:
      a string representation of this object

    • hashCode

      public final int hashCode()
      Returns a hash code value for this object. The value is derived from the hash code of each of the record components.
      Specified by:
      hashCode in class Record
      Returns:
      a hash code value for this object

    • equals

      public final boolean equals(Object o)
      Indicates whether some other object is "equal to" this one. The objects are equal if the other object is of the same class and if all the record components are equal. All components in this record class are compared with the compare method from their corresponding wrapper classes.
      Specified by:
      equals in class Record
      Parameters:
      o - the object with which to compare
      Returns:
      true if this object is the same as the o argument; false otherwise.

    • x

      public double x()
      Returns the value of the x record component.
      Specified by:
      x in interface Point
      Returns:
      the value of the x record component

    • y

      public double y()
      Returns the value of the y record component.
      Specified by:
      y in interface Point
      Returns:
      the value of the y record component

    • z

      public double z()
      Returns the value of the z record component.
      Specified by:
      z in interface Point
      Returns:
      the value of the z record component

    • yaw

      public float yaw()
      Returns the value of the yaw record component.
      Returns:
      the value of the yaw record component

    • pitch

      public float pitch()
      Returns the value of the pitch record component.
      Returns:
      the value of the pitch record component