Package nl.colorize.multimedialib.math

Record Class Point3D

java.lang.Object
java.lang.Record
nl.colorize.multimedialib.math.Point3D
public record Point3D(float x, float y, float z) extends Record
Describes a point with X, Y, and Z coordinates within a three-dimensional space. Point coordinates have float precision, and point instances are immutable.

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    static final Point3D
    ORIGIN
     

  • Constructor Summary

    Constructors
    Constructor
    Description
    Point3D(float x, float y, float z)
    Creates an instance of a Point3D record class.

  • Method Summary

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

    Methods inherited from class java.lang.Object

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

  • Field Details

    • ORIGIN

      public static final Point3D ORIGIN

  • Constructor Details

    • Point3D

      public Point3D(float x, float y, float z)
      Creates an instance of a Point3D 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

  • Method Details

    • isOrigin

      public boolean isOrigin()

    • normalize

      public Point3D normalize()

    • toString

      public 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 float x()
      Returns the value of the x record component.
      Returns:
      the value of the x record component

    • y

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

    • z

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