com.austinv11.collectiveframework.utils.math.geometry

Class Variable2DShape

java.lang.Object

com.austinv11.collectiveframework.utils.math.geometry.Variable2DShape

public class Variable2DShape
extends java.lang.Object

Class which represents a 2D shape with an indefinite amount of sides (until instantiation)

Constructor Summary

Constructors

Constructor and Description
Variable2DShape(Line... lines) Constructor for a 2D shape
Variable2DShape(TwoDimensionalVector... vectors) Constructor for a 2D shape

Method Summary

Methods

Modifier and Type	Method and Description
boolean	equals(java.lang.Object other)
Line[]	findSidesWithPoint(TwoDimensionalVector coord) Creates an array of sides from the shape where the side touches the given coord This should only ever return 0-2 lines
TwoDimensionalVector[]	getAllPoints() Deprecated.
float	getAngleForVertex(TwoDimensionalVector vertex) Finds the (internal) angle of the given vertex
double	getArea() Calculates the area of the shape
TwoDimensionalVector	getCentroid() Calculates the approximate center of the polygon
int	getNumberOfSides() Gets the number of sides for this shape
double	getPerimeter() Gets the perimeter of the shape
Line[]	getSides() Gets the lines representing the sides of the shape
TwoDimensionalVector[]	getVertices() Retrieves all points representing vertices on the shape
boolean	isPointOnPerimeter(TwoDimensionalVector coord) Checks if the provided point is on the shape's perimeter
boolean	isPointValid(TwoDimensionalVector coord) Deprecated.
Variable2DShape	rotate(double angle) Rotates the shape about its centroid
Variable2DShape	rotate(TwoDimensionalVector point, double angle) Rotates the shape around a point
Variable2DShape	setCentroid(TwoDimensionalVector centroid) Translates the whole shape to make a new shape with a matching centroid
java.lang.String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

Variable2DShape

public Variable2DShape(TwoDimensionalVector... vectors)
                throws IncompatibleDimensionsException

Constructor for a 2D shape

Parameters:

vectors - The vectors to form the shape with

Throws:

IncompatibleDimensionsException

Variable2DShape

public Variable2DShape(Line... lines)
                throws IncompatibleDimensionsException

Constructor for a 2D shape

Parameters:

lines - The lines to form the shape with

Throws:

IncompatibleDimensionsException

Method Detail

getNumberOfSides

public int getNumberOfSides()

Gets the number of sides for this shape

Returns:

The number of sides

getVertices

public TwoDimensionalVector[] getVertices()

Retrieves all points representing vertices on the shape

Returns:

The vertices

getPerimeter

public double getPerimeter()

Gets the perimeter of the shape

Returns:

The perimeter

getArea

public double getArea()

Calculates the area of the shape

Returns:

The area

findSidesWithPoint

public Line[] findSidesWithPoint(TwoDimensionalVector coord)

Creates an array of sides from the shape where the side touches the given coord This should only ever return 0-2 lines

Parameters:

coord - The coordinate point

Returns:

The sides

getAngleForVertex

public float getAngleForVertex(TwoDimensionalVector vertex)
                        throws IncompatibleDimensionsException

Finds the (internal) angle of the given vertex

Parameters:

vertex - The vertex

Returns:

The angle

Throws:

IncompatibleDimensionsException

getSides

public Line[] getSides()

Gets the lines representing the sides of the shape

Returns:

The sides

getCentroid

public TwoDimensionalVector getCentroid()

Calculates the approximate center of the polygon

Returns:

The center coordinates

setCentroid

public Variable2DShape setCentroid(TwoDimensionalVector centroid)

Translates the whole shape to make a new shape with a matching centroid

Parameters:

centroid - New centroid

Returns:

Modified shape

rotate

public Variable2DShape rotate(TwoDimensionalVector point,
                     double angle)

Rotates the shape around a point

Parameters:

point - The point to rotate around

angle - The angle to rotate by

Returns:

The new shape

rotate

public Variable2DShape rotate(double angle)

Rotates the shape about its centroid

Parameters:

angle - The angle to rotate by

Returns:

The new shape

isPointOnPerimeter

public boolean isPointOnPerimeter(TwoDimensionalVector coord)

Checks if the provided point is on the shape's perimeter

Parameters:

coord - The point

Returns:

If the point is on the perimeter

isPointValid

@Deprecated
public boolean isPointValid(TwoDimensionalVector coord)

Deprecated.

Checks if a point is inside the shape. DO NOT TRUST THIS- it is not always accurate, it is only 100% accurate with rectangles

Parameters:

coord - The point

Returns:

If the point is in the shape

getAllPoints

@Deprecated
public TwoDimensionalVector[] getAllPoints()

Deprecated.

Gets all the points in the shape (with whole number coords) WARNING- Deprecated because it uses isPointValid

Returns:

The points

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