TwoDimensionalVector

java.lang.Object
- com.austinv11.collectiveframework.utils.math.TwoDimensionalVector

All Implemented Interfaces:

java.lang.Comparable
```
public class TwoDimensionalVector
extends java.lang.Object
implements java.lang.Comparable
```
Class for manipulating and holding coords on a 2D plane

Constructor Summary

Constructors
Constructor and Description

TwoDimensionalVector(double x, double y)
Default constructor

Constructors
Constructor and Description
`TwoDimensionalVector(double x, double y)` Default constructor

Method Summary

Methods
Modifier and Type	Method and Description
`TwoDimensionalVector`	`add(TwoDimensionalVector other)` Returns a new vector with the result of the specified vector plus this.
`int`	`compareTo(java.lang.Object o)`
`double`	`distanceTo(TwoDimensionalVector other)` Finds the distance between two vectors
`double`	`dotProduct()` Finds the dot product of the current vector and itself
`double`	`dotProduct(TwoDimensionalVector other)` Finds the dot product of the current vector and the other specified vector
`boolean`	`equals(java.lang.Object other)`
`int`	`getRoundedX()` Returns the x coord as an int
`int`	`getRoundedY()` Returns the y coord as an int
`double`	`getX()` Gets the x coord of the vector
`double`	`getY()` Gets the y coord of the vector
`double`	`length()` Finds the length of the vector
`TwoDimensionalVector`	`midpoint(TwoDimensionalVector other)` Returns a vector representing the midpoint between the current vector and another
`TwoDimensionalVector`	`normalize()` Normalizes the vector to a length of 1 (all coords add up to one)
`TwoDimensionalVector`	`rotate(double angle)` Rotates the vector around the origin
`TwoDimensionalVector`	`rotate(TwoDimensionalVector center, double angle)` Rotates the vector around a given point
`void`	`setComponents(double x, double y)` Sets the coordinates
`TwoDimensionalVector`	`subtract(TwoDimensionalVector other)` Returns a new vector with the result of the specified vector minus this.
`ThreeDimensionalVector`	`to3D()` Converts this vector from a 2D plane to a 3D plane (with a z of 0)
`java.lang.String`	`toString()`

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

- Constructor Detail
  - TwoDimensionalVector
```
public TwoDimensionalVector(double x,
                    double y)
```
    Default constructor
    
    Parameters:
    x - X coordinate
    y - Y coordinate
- Method Detail
  - setComponents
```
public void setComponents(double x,
                 double y)
```
    Sets the coordinates
    
    Parameters:
    x - X coordinate
    y - Y coordinate
  - getRoundedX
```
public int getRoundedX()
```
    Returns the x coord as an int
    
    Returns:
    The rounded x coord
  - getRoundedY
```
public int getRoundedY()
```
    Returns the y coord as an int
    
    Returns:
    The rounded y coord
  - getX
```
public double getX()
```
    Gets the x coord of the vector
    
    Returns:
    The coord
  - getY
```
public double getY()
```
    Gets the y coord of the vector
    
    Returns:
    The coord
  - subtract
```
public TwoDimensionalVector subtract(TwoDimensionalVector other)
```
    Returns a new vector with the result of the specified vector minus this.
    
    Parameters:
    other - The vector to subtract from
    
    Returns:
    New vector
  - add
```
public TwoDimensionalVector add(TwoDimensionalVector other)
```
    Returns a new vector with the result of the specified vector plus this.
    
    Parameters:
    other - The vector to add to
    
    Returns:
    New vector
  - normalize
```
public TwoDimensionalVector normalize()
```
    Normalizes the vector to a length of 1 (all coords add up to one)
    
    Returns:
    Normalized vector
  - dotProduct
```
public double dotProduct()
```
    Finds the dot product of the current vector and itself
    
    Returns:
    The dot product
  - dotProduct
```
public double dotProduct(TwoDimensionalVector other)
```
    Finds the dot product of the current vector and the other specified vector
    
    Parameters:
    other - The other vector
    
    Returns:
    The dot product
  - distanceTo
```
public double distanceTo(TwoDimensionalVector other)
```
    Finds the distance between two vectors
    
    Parameters:
    other - The other vector
    
    Returns:
    The distance
  - length
```
public double length()
```
    Finds the length of the vector
    
    Returns:
    The length
  - midpoint
```
public TwoDimensionalVector midpoint(TwoDimensionalVector other)
```
    Returns a vector representing the midpoint between the current vector and another
    
    Parameters:
    other - The other vector
    
    Returns:
    The midpoint
  - rotate
```
public TwoDimensionalVector rotate(TwoDimensionalVector center,
                          double angle)
```
    Rotates the vector around a given point
    
    Parameters:
    center - The point to rotate around
    angle - The angle to rotate by
    
    Returns:
    The rotated vector
  - rotate
```
public TwoDimensionalVector rotate(double angle)
```
    Rotates the vector around the origin
    
    Parameters:
    angle - The angle to rotate by
    
    Returns:
    The rotated vector
  - to3D
```
public ThreeDimensionalVector to3D()
```
    Converts this vector from a 2D plane to a 3D plane (with a z of 0)
    
    Returns:
    The converted vector
  - 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
  - compareTo
```
public int compareTo(java.lang.Object o)
```
    Specified by:
    
    compareTo in interface java.lang.Comparable

Class TwoDimensionalVector

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

TwoDimensionalVector

Method Detail

setComponents

getRoundedX

getRoundedY

getX

getY

subtract

add

normalize

dotProduct

dotProduct

distanceTo

length

midpoint

rotate

rotate

to3D

equals

toString

compareTo