Package ke.ric.renderer.api

Record Class SceneCamera

java.lang.Object
java.lang.Record
ke.ric.renderer.api.SceneCamera
Record Components:
x - world X position in blocks
y - world Y position in blocks
z - world Z position in blocks
yawRadians - finite native yaw in radians (negated Bukkit yaw)
pitchRadians - finite pitch in radians (same sign as Bukkit pitch)
rollRadians - finite local camera roll in radians
fovRadians - finite vertical field of view, strictly between 0 and pi
public record SceneCamera(double x, double y, double z, double yawRadians, double pitchRadians, double rollRadians, double fovRadians) extends Record
Immutable camera pose in world blocks and radians. The native basis applies local roll, then pitch, then yaw. At zero yaw/pitch the camera faces +Z and screen-left is +X; positive roll rotates screen-left toward +Y. All rotations, including full rolls and inverted views, are valid. Bukkit yaw is negated before conversion to radians; Bukkit pitch retains its sign. Fluent snapshot/stream FOV and roll methods instead accept degrees.

  • Constructor Summary

    Constructors
    Constructor
    Description
    SceneCamera(double x, double y, double z, double yawRadians, double pitchRadians, double rollRadians, double fovRadians)
    Constructs a validated immutable value.

  • Method Summary

    Modifier and Type
    Method
    Description
    final boolean
    equals(Object o)
    Indicates whether some other object is "equal to" this one.
    double
    fovRadians()
    Returns the value of the fovRadians record component.
    final int
    hashCode()
    Returns a hash code value for this object.
    double
    pitchRadians()
    Returns the value of the pitchRadians record component.
    double
    rollRadians()
    Returns the value of the rollRadians record component.
    final String
    toString()
    Returns a string representation of this record class.
    double
    x()
    Returns the value of the x record component.
    double
    y()
    Returns the value of the y record component.
    double
    yawRadians()
    Returns the value of the yawRadians record component.
    double
    z()
    Returns the value of the z record component.

    Methods inherited from class java.lang.Object

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

  • Constructor Details

    • SceneCamera

      public SceneCamera(double x, double y, double z, double yawRadians, double pitchRadians, double rollRadians, double fovRadians)
      Constructs a validated immutable value.
      Throws:
      IllegalArgumentException - if a coordinate or angle is nonfinite, or FOV is invalid

  • Method Details

    • 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 '=='.
      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.
      Returns:
      the value of the x record component

    • y

      public double y()
      Returns the value of the y record component.
      Returns:
      the value of the y record component

    • z

      public double z()
      Returns the value of the z record component.
      Returns:
      the value of the z record component

    • yawRadians

      public double yawRadians()
      Returns the value of the yawRadians record component.
      Returns:
      the value of the yawRadians record component

    • pitchRadians

      public double pitchRadians()
      Returns the value of the pitchRadians record component.
      Returns:
      the value of the pitchRadians record component

    • rollRadians

      public double rollRadians()
      Returns the value of the rollRadians record component.
      Returns:
      the value of the rollRadians record component

    • fovRadians

      public double fovRadians()
      Returns the value of the fovRadians record component.
      Returns:
      the value of the fovRadians record component