Record Class MeshPoint

java.lang.Object
java.lang.Record
io.github.toxicity188.javamesh.MeshPoint
Record Components:
position - mesh-space vertex position
uv - texture coordinates used for tint sampling

public record MeshPoint(@NotNull org.joml.Vector3f position, @NotNull org.joml.Vector2f uv) extends Record
Vertex data for a mesh polygon, including model-space position and texture UV coordinates.

 MeshPoint point = new MeshPoint(new Vector3f(0.0f, 1.0f, 0.0f), new Vector2f(0.5f, 1.0f));
 
Since:
0.0.1
  • Constructor Summary

    Constructors
    Constructor
    Description
    MeshPoint(@NotNull org.joml.Vector3f position)
    Creates a point with zero UV coordinates.
    MeshPoint(@NotNull org.joml.Vector3f position, @NotNull org.joml.Vector2f uv)
    Creates an instance of a MeshPoint record class.
  • Method Summary

    Modifier and Type
    Method
    Description
    final boolean
    Indicates whether some other object is "equal to" this one.
    final int
    Returns a hash code value for this object.
    @NotNull org.joml.Vector3f
    Returns the value of the position record component.
    final String
    Returns a string representation of this record class.
    @NotNull org.joml.Vector2f
    uv()
    Returns the value of the uv record component.

    Methods inherited from class java.lang.Object

    clone, finalize, getClass, notify, notifyAll, wait, wait, wait
  • Constructor Details

    • MeshPoint

      public MeshPoint(@NotNull @NotNull org.joml.Vector3f position)
      Creates a point with zero UV coordinates.
      Parameters:
      position - mesh-space vertex position
      Throws:
      NullPointerException - if position is null
      Since:
      0.0.1
    • MeshPoint

      public MeshPoint(@NotNull @NotNull org.joml.Vector3f position, @NotNull @NotNull org.joml.Vector2f uv)
      Creates an instance of a MeshPoint record class.
      Parameters:
      position - the value for the position record component
      uv - the value for the uv record component
  • 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 Objects::equals(Object,Object).
      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.
    • position

      @NotNull public @NotNull org.joml.Vector3f position()
      Returns the value of the position record component.
      Returns:
      the value of the position record component
    • uv

      @NotNull public @NotNull org.joml.Vector2f uv()
      Returns the value of the uv record component.
      Returns:
      the value of the uv record component