Image
Cet objet représente une image.
Attention, cette page n'est pas complètement traduite. Voir la version originale : image
Fonctions
Image
Syntaxe
var monObjet = new Image();
var monObjet = new Image(autreImage);
var monObjet = new Image(x, y);
Arguments
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
fenêtre - (
Window) la fenêtre dont vous voulez capturer une image
Exceptions
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
screenIndex - (integer) the index of the screen to screenshot
Exceptions
Méthodes
clone
Rend une copie de cette Image.
Syntaxe
Renvoie
Exemple
var copieDeMonObjet = monObjet.clone();
equals
Renvoie vrai si cette Image et un autre se réfèrent à la même image.
Syntaxe
Arguments
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
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
Arguments
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
Renvoie
(
RawData) cette Image comme RawData
Exceptions
loadFromFile
Charge l'Image d'un dossier.
Syntaxe
monObjet.loadFromFile(nomDeFichier );
Arguments
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
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
filtre - (
Filtre) le filtre à utiliser
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
Renvoie
Exceptions
pixel
Returns a pixel from this Image.
Syntax
Arguments
x - (integer) x coordinate of the pixel to return
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
x - (integer) x coordinate of the pixel to set
y - (integer) y coordinate of the pixel to set
color - (
Color) color of the pixel to set
red - (integer) red value of the color to set
green - (integer) green value of the color to set
blue - (integer) blue value of the color to set
Returns
mirror
Syntax
myObject.mirror(mirrorOrientation);
Arguments
Returns
setSize
Syntax
myObject.setSize(size);
myObject.setSize(width, height);
Arguments
size - (
Size) the new Image size
width - (integer) the new width of this Image
height - (integer) the new height of this Image
Returns
size
Returns the size of this Image.
Syntax
Returns
(
Size) the size of this Image
width
Returns the width of this Image.
Syntax
Returns
height
Returns the height of this Image.
Syntax
Returns
copy
Returns a copy of this Image or only a part of it.
Syntax
myObject.copy();
myObject.copy(rect);
Arguments
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
otherImage - (Image) the Image to find
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
otherImage - (Image) the Image to find
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
otherImage - (Image) the Image to find
callback(object) - (function) the function that will be called when the search ends
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
otherImage - (Image) the Image to find
callback(object) - (function) the function that will be called when the search ends
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
Values
ConvolutionFilter: the convolution filter
GaussianBlur: a gaussian blur
Defocus: blurs the image
Highlight: highlight the image
Sharpen: sharpens the image
SharpenMore: sharpens the image
SharpenEvenMore: sharpens the image
EdgeDetect: edge detection filter
BigEdge: edge detection filter (thicker edges)
Emboss: embosses the image (no color preservation)
EmbossColor: embosses the image (color preservation)
Negative: negates a color channel
RemoveChannel: remove a color channel
Punch: distorts the image
MirrorOrientation
Values
Vertical: a vertical mirror
Horizontal: an horizontal mirror
Method
Search method. [Added in Actionaz 3.7.0.]
Values
CorrelationCoefficient: correlation coefficient, best for most use cases
CrossCorrelation: cross correlation
SquaredDifference: squared difference