Functions (Javasnice 0.2.1 API)

java.lang.Object
- org.javascool.proglets.codagePixels.Functions

```
public class Functions
extends Object
```
Définit les fonctions de la proglet qui permettent de manipuler les pixels d'une image.

See Also:

code source

Method Summary

All Methods Static Methods Concrete Methods
Modifier and Type	Method and Description
`static int`	`getHeight()` Renvoie la demi-hauteur de l'image, si elle est centrée (sinon la hauteur de l'image).
`static int`	`getPixel(int x, int y)` Lit la valeur d'un pixel de l'image.
`static int[]`	`getPixelColor(int x, int y)` Lit la valeur couleur d'un pixel de l'image.
`static int`	`getWidth()` Renvoie la demi-largeur de l'image, si elle est centrée (sinon la largeur de l'image).
`static int`	`getX()` Renvoie la valeur horizontale du dernier clic de souris dans l'image.
`static int`	`getY()` Renvoie la valeur verticale du dernier clic de souris dans l'image.
`static void`	`load(String image)`
`static void`	`load(String image, boolean centered)`
`static void`	`load(String image, boolean centered, boolean zoom)` Charge l'image.
`static void`	`reset(int width, int height)`
`static void`	`reset(int width, int height, boolean centered)`
`static void`	`reset(int width, int height, boolean centered, boolean zoom)` Initialise l'image.
`static boolean`	`save(String location)` Sauvegarde l'image actuellement affichée.
`static boolean`	`setPixel(int x, int y, int valeur)` Change la valeur d'un pixel de l'image.
`static boolean`	`setPixel(int x, int y, int red, int green, int blue)` Change la valeur couleur d'un pixel de l'image.
`static boolean`	`setPixel(int x, int y, String color)` Change la valeur d'un pixel de l'image.
`static void`	`setRunnable(Runnable runnable)` Définit une portion de code appelée à chaque clic de souris.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Method Detail
  - reset
```
public static void reset(int width,
                         int height,
                         boolean centered,
                         boolean zoom)
```
    Initialise l'image. - La taille de l'image ne doit pas être trop importante (pas plus de 500^2).
    
    Parameters:
    
    width - Demi largeur de l'image de taille {-width, width}, si centrée (sinon largeur de l'image)
    
    height - Demi hauteur de l'image de taille {-height, height}, si centrée (sinon hauteur de l'image).
    
    centered - Si l'image est centrée, la valeur vaut true; si l'image n'est pas centrée la valeur vaut false.
    
    zoom - Ajuste automatiquement la taille de l'image au display si true (par défaut), sinon fixe 1 pixel de l'image à 1 pixel de l'affichage.
  - reset
```
public static void reset(int width,
                         int height,
                         boolean centered)
```
    See Also:
    
    reset(int, int, boolean, boolean)
  - reset
```
public static void reset(int width,
                         int height)
```
    See Also:
    
    reset(int, int, boolean, boolean)
  - load
```
public static void load(String image,
                        boolean centered,
                        boolean zoom)
```
    Charge l'image. - La taille de l'image ne doit pas être trop importante (pas plus de 500^2).
    
    Parameters:
    
    image - Nom de l'URL (Universal Resource Location) de ll'URL où se trouve l'image.
    Reconnait les formats binaires ".png", ".jpg" et ".gif". Reconnait les fichiers ASCII au format ".pbm", ".pgm" et ".ppm" par leur extension.
    
    centered - Si l'image est centrée, la valeur vaut true; si l'image n'est pas centrée la valeur vaut false.
    
    zoom - Ajuste automatiquement la taille de l'image au display si true (par défaut), sinon fixe 1 pixel de l'image à 1 pixel de l'affichage.
  - load
```
public static void load(String image,
                        boolean centered)
```
    See Also:
    
    load(String, boolean, boolean)
  - load
```
public static void load(String image)
```
    See Also:
    
    load(String, boolean, boolean)
  - save
```
public static boolean save(String location)
```
    Sauvegarde l'image actuellement affichée.
    
    Parameters:
    
    location - Une URL (Universal Resource Location) cible où stocker l'image.
    Reconnait le format de stockage par l'extension. Il est recommandé d'utiliser le format binaire ".pgn". Les formats ASCIIt ".pbm", ".pgm" et ".ppm" sont disponibles aussi.
    
    Returns:
    
    La valeur true si la sauvegarde s'est bien passée et la valeur fausse sinon (un message d'erreur s'affiche dans la console).
  - getWidth
```
public static int getWidth()
```
    Renvoie la demi-largeur de l'image, si elle est centrée (sinon la largeur de l'image).
  - getHeight
```
public static int getHeight()
```
    Renvoie la demi-hauteur de l'image, si elle est centrée (sinon la hauteur de l'image).
  - setPixel
```
public static boolean setPixel(int x,
                               int y,
                               String color)
```
    Change la valeur d'un pixel de l'image.
    
    Parameters:
    
    x - Abcisse de l'image, comptée à partir du milieu, valeur entre {-width, width}, si l'image est centrée (sinon valeur entre {0, width{).
    
    y - Ordonnée de l'image, comptée à partir du milieu, valeur entre {-height, height}, si l'image est centrée (sinon valeur entre {0, height{).
    
    color - Couleur: "black" (default), "blue", "cyan", "gray", "green", "magenta", "orange", "pink", "red", "white", "yellow".
    
    Returns:
    
    Renvoie true si le pixel est dans l'image, false si il est en dehors des limites d el'image.
  - setPixel
```
public static boolean setPixel(int x,
                               int y,
                               int valeur)
```
    Change la valeur d'un pixel de l'image.
    
    Parameters:
    
    x - Abcisse de l'image, comptée à partir du milieu, valeur entre {-width, width}, si l'image est centrée (sinon valeur entre {0, width{).
    
    y - Ordonnée de l'image, comptée à partir du milieu, valeur entre {-height, height}, si l'image est centrée (sinon valeur entre {0, height{).
    
    valeur - Une valeur entre 0 et 255 (0 pour noir, 255 pour blanc).
    
    Returns:
    
    Renvoie true si le pixel est dans l'image, false si il est en dehors des limites de l'image.
  - setPixel
```
public static boolean setPixel(int x,
                               int y,
                               int red,
                               int green,
                               int blue)
```
    Change la valeur couleur d'un pixel de l'image.
    
    Parameters:
    
    x - Abcisse de l'image, comptée à partir du milieu, valeur entre {-width, width}, si l'image est centrée (sinon valeur entre {0, width{).
    
    y - Ordonnée de l'image, comptée à partir du milieu, valeur entre {-height, height}, si l'image est centrée (sinon valeur entre {0, height{).
    
    red - Une valeur pour le rouge entre 0 et 255.
    
    green - Une valeur pour le vert entre 0 et 255.
    
    blue - Une valeur pour le blue entre 0 et 255.
    
    Returns:
    
    Renvoie true si le pixel est dans l'image, false si il est en dehors des limites de l'image.
  - getPixel
```
public static int getPixel(int x,
                           int y)
```
    Lit la valeur d'un pixel de l'image.
    
    Parameters:
    
    x - Abcisse de l'image, comptée à partir du milieu, valeur entre {-width, width}, si l'image est centrée (sinon valeur entre {0, width{).
    
    y - Ordonnée de l'image, comptée à partir du milieu, valeur entre {-height, height}, si l'image est centrée (sinon valeur entre {0, height{).
    
    Returns:
    
    Une valeur entre 0 et 255 (0 pour noir, 255 pour blanc); Renvoie 0 pour les pixels extérieurs à l'image.
  - getPixelColor
```
public static int[] getPixelColor(int x,
                                  int y)
```
    Lit la valeur couleur d'un pixel de l'image.
    
    Parameters:
    
    x - Abcisse de l'image, comptée à partir du milieu, valeur entre {-width, width}, si l'image est centrée (sinon valeur entre {0, width{).
    
    y - Ordonnée de l'image, comptée à partir du milieu, valeur entre {-height, height}, si l'image est centrée (sinon valeur entre {0, height{).
    
    Returns:
    
    Un tableau avec les trois valeurs rouge (index 0), vert (index 1), bleu (index 2) entre 0 et 255; Renvoie noir pour les pixels extérieurs à l'image.
  - getX
```
public static int getX()
```
    Renvoie la valeur horizontale du dernier clic de souris dans l'image.
  - getY
```
public static int getY()
```
    Renvoie la valeur verticale du dernier clic de souris dans l'image.
  - setRunnable
```
public static void setRunnable(Runnable runnable)
```
    Définit une portion de code appelée à chaque clic de souris.
    
    Parameters:
    
    runnable - La portion de code à appeler, ou null si il n'y en a pas.

Class Functions

Method Summary

Methods inherited from class java.lang.Object

Method Detail

reset

reset

reset

load

load

load

save

getWidth

getHeight

setPixel

setPixel

setPixel

getPixel

getPixelColor

getX

getY

setRunnable