com.applitools.eyes.images

Class EyesImagesScreenshot

java.lang.Object

com.applitools.eyes.EyesScreenshot

com.applitools.eyes.images.EyesImagesScreenshot

public class EyesImagesScreenshot
extends EyesScreenshot

Encapsulates a screenshot taken by the images SDK.

Field Summary

Fields

Modifier and Type	Field and Description
protected Region	bounds

Fields inherited from class com.applitools.eyes.EyesScreenshot

image

Constructor Summary

Constructors

Constructor and Description
EyesImagesScreenshot(BufferedImage image) See EyesImagesScreenshot(BufferedImage, Location).
EyesImagesScreenshot(BufferedImage image, Location location) Ctor.

Method Summary

Modifier and Type	Method and Description
Location	convertLocation(Location location, CoordinatesType from, CoordinatesType to) Convert the location.
Region	getIntersectedRegion(Region region, CoordinatesType resultCoordinatesType) Get the intersected region.
Location	getLocationInScreenshot(Location location, CoordinatesType coordinatesType) Get the location in the screenshot.
EyesScreenshot	getSubScreenshot(Region region, boolean throwIfClipped) Get sub screenshot.

Methods inherited from class com.applitools.eyes.EyesScreenshot

convertRegionLocation, getImage

Methods inherited from class java.lang.Object

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

Field Detail

bounds

protected Region bounds

Constructor Detail

EyesImagesScreenshot

public EyesImagesScreenshot(BufferedImage image,
                            Location location)

Ctor.

Parameters:

image - The screenshot image.

location - The top/left coordinates of the screenshot in context relative coordinates type.

EyesImagesScreenshot

public EyesImagesScreenshot(BufferedImage image)

See EyesImagesScreenshot(BufferedImage, Location). location defaults to (0, 0).

Parameters:

image - The screenshot image.

Method Detail

getSubScreenshot

public EyesScreenshot getSubScreenshot(Region region,
                                       boolean throwIfClipped)

Get sub screenshot.

Specified by:

getSubScreenshot in class EyesScreenshot

Parameters:

region - The region for which we should get the sub screenshot.

throwIfClipped - Throw an EyesException if the region is not fully contained in the screenshot.

Returns:

Sub screenshot.

convertLocation

public Location convertLocation(Location location,
                                CoordinatesType from,
                                CoordinatesType to)

Convert the location.

Specified by:

convertLocation in class EyesScreenshot

Parameters:

location - The location which coordinates needs to be converted.

from - The current coordinates type for location.

to - The target coordinates type for location.

Returns:

The converted location.

getLocationInScreenshot

public Location getLocationInScreenshot(Location location,
                                        CoordinatesType coordinatesType)
                                 throws OutOfBoundsException

Get the location in the screenshot.

Specified by:

getLocationInScreenshot in class EyesScreenshot

Parameters:

location - The location as coordinates inside the current frame.

coordinatesType - The coordinates type of location.

Returns:

The location in the screenshot.

Throws:

OutOfBoundsException

getIntersectedRegion

public Region getIntersectedRegion(Region region,
                                   CoordinatesType resultCoordinatesType)

Get the intersected region.

Specified by:

getIntersectedRegion in class EyesScreenshot

Parameters:

region - The region to intersect.

resultCoordinatesType - The coordinates type of the resulting region.

Returns:

The region of the intersected region.