JavaPointPathPositionComparator (Imaging 2.0.0 API)

java.lang.Object
- science.aist.imaging.api.compare.JavaPointPathPositionComparator

All Implemented Interfaces:

Serializable, Comparator<JavaPoint2D>
```
public class JavaPointPathPositionComparator
extends Object
implements Comparator<JavaPoint2D>, Serializable
```
Compares two JavaPoint2Ds based on their position on a path represented by a JavaPolygon2D

Since:

1.0

Author:

Christoph Praschl

See Also:

Serialized Form

- Constructor Summary
  
  Constructors
  Constructor Description
  
  JavaPointPathPositionComparator()
- Method Summary
  
  All Methods Instance Methods Concrete Methods
  Modifier and Type Method Description
  
  int compare(JavaPoint2D o1, JavaPoint2D o2)
  - 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
  - JavaPointPathPositionComparator
```
public JavaPointPathPositionComparator()
```
- Method Detail
  - compare
```
public int compare(JavaPoint2D o1,
                   JavaPoint2D o2)
```
    Specified by:
    
    compare in interface Comparator<JavaPoint2D>
    
    Parameters:
    
    o1 - point 1
    
    o2 - point 2
    
    Returns:
    
    a value < 0 if o1 is on path before o2 == 0 if o1 is equal to o2 > 0 if o1 is on path after o2