Package dev.lukebemish.dynamicassetgenerator.api.colors.geometry

Record Class LineSegment

java.lang.Object
java.lang.Record
dev.lukebemish.dynamicassetgenerator.api.colors.geometry.LineSegment
public record LineSegment(int start, int end) extends Record
Represents a line segment between two colors. The start and end colors provided should be in RGB24 (or ARGB32) format.

  • Constructor Summary

    Constructors
    Constructor
    Description
    LineSegment(int start, int end)
    Creates an instance of a LineSegment record class.

  • Method Summary

    Modifier and Type
    Method
    Description
    double
    distanceTo(int point, ColorCoordinates coordinates)
     
    int
    end()
    Returns the value of the end record component.
    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.
    int
    start()
    Returns the value of the start record component.
    final String
    toString()
    Returns a string representation of this record class.

    Methods inherited from class java.lang.Object

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

  • Constructor Details

    • LineSegment

      public LineSegment(int start, int end)
      Creates an instance of a LineSegment record class.
      Parameters:
      start - the value for the start record component
      end - the value for the end record component

  • Method Details

    • distanceTo

      public double distanceTo(int point, ColorCoordinates coordinates)
      Returns:
      the minimum distance from the provided color to this segment, in the provided color coordinates

    • 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.

    • start

      public int start()
      Returns the value of the start record component.
      Returns:
      the value of the start record component

    • end

      public int end()
      Returns the value of the end record component.
      Returns:
      the value of the end record component