org.sikuli.script

Class Match

java.lang.Object

org.sikuli.script.Region

org.sikuli.script.Match

All Implemented Interfaces:

Comparable<Match>

public class Match
extends Region
implements Comparable<Match>

holds the result of a find operation, is itself the region on the screen, where the image was found and hence inherits all methods from Region.
attributes:
the match score (0 ... 1.0)
the click target (e.g. from Pattern)
a ref to the image used for search
or the text used for find text
and elapsed times for debugging

Field Summary

Fields inherited from class org.sikuli.script.Region

BB, BH, BL, BM, BR, C2, CH, CREATE_X_DIRECTION_LEFT, CREATE_X_DIRECTION_RIGHT, CREATE_Y_DIRECTION_BOTTOM, CREATE_Y_DIRECTION_TOP, CV, EAST, EAST_MID, EAST_NORTH, EAST_SOUTH, EH, EM, EN, ES, h, LB, LH, LL, LM, LT, M2, M3, MH, MID_HORIZONTAL, MID_VERTICAL, MIDDLE, MIDDLE_BIG, MM, MV, NE, NH, NM, NORTH, NORTH_EAST, NORTH_MID, NORTH_WEST, NW, otherScreen, RB, RH, RM, RR, RT, SE, SH, SM, SOUTH, SOUTH_EAST, SOUTH_MID, SOUTH_WEST, SW, TH, TL, TM, TR, TT, w, WEST, WEST_MID, WEST_NORTH, WEST_SOUTH, WH, WM, WN, WS, x, y

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	Match(FindResult f, IScreen _parent) internally used constructor used by findX image
protected	Match(int x, int y, int w, int h, double Score, IScreen parent, String text) internally used constructor by TextRecognizer.listText()
	Match(Match m) create a copy of Match object to e.g. set another TargetOffset for same match
	Match(Region reg, double sc) create a Match from a region with given SimScore

Method Summary

Modifier and Type	Method and Description
int	compareTo(Match m)
boolean	equals(Object oThat)
Image	getImage() get the image used for searching
String	getImageFilename() get the filename of the image used for searching
int	getIndex()
double	getScore() the match score
Location	getTarget() convenience method
Location	getTargetOffset() convenience - same as Pattern.getTargetOffset()
String	getText()
long	getTime()
protected void	setImage(Image img) set the image after finding with success
void	setIndex(int index)
void	setOnScreen(boolean state)
void	setTarget(int tx, int ty) INTERNAL USE
void	setTargetOffset(int x, int y) like Pattern.targetOffset sets the click target relative to the center
void	setTargetOffset(Location offset) like Pattern.targetOffset sets the click target by offset relative to the center
void	setTimes(long ftime, long stime) INTERNAL USE set the elapsed times from search
String	toString()
String	toStringShort()

Methods inherited from class org.sikuli.script.Region

above, above, aboveAt, aboveAt, add, add, add, aInput, aKey, asOffset, aSwipe, aSwipeDown, aSwipeLeft, aSwipeRight, aSwipeUp, aTap, atMouse, below, below, belowAt, belowAt, checkMatch, click, click, click, compare, compare, contains, contains, containsMouse, copyTo, copyTo, create, create, create, create, create, create, delayClick, delayType, doubleClick, doubleClick, doubleClick, drag, dragDrop, dragDrop, dropAt, exists, exists, find, findAll, findAllByColumn, findAllByRow, findAllText, findBest, findText, findText, get, getAutoWaitTimeout, getBottomLeft, getBottomRight, getCell, getCenter, getCol, getCol, getCols, getColW, getEvent, getEvents, getFindFailedResponse, getH, getIDString, getLastMatch, getLastMatches, getLastScreenImage, getLastScreenImageFile, getLastScreenImageFile, getLastScreenImageFile, getLocationFromTarget, getObserver, getObserveScanRate, getRect, getRectangle, getRepeatWaitTime, getROI, getRow, getRow, getRowH, getRows, getScreen, getScreenContaining, getThrowException, getTopLeft, getTopRight, getW, getWaitScanRate, getX, getY, grow, grow, grow, grow, grow, grow, grow, hasEvents, hasObserver, highlight, highlight, highlight, highlight, highlight, highlight, hover, hover, initScreen, inside, intersection, isObserving, isOtherScreen, isRasterValid, isValid, isVirtual, keyDown, keyDown, keyUp, keyUp, keyUp, left, left, leftAt, leftAt, listText, morphTo, mouseDown, mouseMove, mouseMove, mouseMove, mouseUp, mouseUp, moveTo, nearby, nearby, observe, observe, observeInBackground, observeInLine, offset, offset, onAppear, onAppear, onChange, onChange, onChange, onChange, onChangeDo, onVanish, onVanish, paste, paste, regionOnScreen, resetScreens, right, right, rightAt, rightAt, rightClick, rightClick, rightClick, saveLastScreenImage, saveScreenCapture, saveScreenCapture, saveScreenCapture, setActive, setAutoWaitTimeout, setBottomLeft, setBottomRight, setCenter, setCols, setFindFailedHandler, setFindFailedResponse, setH, setImageMissingHandler, setInactive, setLocation, setObserveScanRate, setOtherScreen, setOtherScreen, setRaster, setRect, setRect, setRect, setRepeatWaitTime, setROI, setROI, setROI, setROI, setRows, setScreen, setScreen, setSize, setThrowException, setTopLeft, setTopRight, setVirtual, setW, setWaitScanRate, setX, setY, showScreens, silentHighlight, stopObserver, stopObserver, text, toGlobalCoord, type, type, type, type, type, type, union, updateSelf, virtual, wait, wait, wait, waitVanish, waitVanish, wheel, wheel, wheel, write

Methods inherited from class java.lang.Object

clone, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

Match

public Match(Match m)

create a copy of Match object
to e.g. set another TargetOffset for same match

Parameters:

m - other Match

Match

public Match(Region reg,
             double sc)

create a Match from a region with given SimScore

Parameters:

reg - Region

sc - SimScore

Match

protected Match(int x,
                int y,
                int w,
                int h,
                double Score,
                IScreen parent,
                String text)

internally used constructor by TextRecognizer.listText()

Parameters:

x - x

y - y

w - width

h - height

Score - SimScore

parent - Screen

text - given text

Match

protected Match(FindResult f,
                IScreen _parent)

internally used constructor used by findX image

Parameters:

f -

_parent -

Method Detail

setOnScreen

public void setOnScreen(boolean state)

getIndex

public int getIndex()

setIndex

public void setIndex(int index)

setTimes

public void setTimes(long ftime,
                     long stime)

INTERNAL USE set the elapsed times from search

Parameters:

ftime - time

stime - time

getTime

public long getTime()

Returns:

this Match's actual waiting time from last successful find

getScore

public double getScore()

the match score

Returns:

a decimal value between 0 (no match) and 1 (exact match)

getTarget

public Location getTarget()

convenience method

Overrides:

getTarget in class Region

Returns:

the point defined by target offset (if set) or the center

setTargetOffset

public void setTargetOffset(Location offset)

like Pattern.targetOffset sets the click target by offset relative to the center

Parameters:

offset - as a Location

setTargetOffset

public void setTargetOffset(int x,
                            int y)

like Pattern.targetOffset sets the click target relative to the center

Parameters:

x - x offset

y - y offset

getTargetOffset

public Location getTargetOffset()

convenience - same as Pattern.getTargetOffset()

Returns:

the relative offset to the center

setImage

protected void setImage(Image img)

set the image after finding with success

Parameters:

img - Image

getImage

public Image getImage()

get the image used for searching

Returns:

image or null

getImageFilename

public String getImageFilename()

get the filename of the image used for searching

Returns:

filename

getText

public String getText()

Returns:

the text used for searching

compareTo

public int compareTo(Match m)

Specified by:

compareTo in interface Comparable<Match>

equals

public boolean equals(Object oThat)

Overrides:

equals in class Object

toString

public String toString()

Description copied from class: Region

Overrides:

toString in class Region

Returns:

the description

toStringShort

public String toStringShort()

Overrides:

toStringShort in class Region

Returns:

a compact description

setTarget

public void setTarget(int tx,
                      int ty)

INTERNAL USE

Parameters:

tx - x

ty - y