SColor

java.lang.Object
- sim.graphics.SColor

All Implemented Interfaces:

SVector, SWriteable
```
public class SColor
extends java.lang.Object
implements SVector
```
La classe SColor représente une couleur à 4 composantes (r,g,b,a) rouge, vert, bleu et alpha (transparence). Cette classe est complémentaire à la classe java.awt.Color puisqu'elle pourra supporter des opérations d'addition et de multiplication par un scalaire. Cette classe permet l'initialisation de ses paramètres à partir d'un String. Cette classe permet une écriture dans un fichier de format txt à l'aide de la classe BufferedWriter.

Since:

2014-12-18

Version:

2016-03-05

Author:

Simon Vezina

See Also:

Color, BufferedWriter

Field Summary

Fields
Modifier and Type	Field and Description
`static SColor`	`BLACK` La constante BLACK correspond à la couleur noire.
`static int`	`CLAMP_CHANNEL_NORMALIZATION` La constante CLAMP_CHANNEL_NORMALIZATION correspond au code de référence pour utiliser l'algorithme de normalisation des couleurs par coupure de canal.
`static java.lang.String[]`	`COLOR_NORMALIZATION` La constante COLOR_NORMALIZATION correspond à l'ensemble des mots clés qui sont reconnus pour identifier un code de référence pour déterminer le choix de l'algorithme de normalisation des couleurs.
`static int`	`DIVISION_FACTOR_NORMALIZATION` La constante DIVISION_FACTOR_NORMALIZATION correspond au code de référence pour utiliser l'algorithme de normalisation des couleurs par facteur de division.

Constructor Summary

Constructors
Constructor and Description
`SColor()` Constructeur vide correpondant à la couleur blanche et transparence nulle (alpha = 1).
`SColor(java.awt.Color color)` Constructeur d'une couleur à partir d'une couleur de type "Color" définit à l'aide de canaux entier compris dans l'intervalle [0, 255].
`SColor(double red, double green, double blue)` Constructeur d'une couleur avec transparance nulle (complètement opaque).
`SColor(double red, double green, double blue, double alpha)` Constructeur d'une couleur avec transparence alpha.
`SColor(java.lang.String string)` Constructeur d'une couleur en utilisant un String comme paramètre fractionné dans un StringTokenizer.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`SColor`	`add(SColor c)` Méthode qui retourne l'addition de la couleur de l'objet avec une nouvelle couleur.
`SVector`	`add(SVector v)` Méthode permettant d'effectuer l'addition mathématique entre deux vecteurs.
`boolean`	`equals(java.lang.Object other)`
`double`	`getAlpha()` Méthode qui donne la transparence de la couleur.
`double`	`getBlue()` Méthode qui donne la couleur du canal blue.
`static int`	`getColorNormalization()` Méthode pour obtenir le code correspondant au type de normalisation appliquée aux couleurs dont un canal ou plus dépasse la valeur de 1.0.
`double`	`getGreen()` Méthode qui donne la couleur du canal vert.
`double`	`getRed()` Méthode qui donne la couleur du canal rouge.
`SColor`	`multiply(double m)` Méthode qui retourne le résultat de la multiplication par un scalaire de chaque canal de la couleur sauf le canal alpha restant inchangé.
`SColor`	`multiply(SColor c)` Méthode pour multiplier deux couleurs ensembles.
`SColor`	`normalize()` Méthode pour normaliser une couleur.
`java.awt.Color`	`normalizeColor()` Méthode qui retourne un objet Color convertible en format RGB [0..255].
`static void`	`setColorNormalization(int code)` Méthode pour définir le type de normalisation qui sera appliquée aux couleurs dont un canal au plus dépasse la valeur de 1.0.
`java.lang.String`	`toString()`
`void`	`write(java.io.BufferedWriter bw)` Méthode pour écrire les paramètres rgba de la couleur dans un fichier en format txt.

Methods inherited from class java.lang.Object
getClass, hashCode, notify, notifyAll, wait, wait, wait

- Field Detail
  - COLOR_NORMALIZATION
```
public static final java.lang.String[] COLOR_NORMALIZATION
```
    La constante COLOR_NORMALIZATION correspond à l'ensemble des mots clés qui sont reconnus pour identifier un code de référence pour déterminer le choix de l'algorithme de normalisation des couleurs.
  - CLAMP_CHANNEL_NORMALIZATION
```
public static final int CLAMP_CHANNEL_NORMALIZATION
```
    La constante CLAMP_CHANNEL_NORMALIZATION correspond au code de référence pour utiliser l'algorithme de normalisation des couleurs par coupure de canal. Cette approche réduit à une valeur égale à 1.0 tout canal supérieur à 1.0.
    
    See Also:
    
    Constant Field Values
  - DIVISION_FACTOR_NORMALIZATION
```
public static final int DIVISION_FACTOR_NORMALIZATION
```
    La constante DIVISION_FACTOR_NORMALIZATION correspond au code de référence pour utiliser l'algorithme de normalisation des couleurs par facteur de division. Cette approche réduit tous les canaux d'un certain facteur selon l'amplitude maximale de l'un d'eux. Si un canal est supérieur à 1.0 et qu'il est le plus élevé parmis les canaux rgb, il sera divisé par sa grandeur le réduisant à 1.0 et tous les autres canaux rgb seront divisés par ce même facteur les réduisant à une valeur inférieure au canal de valeur maximal.
    
    See Also:
    
    Constant Field Values
  - BLACK
```
public static SColor BLACK
```
    La constante BLACK correspond à la couleur noire.
- Constructor Detail
  - SColor
```
public SColor()
```
    Constructeur vide correpondant à la couleur blanche et transparence nulle (alpha = 1).
  - SColor
```
public SColor(double red,
              double green,
              double blue)
       throws SConstructorException
```
    Constructeur d'une couleur avec transparance nulle (complètement opaque). La valeur de alpha est de 1.
    
    Parameters:
    
    red - - La couleur rouge.
    
    green - - La couleur verte.
    
    blue - - La couleur bleu.
    
    Throws:
    
    SConstructorException - Si la couleur est définie avec un paramètre négatif.
  - SColor
```
public SColor(double red,
              double green,
              double blue,
              double alpha)
       throws SConstructorException
```
    Constructeur d'une couleur avec transparence alpha.
    
    Parameters:
    
    red - - La couleur rouge.
    
    green - - La couleur verte.
    
    blue - - La couleur bleu.
    
    alpha - - La transparence.
    
    Throws:
    
    SConstructorException - Si la couleur est définie avec un paramètre négatif.
  - SColor
```
public SColor(java.lang.String string)
       throws SReadingException,
              SConstructorException
```
    Constructeur d'une couleur en utilisant un String comme paramètre fractionné dans un StringTokenizer. Une lecture autorisée peut prendre la forme suivante en fonction du nombre de tokens dans le StringTokenizer.
    
    Format (1) : "nom couleur"
    
    Format (2) : "nom couleur" "float alpha"
    
    Format (3) : "float r" "float g" "float b"
    
    Format (4) : "float r" "float g" "float b" "float a"
    
    Parameters:
    
    string - - L'expression donnant accès aux paramètres r, g, b et a de la couleur.
    
    Throws:
    
    SReadingException - Si le format de la lecture n'est pas adéquat.
    
    SConstructorException - Si la couleur est définie avec un paramètre négatif.
  - SColor
```
public SColor(java.awt.Color color)
```
    Constructeur d'une couleur à partir d'une couleur de type "Color" définit à l'aide de canaux entier compris dans l'intervalle [0, 255].
    
    Parameters:
    
    color - - La couleur à convertir.
- Method Detail
  - getRed
```
public double getRed()
```
    Méthode qui donne la couleur du canal rouge.
    
    Returns:
    
    La couleur rouge.
  - getGreen
```
public double getGreen()
```
    Méthode qui donne la couleur du canal vert.
    
    Returns:
    
    La couleur verte.
  - getBlue
```
public double getBlue()
```
    Méthode qui donne la couleur du canal blue.
    
    Returns:
    
    La couleur bleu.
  - getAlpha
```
public double getAlpha()
```
    Méthode qui donne la transparence de la couleur.
    
    Returns:
    
    La transparence dans l'intervalle [0,1].
  - getColorNormalization
```
public static int getColorNormalization()
```
    Méthode pour obtenir le code correspondant au type de normalisation appliquée aux couleurs dont un canal ou plus dépasse la valeur de 1.0.
    
    Returns:
    
    Le code du type de normalisation.
  - setColorNormalization
```
public static void setColorNormalization(int code)
                                  throws SRuntimeException
```
    Méthode pour définir le type de normalisation qui sera appliquée aux couleurs dont un canal au plus dépasse la valeur de 1.0.
    
    Parameters:
    
    code - - Le code associé au type d'algorithme de normalisation de la couleur.
    
    Throws:
    
    SRuntimeException - Si le code de référence n'est pas reconnu par le système.
  - add
```
public SVector add(SVector v)
```
    Description copied from interface: SVector
    
    Méthode permettant d'effectuer l'addition mathématique entre deux vecteurs.
    
    Specified by:
    
    add in interface SVector
    
    Parameters:
    
    v - - Le vecteur à additionner
    
    Returns:
    
    Le vecteur résultat de l'addition des deux vecteurs.
  - add
```
public SColor add(SColor c)
```
    Méthode qui retourne l'addition de la couleur de l'objet avec une nouvelle couleur.
    
    Parameters:
    
    c - - La couleur à ajouter.
    
    Returns:
    
    La somme des deux couleurs sans influancer la transparence.
  - multiply
```
public SColor multiply(double m)
```
    Méthode qui retourne le résultat de la multiplication par un scalaire de chaque canal de la couleur sauf le canal alpha restant inchangé. Ce calcul correcpond à la multiplication d'un vecteur par un scalaire sans affecter la 4ième composante.
    
    Specified by:
    
    multiply in interface SVector
    
    Parameters:
    
    m - - Le muliplicateur de chaque canal (sauf le alpha).
    
    Returns:
    
    La couleur mulipliée par un scalaire.
  - multiply
```
public SColor multiply(SColor c)
```
    Méthode pour multiplier deux couleurs ensembles. Le calcul correspond à muliplier les canaux semblables ensemble (sauf le canal alpha).
    
    Parameters:
    
    c - La couleur à multiplier
    
    Returns:
    
    Un nouvelle couleur qui est le produit de deux couleurs précédentes.
  - normalize
```
public SColor normalize()
                 throws SRuntimeException
```
    Méthode pour normaliser une couleur. Le type de normalisation dépend du choix de l'algorythme choisi.
    
    Returns:
    
    La couleur après normalisation.
    
    Throws:
    
    SRuntimeException - Si le type de normalisation n'est pas reconnu par le système.
    
    See Also:
    
    normalizeClampChannel, normalizeDivisionFactor
  - normalizeColor
```
public java.awt.Color normalizeColor()
```
    Méthode qui retourne un objet Color convertible en format RGB [0..255]. Si un canal rgb dépasse l'intervalle [0..1], il est alors maximisé à 1.0f (ou 255). Cette couleur est alors normalisée.
    
    Returns:
    
    La couleur après normalisation.
    
    See Also:
    
    Color
  - toString
```
public java.lang.String toString()
```
    Overrides:
    
    toString in class java.lang.Object
  - equals
```
public boolean equals(java.lang.Object other)
```
    Overrides:
    
    equals in class java.lang.Object
  - write
```
public void write(java.io.BufferedWriter bw)
           throws java.io.IOException
```
    Méthode pour écrire les paramètres rgba de la couleur dans un fichier en format txt. Le format de l'écriture est "rouge" "vert" "bleu" "alpha" comme l'exemple suivant : 0.6 0.2 0.5 1.0
    
    Specified by:
    
    write in interface SWriteable
    
    Parameters:
    
    bw - Le buffer d'écriture.
    
    Throws:
    
    java.io.IOException - S'il y a une erreur avec le buffer d'écriture.
    
    See Also:
    
    BufferedWriter

Class SColor

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

COLOR_NORMALIZATION

CLAMP_CHANNEL_NORMALIZATION

DIVISION_FACTOR_NORMALIZATION

BLACK

Constructor Detail

SColor

SColor

SColor

SColor

SColor

Method Detail

getRed

getGreen

getBlue

getAlpha

getColorNormalization

setColorNormalization

add

add

multiply

multiply

normalize

normalizeColor

toString

equals

write