DistanceComparator (SikuliX API 2.0.5 API)

java.lang.Object
- org.sikuli.script.compare.DistanceComparator

All Implemented Interfaces:

Comparator<Region>
```
public class DistanceComparator
extends Object
implements Comparator<Region>
```
Compares the Regions by distance to a point.

Constructor Summary

Constructors
Constructor	Description
`DistanceComparator(int x, int y)`	Constructor for class DistanceComparator.
`DistanceComparator(Location location)`	Constructor for class DistanceComparator.
`DistanceComparator(Region region)`	Constructor for class DistanceComparator.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type Method Description

int compare(Region region1, Region region2)
Compares the distance of two Region objects.
- Methods inherited from class java.lang.Object
  clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
- Methods inherited from interface java.util.Comparator
  equals, reversed, thenComparing, thenComparing, thenComparing, thenComparingDouble, thenComparingInt, thenComparingLong

- Constructor Detail
  - DistanceComparator
```
public DistanceComparator(int x,
                          int y)
```
    Constructor for class DistanceComparator.
    
    Parameters:
    
    x - X-Position for comparison
    
    y - Y-Position for comparison
  - DistanceComparator
```
public DistanceComparator(Location location)
```
    Constructor for class DistanceComparator.
    
    Parameters:
    
    location - Location for comparison
  - DistanceComparator
```
public DistanceComparator(Region region)
```
    Constructor for class DistanceComparator.
    
    Parameters:
    
    region - Region for comparison
- Method Detail
  - compare
```
public int compare(Region region1,
                   Region region2)
```
    Compares the distance of two Region objects.
    Specified by:
    
    compare in interface Comparator<Region>
    
    Parameters:
    
    region1 - The first Region object
    
    region2 - The second Region object
    
    Returns:
    
    -1 if the distance to region2 is smaller than to region1
    
    0 if the distances are equal
    
    1 if the distance to region1 is smaller than to region2