field.kit.colour

Colour

class Colour extends Logger

A versatile RGBA Colour utility, used as datatype and for conversion

go to: companion
    authors:

  1. Marcus Wendt

Inherited

  1. Hide All
  2. Show all
  1. Logger
  2. AnyRef
  3. Any

Visibility

  1. Public
  2. All

Instance constructors

  1. new Colour()

  2. new Colour(r: Float, g: Float, b: Float, a: Float)

Value Members

  1. def !=(arg0: AnyRef): Boolean

    attributes: final
    definition classes: AnyRef

  2. def !=(arg0: Any): Boolean

    o != arg0 is the same as !(o == (arg0)).

    o != arg0 is the same as !(o == (arg0)).

    arg0

    the object to compare against this object for dis-equality .

    returns

    false if the receiver object is equivalent to the argument; true otherwise.

    attributes: final
    definition classes: Any

  3. def ##(): Int

    attributes: final
    definition classes: AnyRef → Any

  4. def $asInstanceOf[T0](): T0

    attributes: final
    definition classes: AnyRef

  5. def $isInstanceOf[T0](): Boolean

    attributes: final
    definition classes: AnyRef

  6. def *=(r: Float, g: Float, b: Float, a: Float): Colour

  7. def +=(r: Float, g: Float, b: Float, a: Float): Colour

  8. def -=(r: Float, g: Float, b: Float, a: Float): Colour

  9. def /=(r: Float, g: Float, b: Float, a: Float): Colour

  10. def :=(s: String): Colour

    Attempts to interpret this String to set this Colours components

    Attempts to interpret this String to set this Colours components

    returns

    itself

    attributes: final

  11. def :=(i: Int): Colour

    Sets this Colour using an Integer which is interpreted as: a) as single [0,256] grey value b) as packed integer given as hex number

    Sets this Colour using an Integer which is interpreted as: a) as single [0,256] grey value b) as packed integer given as hex number

    returns

    itself

    attributes: final

  12. def :=(r: Float, g: Float, b: Float, a: Float): Colour

    Sets all components of this Colour individually

    Sets all components of this Colour individually

    returns

    itself

    attributes: final

  13. def :=(r: Float, g: Float, b: Float): Colour

    Sets only the rgb components of this Colour

    Sets only the rgb components of this Colour

    returns

    itself

    attributes: final

  14. def :=(grey: Float, a: Float): Colour

    Sets the r,g,b components of this Colour to the given Float and the alpha seperately

    Sets the r,g,b components of this Colour to the given Float and the alpha seperately

    returns

    itself

    attributes: final

  15. def :=(grey: Float): Colour

    Sets the r,g,b components of this Colour to the given Float and the alpha seperately

    Sets the r,g,b components of this Colour to the given Float and the alpha seperately

    returns

    itself

    attributes: final

  16. def :=(c: Colour): Colour

    Sets this Colour components to the given Colour

    Sets this Colour components to the given Colour

    returns

    itself

    attributes: final

  17. def ==(arg0: AnyRef): Boolean

    o == arg0 is the same as if (o eq null) arg0 eq null else o.equals(arg0).

    o == arg0 is the same as if (o eq null) arg0 eq null else o.equals(arg0).

    arg0

    the object to compare against this object for equality .

    returns

    true if the receiver object is equivalent to the argument; false otherwise.

    attributes: final
    definition classes: AnyRef

  18. def ==(arg0: Any): Boolean

    o == arg0 is the same as o.equals(arg0).

    o == arg0 is the same as o.equals(arg0).

    arg0

    the object to compare against this object for equality .

    returns

    true if the receiver object is equivalent to the argument; false otherwise.

    attributes: final
    definition classes: Any

  19. var a: Float

  20. def alpha: Float

    attributes: final

  21. def alpha_=(s: Float): Unit

    attributes: final

  22. def asInstanceOf[T0]: T0

    This method is used to cast the receiver object to be of type T0.

    This method is used to cast the receiver object to be of type T0.

    Note that the success of a cast at runtime is modulo Scala's erasure semantics. Therefore the expression1.asInstanceOf[String] will throw a ClassCastException at runtime, while the expressionList(1).asInstanceOf[List[String]] will not. In the latter example, because the type argument is erased as part of compilation it is not possible to check whether the contents of the list are of the requested typed.

    returns

    the receiver object .

    attributes: final
    definition classes: Any

  23. var b: Float

  24. def blue: Float

    attributes: final

  25. def blue_=(s: Float): Colour

    attributes: final

  26. def brighten(amount: Float): Colour

    attributes: final

  27. def clone(): AnyRef

    This method creates and returns a copy of the receiver object .

    This method creates and returns a copy of the receiver object .

    The default implementation of the clone method is platform dependent.

    returns

    a copy of the receiver object .

    attributes: protected
    definition classes: AnyRef

  28. def darken(amount: Float): Colour

    attributes: final

  29. def desaturate(amount: Float): Colour

    attributes: final

  30. def eq(arg0: AnyRef): Boolean

    This method is used to test whether the argument (arg0) is a reference to the receiver object (this).

    This method is used to test whether the argument (arg0) is a reference to the receiver object (this).

    The eq method implements an [http://en.wikipedia.org/wiki/Equivalence_relation equivalence relation] on non-null instances of AnyRef: * It is reflexive: for any non-null instance x of type AnyRef, x.eq(x) returns true. * It is symmetric: for any non-null instances x and y of type AnyRef, x.eq(y) returns true if and only if y.eq(x) returns true. * It is transitive: for any non-null instances x, y, and z of type AnyRef if x.eq(y) returns true and y.eq(z) returns true, then x.eq(z) returns true.

    Additionally, the eq method has three other properties. * It is consistent: for any non-null instances x and y of type AnyRef, multiple invocations of x.eq(y) consistently returns true or consistently returns false. * For any non-null instance x of type AnyRef, x.eq(null) and null.eq(x) returns false. * null.eq(null) returns true.

    When overriding the equals or hashCode methods, it is important to ensure that their behavior is consistent with reference equality. Therefore, if two objects are references to each other (o1 eq o2), they should be equal to each other (o1 == o2) and they should hash to the same value (o1.hashCode == o2.hashCode).

    arg0

    the object to compare against this object for reference equality .

    returns

    true if the argument is a reference to the receiver object; false otherwise.

    attributes: final
    definition classes: AnyRef

  31. def equals(arg0: Any): Boolean

    This method is used to compare the receiver object (this) with the argument object (arg0) for equivalence.

    This method is used to compare the receiver object (this) with the argument object (arg0) for equivalence.

    The default implementations of this method is an [http://en.wikipedia.org/wiki/Equivalence_relation equivalence relation]: * It is reflexive: for any instance x of type Any, x.equals(x) should return true. * It is symmetric: for any instances x and y of type Any, x.equals(y) should return true if and only if y.equals(x) returns true. * It is transitive: for any instances x, y, and z of type AnyRef if x.equals(y) returns true and y.equals(z) returns true, then x.equals(z) should return true.

    If you override this method, you should verify that your implementation remains an equivalence relation. Additionally, when overriding this method it is often necessary to override hashCode to ensure that objects that are "equal" (o1.equals(o2) returns true) hash to the same scala.Int (o1.hashCode.equals(o2.hashCode)).

    arg0

    the object to compare against this object for equality .

    returns

    true if the receiver object is equivalent to the argument; false otherwise.

    definition classes: AnyRef → Any

  32. def error(m: Any*): Unit

    definition classes: Logger

  33. def fatal(code: Int, m: Any*): Unit

    definition classes: Logger

  34. def fatal(m: Any*): Unit

    definition classes: Logger

  35. def finalize(): Unit

    This method is called by the garbage collector on the receiver object when garbage collection determines that there are no more references to the object .

    This method is called by the garbage collector on the receiver object when garbage collection determines that there are no more references to the object .

    The details of when and if the finalize method are invoked, as well as the interaction between finalizeand non-local returns and exceptions, are all platform dependent.

    attributes: protected
    definition classes: AnyRef

  36. def fine(m: Any*): Unit

    definition classes: Logger

  37. def fromARGB(i: Int): Colour

    attributes: final

  38. def fromRGB(i: Int): Colour

    attributes: final

  39. def fromRGBA(i: Int): Colour

    attributes: final

  40. var g: Float

  41. def getClass(): java.lang.Class[_]

    Returns a representation that corresponds to the dynamic class of the receiver object .

    Returns a representation that corresponds to the dynamic class of the receiver object .

    The nature of the representation is platform dependent.

    returns

    a representation that corresponds to the dynamic class of the receiver object .

    attributes: final
    definition classes: AnyRef

  42. def green: Float

    attributes: final

  43. def green_=(s: Float): Colour

    attributes: final

  44. var h: Float

    attributes: protected

  45. def hashCode(): Int

    Returns a hash code value for the object .

    Returns a hash code value for the object .

    The default hashing algorithm is platform dependent.

    Note that it is allowed for two objects to have identical hash codes (o1.hashCode.equals(o2.hashCode)) yet not be equal (o1.equals(o2) returns false). A degenerate implementation could always return 0. However, it is required that if two objects are equal (o1.equals(o2) returns true) that they have identical hash codes (o1.hashCode.equals(o2.hashCode)). Therefore, when overriding this method, be sure to verify that the behavior is consistent with the equals method.

    returns

    the hash code value for the object .

    definition classes: AnyRef → Any

  46. def hue: Float

    attributes: final

  47. def hue_=(theta: Float): Colour

    attributes: final

  48. def info(m: Any*): Unit

    definition classes: Logger

  49. def interpolate(target: Colour, delta: Float): Colour

    attributes: final

  50. def invert: Colour

    attributes: final

  51. def isInstanceOf[T0]: Boolean

    This method is used to test whether the dynamic type of the receiver object is T0.

    This method is used to test whether the dynamic type of the receiver object is T0.

    Note that the test result of the test is modulo Scala's erasure semantics. Therefore the expression1.isInstanceOf[String] will return false, while the expression List(1).isInstanceOf[List[String]] will return true. In the latter example, because the type argument is erased as part of compilation it is not possible to check whether the contents of the list are of the requested typed.

    returns

    true if the receiver object is an instance of erasure of type T0; false otherwise.

    attributes: final
    definition classes: Any

  52. def logName: String

    definition classes: Logger

  53. def logName_=(name: String): Unit

    definition classes: Logger

  54. def luminance: Float

    attributes: final

  55. def ne(arg0: AnyRef): Boolean

    o.ne(arg0) is the same as !(o.eq(arg0)).

    o.ne(arg0) is the same as !(o.eq(arg0)).

    arg0

    the object to compare against this object for reference dis-equality .

    returns

    false if the argument is not a reference to the receiver object; true otherwise.

    attributes: final
    definition classes: AnyRef

  56. def notify(): Unit

    Wakes up a single thread that is waiting on the receiver object's monitor .

    Wakes up a single thread that is waiting on the receiver object's monitor .

    attributes: final
    definition classes: AnyRef

  57. def notifyAll(): Unit

    Wakes up all threads that are waiting on the receiver object's monitor .

    Wakes up all threads that are waiting on the receiver object's monitor .

    attributes: final
    definition classes: AnyRef

  58. var r: Float

  59. def randomise: Colour

    attributes: final

  60. def red: Float

    attributes: final

  61. def red_=(s: Float): Colour

    attributes: final

  62. var s: Float

    attributes: protected

  63. def saturate(amount: Float): Colour

    attributes: final

  64. def saturation: Float

    attributes: final

  65. def saturation_=(theta: Float): Colour

    attributes: final

  66. def setHSV(h: Float, s: Float, v: Float): Colour

    attributes: final

  67. def setRGB(r: Float, g: Float, b: Float): Colour

    Sets the rgb values and internally updates the hsv as well

    Sets the rgb values and internally updates the hsv as well

    attributes: final

  68. def shiftHue(amount: Float): Colour

    attributes: final

  69. def shiftSaturation(amount: Float): Colour

    attributes: final

  70. def shiftValue(amount: Float): Colour

    attributes: final

  71. def synchronized[T0](arg0: T0): T0

    attributes: final
    definition classes: AnyRef

  72. def toARGB: Int

    no summary matey

    returns

    this colour as argb packed integer

    attributes: final

  73. def toHSVA: HSVA

    attributes: final

  74. def toInt: Int

    attributes: final

  75. def toLabel: String

  76. def toRGB: Int

    no summary matey

    returns

    this colour as rgb packed integer

    attributes: final

  77. def toRGBA: Int

    no summary matey

    returns

    this colour as rgba packed integer

    attributes: final

  78. def toString(): String

    Returns a string representation of the object .

    Returns a string representation of the object .

    The default representation is platform dependent.

    returns

    a string representation of the object .

    definition classes: Colour → AnyRef → Any

  79. var v: Float

    attributes: protected

  80. def value: Float

    attributes: final

  81. def value_=(theta: Float): Colour

    attributes: final

  82. def wait(): Unit

    attributes: final
    definition classes: AnyRef

  83. def wait(arg0: Long, arg1: Int): Unit

    attributes: final
    definition classes: AnyRef

  84. def wait(arg0: Long): Unit

    attributes: final
    definition classes: AnyRef

  85. def warn(m: Any*): Unit

    definition classes: Logger