Line

java.lang.Object
- com.austinv11.collectiveframework.utils.math.geometry.Line

public class Line
extends java.lang.Object

Base unit for shapes

Constructor Summary

Constructors
Constructor and Description
`Line(ThreeDimensionalVector startCoord, ThreeDimensionalVector endCoord)` Three dimensional constructor for a line
`Line(TwoDimensionalVector startCoord, TwoDimensionalVector endCoord)` Two dimensional constructor for a line

Method Summary

Methods
Modifier and Type	Method and Description
`boolean`	`equals(java.lang.Object other)`
`TwoDimensionalVector`	`find2DPoint(double x)` Plugs in the given x coordinate to the line to calculate a 2D point from its equation
`ThreeDimensionalVector`	`find3DPoint(double x)` Plugs in the given x coordinate to the line to calculate a 3D point from its equation
`TwoDimensionalVector`	`get2DEnd()` Gets the 2D ending point for the line
`double`	`get2DSlope()` Gets the 2D slope for the line
`TwoDimensionalVector`	`get2DStart()` Gets the 2D starting point for the line
`ThreeDimensionalVector`	`get3DEnd()` Gets the 3D ending point for the line
`ThreeDimensionalVector`	`get3DStart()` Gets the 3D starting point for the line
`java.util.List<TwoDimensionalVector>`	`getAll2DPoints()` Returns all points with whole number x values on the line
`java.util.List<ThreeDimensionalVector>`	`getAll3DPoints()` Returns all points with whole number x values on the line
`double`	`getEndX()` Gets the ending x coordinate of the line
`double`	`getEndY()` Gets the ending y coordinate of the line
`double`	`getEndZ()` Gets the ending z coordinate of the line
`double`	`getLength()` Gets the length of the line
`double`	`getStartX()` Gets the starting x coordinate of the line
`double`	`getStartY()` Gets the starting y coordinate of the line
`double`	`getStartZ()` Gets the starting z coordinate of the line
`boolean`	`isPointValid(ThreeDimensionalVector coord)` Checks if the point is valid on a 3D plane
`boolean`	`isPointValid(TwoDimensionalVector coord)` Checks if the point is valid on a 2D plane
`Line`	`rotate2D(double angle)` Rotates the line about the origin
`Line`	`rotate2D(TwoDimensionalVector point, double angle)` Rotates the line around a point
`Line`	`rotate3DX(double angle)` Rotates the line across the x-axis about the origin
`Line`	`rotate3DX(ThreeDimensionalVector point, double angle)` Rotates the line across the x-axis around a point
`Line`	`rotate3DY(double angle)` Rotates the line across the y-axis about the origin
`Line`	`rotate3DY(ThreeDimensionalVector point, double angle)` Rotates the line across the y-axis around a point
`Line`	`rotate3DZ(double angle)` Rotates the line across the z-axis about the origin
`Line`	`rotate3DZ(ThreeDimensionalVector point, double angle)` Rotates the line across the z-axis around a point
`Line`	`setEnd(ThreeDimensionalVector coord)` Creates a new line as a copy of this line but with the set end coord
`Line`	`setEnd(TwoDimensionalVector coord)` Creates a new line as a copy of this line but with the set end coord
`Line`	`setStart(ThreeDimensionalVector coord)` Creates a new line as a copy of this line but with the set start coord
`Line`	`setStart(TwoDimensionalVector coord)` Creates a new line as a copy of this line but with the set start coord
`java.lang.String`	`toString()`

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

- Constructor Detail
  - Line
```
public Line(TwoDimensionalVector startCoord,
    TwoDimensionalVector endCoord)
```
    Two dimensional constructor for a line
    
    Parameters:
    startCoord - Start coord of the line
    endCoord - End coord of the line
  - Line
```
public Line(ThreeDimensionalVector startCoord,
    ThreeDimensionalVector endCoord)
```
    Three dimensional constructor for a line
    
    Parameters:
    startCoord - Start coord of the line
    endCoord - End coord of the line
- Method Detail
  - getStartX
```
public double getStartX()
```
    Gets the starting x coordinate of the line
    
    Returns:
    The x coordinate
  - getStartY
```
public double getStartY()
```
    Gets the starting y coordinate of the line
    
    Returns:
    The y coordinate
  - getStartZ
```
public double getStartZ()
```
    Gets the starting z coordinate of the line
    
    Returns:
    The z coordinate
  - getEndX
```
public double getEndX()
```
    Gets the ending x coordinate of the line
    
    Returns:
    The x coordinate
  - getEndY
```
public double getEndY()
```
    Gets the ending y coordinate of the line
    
    Returns:
    The y coordinate
  - getEndZ
```
public double getEndZ()
```
    Gets the ending z coordinate of the line
    
    Returns:
    The z coordinate
  - get2DStart
```
public TwoDimensionalVector get2DStart()
```
    Gets the 2D starting point for the line
    
    Returns:
    The point
  - get2DEnd
```
public TwoDimensionalVector get2DEnd()
```
    Gets the 2D ending point for the line
    
    Returns:
    The point
  - get3DStart
```
public ThreeDimensionalVector get3DStart()
```
    Gets the 3D starting point for the line
    
    Returns:
    The point
  - get3DEnd
```
public ThreeDimensionalVector get3DEnd()
```
    Gets the 3D ending point for the line
    
    Returns:
    The point
  - get2DSlope
```
public double get2DSlope()
```
    Gets the 2D slope for the line
    
    Returns:
    The slope or NaN if it is undefined
  - find2DPoint
```
public TwoDimensionalVector find2DPoint(double x)
```
    Plugs in the given x coordinate to the line to calculate a 2D point from its equation
    
    Parameters:
    x - The x coordinate
    
    Returns:
    The calculated coordinate. NOTE: y will be the minimum y-value of the line if the slope of the line is undefined
  - isPointValid
```
public boolean isPointValid(TwoDimensionalVector coord)
```
    Checks if the point is valid on a 2D plane
    
    Parameters:
    coord - The coord to check
    
    Returns:
    If it's on the line
  - getAll2DPoints
```
public java.util.List<TwoDimensionalVector> getAll2DPoints()
```
    Returns all points with whole number x values on the line
    
    Returns:
    The points
  - find3DPoint
```
public ThreeDimensionalVector find3DPoint(double x)
```
    Plugs in the given x coordinate to the line to calculate a 3D point from its equation
    
    Parameters:
    x - The x coordinate
    
    Returns:
    The calculated coordinate
  - isPointValid
```
public boolean isPointValid(ThreeDimensionalVector coord)
```
    Checks if the point is valid on a 3D plane
    
    Parameters:
    coord - The coord to check
    
    Returns:
    If it's on the line
  - getAll3DPoints
```
public java.util.List<ThreeDimensionalVector> getAll3DPoints()
```
    Returns all points with whole number x values on the line
    
    Returns:
    The points
  - getLength
```
public double getLength()
```
    Gets the length of the line
    
    Returns:
    The length
  - setStart
```
public Line setStart(TwoDimensionalVector coord)
```
    Creates a new line as a copy of this line but with the set start coord
    
    Parameters:
    coord - The new start coord
    
    Returns:
    The new, modified line
  - setStart
```
public Line setStart(ThreeDimensionalVector coord)
```
    Creates a new line as a copy of this line but with the set start coord
    
    Parameters:
    coord - The new start coord
    
    Returns:
    The new, modified line
  - setEnd
```
public Line setEnd(TwoDimensionalVector coord)
```
    Creates a new line as a copy of this line but with the set end coord
    
    Parameters:
    coord - The new end coord
    
    Returns:
    The new, modified line
  - setEnd
```
public Line setEnd(ThreeDimensionalVector coord)
```
    Creates a new line as a copy of this line but with the set end coord
    
    Parameters:
    coord - The new end coord
    
    Returns:
    The new, modified line
  - rotate2D
```
public Line rotate2D(TwoDimensionalVector point,
            double angle)
```
    Rotates the line around a point
    
    Parameters:
    point - The point to rotate around
    angle - The angle to rotate by
    
    Returns:
    The new line
  - rotate2D
```
public Line rotate2D(double angle)
```
    Rotates the line about the origin
    
    Parameters:
    angle - The angle to rotate by
    
    Returns:
    The new line
  - rotate3DX
```
public Line rotate3DX(ThreeDimensionalVector point,
             double angle)
```
    Rotates the line across the x-axis around a point
    
    Parameters:
    point - The point to rotate around
    angle - The angle to rotate by
    
    Returns:
    The new line
  - rotate3DX
```
public Line rotate3DX(double angle)
```
    Rotates the line across the x-axis about the origin
    
    Parameters:
    angle - The angle to rotate by
    
    Returns:
    The new line
  - rotate3DY
```
public Line rotate3DY(ThreeDimensionalVector point,
             double angle)
```
    Rotates the line across the y-axis around a point
    
    Parameters:
    point - The point to rotate around
    angle - The angle to rotate by
    
    Returns:
    The new line
  - rotate3DY
```
public Line rotate3DY(double angle)
```
    Rotates the line across the y-axis about the origin
    
    Parameters:
    angle - The angle to rotate by
    
    Returns:
    The new line
  - rotate3DZ
```
public Line rotate3DZ(ThreeDimensionalVector point,
             double angle)
```
    Rotates the line across the z-axis around a point
    
    Parameters:
    point - The point to rotate around
    angle - The angle to rotate by
    
    Returns:
    The new line
  - rotate3DZ
```
public Line rotate3DZ(double angle)
```
    Rotates the line across the z-axis about the origin
    
    Parameters:
    angle - The angle to rotate by
    
    Returns:
    The new line
  - equals
```
public boolean equals(java.lang.Object other)
```
    Overrides:
    
    equals in class java.lang.Object
  - toString
```
public java.lang.String toString()
```
    Overrides:
    
    toString in class java.lang.Object

Class Line

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

Line

Line

Method Detail

getStartX

getStartY

getStartZ

getEndX

getEndY

getEndZ

get2DStart

get2DEnd

get3DStart

get3DEnd

get2DSlope

find2DPoint

isPointValid

getAll2DPoints

find3DPoint

isPointValid

getAll3DPoints

getLength

setStart

setStart

setEnd

setEnd

rotate2D

rotate2D

rotate3DX

rotate3DX

rotate3DY

rotate3DY

rotate3DZ

rotate3DZ

equals

toString