Lines (geom 0.0.2 API)

java.lang.Object
- de.javagl.geom.Lines

```
public class Lines
extends Object
```
Utility methods related to lines

Method Summary

All Methods Static Methods Concrete Methods
Modifier and Type	Method and Description
`static double`	`angle(double sx0, double sy0, double ex0, double ey0, double sx1, double sy1, double ex1, double ey1)` Computes the angle, in radians, between the given lines, as a value between 0 and 2PI.
`static double`	`angle(Line2D line0, Line2D line1)` Computes the angle, in radians, between the given lines, as a value between 0 and 2PI.
`static double`	`angle(Point2D s0, Point2D e0, Point2D s1, Point2D e1)` Computes the angle, in radians, between the given lines, as a value between 0 and 2PI.
`static double`	`angleToX(double x0, double y0, double x1, double y1)` Computes the angle, in radians, that the line from (x0,y0) to (x1,y1) has to the x axis
`static double`	`angleToX(Line2D line)` Computes the angle, in radians, that the line has to the x axis
`static double`	`angleToX(Point2D p0, Point2D p1)` Computes the angle, in radians, that the line from p0 to p1 has to the x axis
`static double`	`length(Line2D line)` Returns the length of the given line
`static double`	`lengthSquared(Line2D line)` Returns the squared length of the given line
`static Line2D`	`normalize(Line2D lineSrc, Line2D lineDst)` Normalize the given line to have unit length, by scaling it with its inverse length about its starting point, and store the result in the given destination.
`static Line2D`	`rotate(double angleRad, Line2D lineSrc, Line2D lineDst)` Rotate the given source line around its starting point, by the given angle, and stores the result in the given destination line.
`static Line2D`	`scale(double factor, Line2D lineSrc, Line2D lineDst)` Scale the given line with the given factor, about its starting point, and store the result in the given destination.
`static Line2D`	`scaleToLength(double length, Line2D lineSrc, Line2D lineDst)` Scale the given line to have the given length about its starting point, and store the result in the given destination.
`static String`	`toString(Line2D line)` Creates a simple string representation of the given line
`static String`	`toString(Line2D line, String format)` Creates a simple string representation of the given line, using the given format for the coordinates
`static Line2D`	`transform(AffineTransform at, Line2D lineSrc, Line2D lineDst)` Transform the given line with the given transform, and store the result in the given destination.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Method Detail
  - length
```
public static double length(Line2D line)
```
    Returns the length of the given line
    
    Parameters:
    
    line - The line
    
    Returns:
    
    The length of the line
  - lengthSquared
```
public static double lengthSquared(Line2D line)
```
    Returns the squared length of the given line
    
    Parameters:
    
    line - The line
    
    Returns:
    
    The squared length
  - transform
```
public static Line2D transform(AffineTransform at,
                               Line2D lineSrc,
                               Line2D lineDst)
```
    Transform the given line with the given transform, and store the result in the given destination. If the given destination is null, then a new line will be created and returned
    
    Parameters:
    
    at - The affine transform
    
    lineSrc - The source line
    
    lineDst - The destination line
    
    Returns:
    
    The destination line
  - scale
```
public static Line2D scale(double factor,
                           Line2D lineSrc,
                           Line2D lineDst)
```
    Scale the given line with the given factor, about its starting point, and store the result in the given destination. If the given destination is null, then a new line will be created and returned
    
    Parameters:
    
    factor - The scaling factor
    
    lineSrc - The source line
    
    lineDst - The destination line
    
    Returns:
    
    The destination line
  - normalize
```
public static Line2D normalize(Line2D lineSrc,
                               Line2D lineDst)
```
    Normalize the given line to have unit length, by scaling it with its inverse length about its starting point, and store the result in the given destination. If the given destination is null, then a new line will be created and returned
    
    Parameters:
    
    lineSrc - The source line
    
    lineDst - The destination line
    
    Returns:
    
    The destination line
  - scaleToLength
```
public static Line2D scaleToLength(double length,
                                   Line2D lineSrc,
                                   Line2D lineDst)
```
    Scale the given line to have the given length about its starting point, and store the result in the given destination. If the given destination is null, then a new line will be created and returned
    
    Parameters:
    
    length - The length
    
    lineSrc - The source line
    
    lineDst - The destination line
    
    Returns:
    
    The destination line
  - rotate
```
public static Line2D rotate(double angleRad,
                            Line2D lineSrc,
                            Line2D lineDst)
```
    Rotate the given source line around its starting point, by the given angle, and stores the result in the given destination line. If the destination line is null, then a new line will be created and returned.
    
    This method is equivalent to Lines.transform(AffineTransform.getRotateInstance(angleRad, lineSrc.getX1(), lineSrc.getY1()), lineSrc, lineDst); but may be more efficient and convenient
    
    Parameters:
    
    angleRad - The rotation angle
    
    lineSrc - The source line
    
    lineDst - The destination line
    
    Returns:
    
    The destination line
  - angle
```
public static double angle(Line2D line0,
                           Line2D line1)
```
    Computes the angle, in radians, between the given lines, as a value between 0 and 2PI.
    
    Parameters:
    
    line0 - The first line
    
    line1 - The second line
    
    Returns:
    
    The angle, in radians, between the given lines
  - angle
```
public static double angle(Point2D s0,
                           Point2D e0,
                           Point2D s1,
                           Point2D e1)
```
    Computes the angle, in radians, between the given lines, as a value between 0 and 2PI.
    
    Parameters:
    
    s0 - The start point of the first line
    
    e0 - The end point of the first line
    
    s1 - The start point of the second line
    
    e1 - The end point of the second line
    
    Returns:
    
    The angle, in radians, between the given lines
  - angle
```
public static double angle(double sx0,
                           double sy0,
                           double ex0,
                           double ey0,
                           double sx1,
                           double sy1,
                           double ex1,
                           double ey1)
```
    Computes the angle, in radians, between the given lines, as a value between 0 and 2PI.
    
    Parameters:
    
    sx0 - The x-coordinate of the start point of the first line
    
    sy0 - The y-coordinate of the start point of the first line
    
    ex0 - The x-coordinate of the end point of the first line
    
    ey0 - The y-coordinate of the end point of the first line
    
    sx1 - The x-coordinate of the start point of the second line
    
    sy1 - The y-coordinate of the start point of the second line
    
    ex1 - The x-coordinate of the end point of the second line
    
    ey1 - The y-coordinate of the end point of the second line
    
    Returns:
    
    The angle, in radians, between the given lines
  - angleToX
```
public static double angleToX(Line2D line)
```
    Computes the angle, in radians, that the line has to the x axis
    
    Parameters:
    
    line - The line
    
    Returns:
    
    The angle, in radians, that the line has to the x-axis
  - angleToX
```
public static double angleToX(Point2D p0,
                              Point2D p1)
```
    Computes the angle, in radians, that the line from p0 to p1 has to the x axis
    
    Parameters:
    
    p0 - The start point of the line
    
    p1 - The end point of the line
    
    Returns:
    
    The angle, in radians, that the line has to the x-axis
  - angleToX
```
public static double angleToX(double x0,
                              double y0,
                              double x1,
                              double y1)
```
    Computes the angle, in radians, that the line from (x0,y0) to (x1,y1) has to the x axis
    
    Parameters:
    
    x0 - The x-coordinate of the start point of the line
    
    y0 - The y-coordinate of the start point of the line
    
    x1 - The x-coordinate of the end point of the line
    
    y1 - The y-coordinate of the end point of the line
    
    Returns:
    
    The angle, in radians, that the line has to the x-axis
  - toString
```
public static String toString(Line2D line)
```
    Creates a simple string representation of the given line
    
    Parameters:
    
    line - The line
    
    Returns:
    
    The string
  - toString
```
public static String toString(Line2D line,
                              String format)
```
    Creates a simple string representation of the given line, using the given format for the coordinates
    
    Parameters:
    
    line - The line
    
    format - The format
    
    Returns:
    
    The string

Class Lines

Method Summary

Methods inherited from class java.lang.Object

Method Detail

length

lengthSquared

transform

scale

normalize

scaleToLength

rotate

angle

angle

angle

angleToX

angleToX

angleToX

toString

toString