relativeCCW

fun relativeCCW(x1: double, y1: double, x2: double, y2: double, px: double, py: double): int

Returns an indicator of where the specified point {@code (px,py)} lies with respect to the line segment from {@code (x1,y1)} to {@code (x2,y2)}. The return value can be either 1, -1, or 0 and indicates in which direction the specified line must pivot around its first end point, {@code (x1,y1)}, in order to point at the specified point {@code (px,py)} .

A return value of 1 indicates that the line segment must turn in the direction that takes the positive X axis towards the negative Y axis. In the default coordinate system used by Java 2D, this direction is counterclockwise.

A return value of -1 indicates that the line segment must turn in the direction that takes the positive X axis towards the positive Y axis. In the default coordinate system, this direction is clockwise.

A return value of 0 indicates that the point lies exactly on the line segment. Note that an indicator value of 0 is rare and not useful for determining colinearity because of floating point rounding issues.

If the point is colinear with the line segment, but not between the end points, then the value will be -1 if the point lies "beyond {@code (x1,y1)}" or 1 if the point lies "beyond {@code (x2,y2)}".

Return

an integer that indicates the position of the third specified coordinates with respect to the line segment formed by the first two specified coordinates.

Since

1.2

Parameters

x1

the X coordinate of the start point of the specified line segment

y1

the Y coordinate of the start point of the specified line segment

x2

the X coordinate of the end point of the specified line segment

y2

the Y coordinate of the end point of the specified line segment

px

the X coordinate of the specified point to be compared with the specified line segment

py

the Y coordinate of the specified point to be compared with the specified line segment