Table of Contents

Image

Cet objet représente une image.

Attention, cette page n'est pas complètement traduite. Voir la version originale : image

Fonctions

Image

Fonction constructeur.

Syntaxe

var monObjet = new Image();
var monObjet = new Image(autreImage);
var monObjet = new Image(x, y);

Arguments

  1. autreImage - (Image) l'autre Image à copier

Exceptions

Exemple

Créer une nouvelle image vide.

var monObjet = new Image();

Créer une Image représentant une copie de autreImage .

var monObjet = new Image(autreImage);

takeScreenshot

Prend une capture d'écran de l'écran entier ou seulement de la fenêtre et conserve le résultat dans une nouvelle Image.

Syntaxe

var monObjet = Image.takeScreenshot();
var monObjet = Image.takeScreenshot(fenêtre);

Arguments

  1. fenêtre - (Window) la fenêtre dont vous voulez capturer une image

Exceptions

[TODO:Translate]

takeScreenshotUsingScreenIndex

Take a screenshot of one screen and store the result in a new Image. [Added in Actionaz 3.7.0.]

Syntax

var myObject = Image.takeScreenshotUsingScreenIndex(0);

Arguments

  1. screenIndex - (integer) the index of the screen to screenshot

Exceptions

Méthodes

clone

Rend une copie de cette Image.

Syntaxe

monObjet.clone();

Renvoie

Exemple

var copieDeMonObjet = monObjet.clone();

equals

Renvoie vrai si cette Image et un autre se réfèrent à la même image.

Syntaxe

monObjet.equals(autre);

Arguments

  1. autre - (Image) une autre Image

Renvoie

Exemple

if(monPremierObjet.equals(monDeuxièmeObjet))
	//Faire quelque chose

toString

Retourne une chaîne représentant cette Image.

Syntaxe

monObjet.toString();

Renvoie

Exemple

Console.print(monObjet.toString());

Notes

On appelle automatiquement cette méthode en essayant de convertir une Image en chaîne.

setData

Met les données de cette Image.

Syntaxe

monObjet.setData(data);

Arguments

  1. data - (RawData) RawData de l'image

Renvoie

Exceptions

Notes

Les formats d'image soutenus sont BMP, GIF, JPG, JPEG, PNG, PBM, PGM, PPM, TIFF, XBM et XPM.

data

Rend les données de cette Image comme RawData dans le format de BMP.

Syntaxe

monObjet.data();

Renvoie

Exceptions

loadFromFile

Charge l'Image d'un dossier.

Syntaxe

monObjet.loadFromFile(nomDeFichier );

Arguments

  1. nomDeFichier - (string) le nom du fichier à charger

Renvoie

Exceptions

Notes

Les formats d'image soutenus sont BMP, GIF, JPG, JPEG, PNG, PBM, PGM, PPM, TIFF, XBM et XPM.

saveToFile

Enregistre l'image dans un fichier.

Syntaxe

monObjet.saveToFile(nomDeFichier);

Arguments

  1. nomDeFichier - (string) nom de fichier à enregistrer dans

Renvoie

Exceptions

Notes

Les formats d'image soutenus sont BMP, JPG, JPEG, PNG, PPM, TIFF, XBM et XPM.

applyFilter

Applique un filtre sur cette Image.

Syntaxe

monObjet.applyFilter(filtre);
monObject.applyFilter(filtre, options);

Arguments

  1. filtre - (Filtre) le filtre à utiliser
  2. options - (objet) option de filtre
    • filterChannels - (chaîne) la couleur sur laquelle sera appliquée le filtre. Une chaîne de caractères constituée de zéro ou une occurence des caractères r,g,b,a
    • filterBorderPolicy - (string) utilisé avec le filtre de convolution. Les valeurs sont "mirror", "extend" ou "wrap"
    • convolutionDivisor - (integer) le diviseur de convolution
    • convolutionBias - (integer) le biais de convolution
    • radius - (number) le radius
    • force - (number) la force (Utilise la, Luc!)
    • center - (object) le centre
      • x - (integer) la coordonnée x
      • y - (integer) la coordonnée y

Renvoie

Exceptions

[TODO:Translate]

pixel

Returns a pixel from this Image.

Syntax

myObject.pixel(x, y);

Arguments

  1. x - (integer) x coordinate of the pixel to return
  2. y - (integer) y coordinate of the pixel to return

Returns

setPixel

Sets a pixel from this Image.

Syntax

myObject.pixel(x, y, color);
myObject.pixel(x, y, colorString);
myObject.pixel(x, y, red, green, blue);

Arguments

  1. x - (integer) x coordinate of the pixel to set
  2. y - (integer) y coordinate of the pixel to set
  3. color - (Color) color of the pixel to set
  4. red - (integer) red value of the color to set
  5. green - (integer) green value of the color to set
  6. blue - (integer) blue value of the color to set

Returns

mirror

Mirror this Image.

Syntax

myObject.mirror(mirrorOrientation);

Arguments

  1. mirrorOrientation - (MirrorOrientation) mirror orientation

Returns

setSize

Resizes this Image.

Syntax

myObject.setSize(size);
myObject.setSize(width, height);

Arguments

  1. size - (Size) the new Image size
  2. width - (integer) the new width of this Image
  3. height - (integer) the new height of this Image

Returns

size

Returns the size of this Image.

Syntax

myObject.size();

Returns

width

Returns the width of this Image.

Syntax

myObject.width();

Returns

height

Returns the height of this Image.

Syntax

myObject.height();

Returns

copy

Returns a copy of this Image or only a part of it.

Syntax

myObject.copy();
myObject.copy(rect);

Arguments

  1. rect - (Rect) the section of this Image to copy

Returns

findSubImage

Searches for another image contained in this one.

Added in Actionaz 3.0.1.

Syntax

myObject.findSubImage(otherImage);
myObject.findSubImage(otherImage, options);

Arguments

  1. otherImage - (Image) the Image to find
  2. options - (object) search options
    • confidenceMinimum - (integer) the minimum confidence percentage, 100 means perfect match (default: 70)
    • downPyramidCount - (integer) the number of pyramids to use. A pyramid is a subdivision of the image used to accelerate the search. Choose 1 here if the searched image is not very different from this image. (default: 2)
    • method - (Method) the search method to use (default: CorrelationCoefficient) [Added in Actionaz 3.7.0.]

Returns

Exceptions

Example

//Searches for an object on the screen
var screenShot = Image.takeScreenshot();
var imageToFind = new Image("object.png");
 
var searchResult = screenShot.findSubImage(imageToFind);
if(searchResult)
    Console.print("Matching image found, position: " + searchResult.position + ", confidence: " + searchResult.confidence);
else
    Console.print("No matching image found.");

findSubImages

Searches for images contained in this one.

Added in Actionaz 3.0.1.

Syntax

myObject.findSubImages(otherImage);
myObject.findSubImages(otherImage, options);

Arguments

  1. otherImage - (Image) the Image to find
  2. options - (object) search options
    • confidenceMinimum - (integer) the minimum confidence percentage, 100 means perfect match (default: 70)
    • downPyramidCount - (integer) the number of pyramids to use. A pyramid is a subdivision of the image used to accelerate the search. Choose 1 here if the searched image is not very different from this image. (default: 2)
    • searchExpansion - (integer) the number of pixels to shift when searching for another matching image (default: 15)
    • maximumMatches - (integer) the maximal number of matches (default: 10)
    • method - (Method) the search method to use (default: CorrelationCoefficient) [Added in Actionaz 3.7.0.]

Returns

Exceptions

Example

//Searches for objects on the screen
var screenShot = Image.takeScreenshot();
var imageToFind = new Image("object.png");
 
var searchResult = screenShot.findSubImages(imageToFind);
if(searchResult)
{
    Console.print("Matching images found\n");
 
    for(var i = 0; i < searchResult.length; ++i)
    {
        Console.print("position: " + searchResult[i].position + ", confidence: " + searchResult[i].confidence + "\n");
    }
}
else
    Console.print("No matching images found.");

findSubImageAsync

Searches for another image contained in this one in asynchronous mode.

Added in Actionaz 3.0.1.

Syntax

myObject.findSubImageAsync(otherImage, callback);
myObject.findSubImageAsync(otherImage, callback, options);

Arguments

  1. otherImage - (Image) the Image to find
  2. callback(object) - (function) the function that will be called when the search ends
    • position - (Point) the matching image center
    • confidence - (integer) the confidence percentage
  3. options - (object) search options
    • confidenceMinimum - (integer) the minimum confidence percentage, 100 means perfect match (default: 70)
    • downPyramidCount - (integer) the number of pyramids to use. A pyramid is a subdivision of the image used to accelerate the search. Choose 1 here if the searched image is not very different from this image. (default: 2)
    • searchExpansion - (integer) the number of pixels to shift when searching for another matching image (default: 15)
    • method - (Method) the search method to use (default: CorrelationCoefficient) [Added in Actionaz 3.7.0.]

Returns

Exceptions

Example

//Searches for an object on the screen
var screenShot = Image.takeScreenshot();
var imageToFind = new Image("object.png");
 
screenShot.findSubImageAsync(imageToFind, function(searchResult)
{
    if(searchResult)
        Console.print("Matching image found, position: " + searchResult.position + ", confidence: " + searchResult.confidence);
    else
        Console.print("No matching image found.");
});

findSubImagesAsync

Searches for images contained in this one in asynchronous mode.

Added in Actionaz 3.0.1.

Syntax

myObject.findSubImagesAsync(otherImage, callback);
myObject.findSubImagesAsync(otherImage, callback, options);

Arguments

  1. otherImage - (Image) the Image to find
  2. callback(object) - (function) the function that will be called when the search ends
    • position - (Point) the matching image center
    • confidence - (integer) the confidence percentage
  3. options - (object) search options
    • confidenceMinimum - (integer) the minimum confidence percentage, 100 means perfect match (default: 70)
    • downPyramidCount - (integer) the number of pyramids to use. A pyramid is a subdivision of the image used to accelerate the search. Choose 1 here if the searched image is not very different from this image. (default: 2)
    • searchExpansion - (integer) the number of pixels to shift when searching for another matching image (default: 15)
    • maximumMatches - (integer) the maximal number of matches (default: 10)
    • method - (Method) the search method to use (default: CorrelationCoefficient) [Added in Actionaz 3.7.0.]

Returns

Exceptions

Example

//Searches for objects on the screen
var screenShot = Image.takeScreenshot();
var imageToFind = new Image("object.png");
 
screenShot.findSubImagesAsync(imageToFind, function(searchResult)
{
    if(searchResult)
    {
        Console.print("Matching images found\n");
 
        for(var i = 0; i < searchResult.length; ++i)
        {
            Console.print("position: " + searchResult[i].position + ", confidence: " + searchResult[i].confidence + "\n");
        }
    }
    else
        Console.print("No matching images found.");
});

Enumerations

Filter

Image filters.

Values

  1. ConvolutionFilter: the convolution filter
  2. GaussianBlur: a gaussian blur
  3. Defocus: blurs the image
  4. Highlight: highlight the image
  5. Sharpen: sharpens the image
  6. SharpenMore: sharpens the image
  7. SharpenEvenMore: sharpens the image
  8. EdgeDetect: edge detection filter
  9. BigEdge: edge detection filter (thicker edges)
  10. Emboss: embosses the image (no color preservation)
  11. EmbossColor: embosses the image (color preservation)
  12. Negative: negates a color channel
  13. RemoveChannel: remove a color channel
  14. Punch: distorts the image

MirrorOrientation

Mirror orientation.

Values

  1. Vertical: a vertical mirror
  2. Horizontal: an horizontal mirror

Method

Search method. [Added in Actionaz 3.7.0.]

Values

  1. CorrelationCoefficient: correlation coefficient, best for most use cases
  2. CrossCorrelation: cross correlation
  3. SquaredDifference: squared difference