org.sikuli.script

Class Pattern

java.lang.Object

org.sikuli.script.Pattern

public class Pattern
extends Object

to define a more complex search target
- non-standard minimum similarity
- click target other than center
- image as in-memory image

Constructor Summary

Constructors

Constructor and Description
Pattern() creates empty Pattern object at least setFilename() or setImage() must be used before the Pattern object is ready for anything
Pattern(BufferedImage bimg) A Pattern from a BufferedImage ** not tested yet totally **
Pattern(Pattern p) create a new Pattern from another (attribs are copied)
Pattern(ScreenImage simg) A Pattern from a ScreenImage ** not tested yet totally **
Pattern(String imgpath) create a Pattern with an image file name checked only when used see checkFile()

Method Summary

Methods

Modifier and Type	Method and Description
String	checkFile() check for a valid image file
Pattern	exact() sets the minimum Similarity to 0.99 which means exact match
String	getFilename() the current image absolute filepath if any
BufferedImage	getImage() return the image if any
float	getSimilar()
Location	getTargetOffset()
Pattern	setFilename(String imgURL_) set the Patterns image file name It is only checked if Pattern is used or with getFilename()
Pattern	setImage(BufferedImage bimg) sets the Pattern's image
Pattern	setImage(ScreenImage simg) sets the Pattern's image
int	setTimeAfter() get the seconds to wait, after this pattern is acted on
void	setTimeAfter(int secs) set the seconds to wait, after this pattern is acted on
Pattern	similar(float sim) sets the minimum Similarity to use with find
Pattern	targetOffset(int dx, int dy) set the offset from the match's center to be used with mouse actions
Pattern	targetOffset(Location loc) set the offset from the match's center to be used with mouse actions
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

Pattern

public Pattern()

creates empty Pattern object at least setFilename() or setImage() must be used before the Pattern object is ready for anything

Pattern

public Pattern(Pattern p)

create a new Pattern from another (attribs are copied)

Parameters:

p -

Pattern

public Pattern(String imgpath)

create a Pattern with an image file name
checked only when used
see checkFile()

Parameters:

imgpath -

Pattern

public Pattern(BufferedImage bimg)

A Pattern from a BufferedImage ** not tested yet totally **

Parameters:

bimg -

Pattern

public Pattern(ScreenImage simg)

A Pattern from a ScreenImage ** not tested yet totally **

Parameters:

simg -

Method Detail

similar

public Pattern similar(float sim)

sets the minimum Similarity to use with find

Parameters:

sim -

Returns:

the Pattern object itself

exact

public Pattern exact()

sets the minimum Similarity to 0.99 which means exact match

Returns:

the Pattern object itself

getSimilar

public float getSimilar()

Returns:

the current minimum similarity

targetOffset

public Pattern targetOffset(int dx,
                   int dy)

set the offset from the match's center to be used with mouse actions

Parameters:

dx -

dy -

Returns:

the Pattern object itself

targetOffset

public Pattern targetOffset(Location loc)

set the offset from the match's center to be used with mouse actions

Parameters:

loc -

Returns:

the Pattern object itself

getTargetOffset

public Location getTargetOffset()

Returns:

the current offset

setFilename

public Pattern setFilename(String imgURL_)

set the Patterns image file name It is only checked if Pattern is used or with getFilename()

Parameters:

imgURL_ -

Returns:

the Pattern object itself

getFilename

public String getFilename()

the current image absolute filepath if any

Returns:

might be null

checkFile

public String checkFile()

check for a valid image file

Returns:

path or null

getImage

public BufferedImage getImage()

return the image if any

Returns:

might be null

setImage

public Pattern setImage(BufferedImage bimg)

sets the Pattern's image

Parameters:

bimg -

Returns:

the Pattern object itself

setImage

public Pattern setImage(ScreenImage simg)

sets the Pattern's image

Parameters:

simg -

Returns:

the Pattern object itself

setTimeAfter

public void setTimeAfter(int secs)

set the seconds to wait, after this pattern is acted on

Parameters:

secs -

setTimeAfter

public int setTimeAfter()

get the seconds to wait, after this pattern is acted on

toString

public String toString()

Overrides:

toString in class Object