Package dev.prozilla.pine.common.system

Class Color

java.lang.Object
dev.prozilla.pine.common.system.Color
All Implemented Interfaces:
Cloneable<Color>, Printable, Transceivable<Color>, Transmittable<Color>
Direct Known Subclasses:
Colour
public class Color extends Object implements Printable, Cloneable<Color>, Transceivable<Color>
Represents an RGBA color.

  • Constructor Details

    • Color

      public Color()
      The default color is black.

    • Color

      public Color(Color color)
      Creates an RGB-Color from a java.awt.Color instance.
      Parameters:
      color - Color instance

    • Color

      public Color(float red, float green, float blue)
      Creates an RGB-Color with an alpha value of 1.
      Parameters:
      red - The red component. Range from 0f to 1f.
      green - The green component. Range from 0f to 1f.
      blue - The blue component. Range from 0f to 1f.

    • Color

      public Color(float red, float green, float blue, float alpha)
      Creates an RGBA-Color.
      Parameters:
      red - The red component. Range from 0f to 1f.
      green - The green component. Range from 0f to 1f.
      blue - The blue component. Range from 0f to 1f.
      alpha - The transparency. Range from 0f to 1f.

    • Color

      public Color(int red, int green, int blue)
      Creates an RGB-Color with an alpha value of 1.
      Parameters:
      red - The red component. Range from 0 to 255.
      green - The green component. Range from 0 to 255.
      blue - The blue component. Range from 0 to 255.

    • Color

      public Color(int red, int green, int blue, int alpha)
      Creates an RGBA-Color.
      Parameters:
      red - The red component. Range from 0 to 255.
      green - The green component. Range from 0 to 255.
      blue - The blue component. Range from 0 to 255.
      alpha - The transparency. Range from 0 to 255.

  • Method Details

    • transmit

      public void transmit(Color target)
      Description copied from interface: Transmittable
      Transmits this object's data to a given target object.
      Specified by:
      transmit in interface Transmittable<Color>
      Parameters:
      target - the target object to which data will be transmitted

    • setRGB

      public Color setRGB(Color color)

    • set

      public Color set(int red, int green, int blue, int alpha)

    • set

      public Color set(float red, float green, float blue, float alpha)

    • setRGB

      public Color setRGB(int red, int green, int blue)

    • setRGB

      public Color setRGB(float red, float green, float blue)

    • getRed

      public float getRed()
      Returns the red component. Range from 0f to 1f.
      Returns:
      The red component.

    • setRed

      public Color setRed(float red)
      Sets the red component.
      Parameters:
      red - The red component. Range from 0f to 1f.

    • setRed

      public Color setRed(int red)
      Sets the red component.
      Parameters:
      red - The red component. Range from 0 to 255.

    • getGreen

      public float getGreen()
      Returns the green component. Range from 0f to 1f.
      Returns:
      The green component.

    • setGreen

      public Color setGreen(float green)
      Sets the green component.
      Parameters:
      green - The green component. Range from 0f to 1f.

    • setGreen

      public Color setGreen(int green)
      Sets the green component.
      Parameters:
      green - The green component. Range from 0 to 255.

    • getBlue

      public float getBlue()
      Returns the blue component. Range from 0f to 1f.
      Returns:
      The blue component.

    • setBlue

      public Color setBlue(float blue)
      Sets the blue component.
      Parameters:
      blue - The blue component. Range from 0f to 1f.

    • setBlue

      public Color setBlue(int blue)
      Sets the blue component.
      Parameters:
      blue - The blue component. Range from 0 to 255.

    • getAlpha

      public float getAlpha()
      Returns the transparency. Range from 0f to 1f.
      Returns:
      The transparency.

    • setAlpha

      public Color setAlpha(float alpha)
      Sets the transparency.
      Parameters:
      alpha - The transparency. Range from 0f to 1f.

    • setAlpha

      public Color setAlpha(int alpha)
      Sets the transparency.
      Parameters:
      alpha - The transparency. Range from 0 to 255.

    • multiply

      public Color multiply(float scalar)

    • mix

      public Color mix(Color color)
      Mixes half of this color with half of another color.
      Parameters:
      color - Color to mix with this color

    • mix

      public Color mix(Color color, float factor)
      Mixes this color with another color based on a factor.
      Parameters:
      color - Color to mix with this color
      factor - Mixing factor, Range from 0f to 1f.

    • toVector3f

      public Vector3f toVector3f()
      Returns the color as a (x,y,z)-Vector.
      Returns:
      The color as vec3.

    • toVector4f

      public Vector4f toVector4f()
      Returns the color as a (x,y,z,w)-Vector.
      Returns:
      The color as vec4.

    • toColour

      public Colour toColour()

    • self

      public Color self()
      Specified by:
      self in interface Transceivable<Color>

    • equals

      public boolean equals(Object object)
      Overrides:
      equals in class Object

    • equals

      public boolean equals(Color color)
      Checks if two colors are equal. Two colors are equal if they share the same R, G, B and A values.
      Specified by:
      equals in interface Cloneable<Color>
      Parameters:
      color - Color to compare with
      Returns:
      true if both objects are equal.

    • hashCode

      public int hashCode()
      Overrides:
      hashCode in class Object

    • clone

      public Color clone()
      Description copied from interface: Cloneable
      Returns a new object that is equal to this object.
      Specified by:
      clone in interface Cloneable<Color>
      Overrides:
      clone in class Object
      Returns:
      Clone of this object

    • toString

      public String toString()
      Description copied from interface: Printable
      Returns a string representation of this object.
      Specified by:
      toString in interface Printable
      Overrides:
      toString in class Object
      Returns:
      String representation of this object.

    • hsl

      public static Color hsl(int hue, int saturation, int lightness)

    • hsl

      public static Color hsl(float hue, float saturation, float lightness)
      Source: HSL to RGB color conversion

    • decode

      public static Color decode(String input) throws NumberFormatException
      Decodes a String into a Color. Supports octal and hexadecimal number representations of opaque and transparent colors.
      Parameters:
      input - String that represents a color as a 24-bit or 32-bit integer
      Returns:
      Color
      Throws:
      NumberFormatException - If the string cannot be decoded.

    • parse

      @Deprecated public static Color parse(String input)
      Deprecated.
      Replaced by ColorParser as of 1.2.0

    • white

      public static Color white()

    • black

      public static Color black()

    • red

      public static Color red()

    • green

      public static Color green()

    • blue

      public static Color blue()

    • transparent

      public static Color transparent()

    • aqua

      public static Color aqua()

    • cyan

      public static Color cyan()

    • darkBlue

      public static Color darkBlue()

    • darkCyan

      public static Color darkCyan()

    • darkGray

      public static Color darkGray()

    • darkGreen

      public static Color darkGreen()

    • darkMagenta

      public static Color darkMagenta()

    • darkOrange

      public static Color darkOrange()

    • darkRed

      public static Color darkRed()

    • dimGray

      public static Color dimGray()

    • gold

      public static Color gold()

    • gray

      public static Color gray()

    • lightBlue

      public static Color lightBlue()

    • lightCyan

      public static Color lightCyan()

    • lightGray

      public static Color lightGray()

    • lightGreen

      public static Color lightGreen()

    • lightYellow

      public static Color lightYellow()

    • lime

      public static Color lime()

    • magenta

      public static Color magenta()

    • maroon

      public static Color maroon()

    • mediumBlue

      public static Color mediumBlue()

    • mintCream

      public static Color mintCream()

    • olive

      public static Color olive()

    • orange

      public static Color orange()

    • orangeRed

      public static Color orangeRed()

    • pink

      public static Color pink()

    • purple

      public static Color purple()

    • rebeccaPurple

      public static Color rebeccaPurple()

    • silver

      public static Color silver()

    • skyBlue

      public static Color skyBlue()

    • springGreen

      public static Color springGreen()

    • teal

      public static Color teal()

    • tomato

      public static Color tomato()

    • turquoise

      public static Color turquoise()

    • violet

      public static Color violet()

    • whiteSmoke

      public static Color whiteSmoke()

    • yellow

      public static Color yellow()