Package net.xun.lib.common.api.misc.color

Record Class HSVColor

java.lang.Object
java.lang.Record
net.xun.lib.common.api.misc.color.HSVColor
All Implemented Interfaces:
IColorBase
public record HSVColor(float hue, float saturation, float value) extends Record implements IColorBase
Represents a color in the HSV (Hue, Saturation, Value) color space.

  • Constructor Summary

    Constructors
    Constructor
    Description
    HSVColor(float hue, float saturation, float value)
    Constructs an HSVColor with the specified hue, saturation, and lightness.

  • Method Summary

    Modifier and Type
    Method
    Description
    String
    asHex()
     
    RGBColor
    asRGB()
     
    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.
    float
    hue()
    Returns the value of the hue record component.
    float
    saturation()
    Returns the value of the saturation record component.
    final String
    toString()
    Returns a string representation of this record class.
    float
    value()
    Returns the value of the value record component.

    Methods inherited from class java.lang.Object

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

    Methods inherited from interface net.xun.lib.common.api.misc.color.IColorBase

    asHSL, asHSV

  • Constructor Details

    • HSVColor

      public HSVColor(float hue, float saturation, float value)
      Constructs an HSVColor with the specified hue, saturation, and lightness.
      Parameters:
      hue - the hue component (0-360 degrees)
      saturation - the saturation component (0-1)
      value - the lightness component (0-1)
      Throws:
      InvalidColorFormatException - if hue, saturation, or lightness are out of range

  • Method Details

    • asRGB

      public RGBColor asRGB()
      Specified by:
      asRGB in interface IColorBase

    • asHex

      public String asHex()
      Specified by:
      asHex in interface IColorBase

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

    • hue

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

    • saturation

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

    • value

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