com.austinv11.collectiveframework.utils.math.geometry

Class Circle

java.lang.Object

com.austinv11.collectiveframework.utils.math.geometry.Circle

public class Circle
extends java.lang.Object

A class which represents a 2D circle

Constructor Summary

Constructors

Constructor and Description
Circle(double radius) Constructor for a circle with the center at the origin
Circle(TwoDimensionalVector center, double radius) Constructor for a circle

Method Summary

Methods

Modifier and Type	Method and Description
double	getArea() Gets the area of the circle
TwoDimensionalVector	getCenter() Gets the center of the circle
double	getCircumference() Gets the circumference of the circle
double	getDiameter() Gets the diameter of the circle
double	getRadius() Gets the radius of the circle
boolean	isPointInCircle(TwoDimensionalVector point) Checks if the specified point is inside the circle
boolean	isPointOnCircumference(TwoDimensionalVector point) Checks if the specified point is on the circumference of the circle
Circle	setCenter(TwoDimensionalVector newCenter) Sets the center of the circle
Circle	setRadius(double newRadius) Sets the radius of the circle

Methods inherited from class java.lang.Object

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

Constructor Detail

Circle

public Circle(TwoDimensionalVector center,
      double radius)
       throws IncompatibleDimensionsException

Constructor for a circle

Parameters:

center - The center of the circle

radius - The radius for the circle

Throws:

IncompatibleDimensionsException

Circle

public Circle(double radius)
       throws IncompatibleDimensionsException

Constructor for a circle with the center at the origin

Parameters:

radius - The radius for the circle

Throws:

IncompatibleDimensionsException

Method Detail

getCenter

public TwoDimensionalVector getCenter()

Gets the center of the circle

Returns:

The center of the circle

getRadius

public double getRadius()

Gets the radius of the circle

Returns:

The radius

setCenter

public Circle setCenter(TwoDimensionalVector newCenter)

Sets the center of the circle

Parameters:

newCenter - The new center

Returns:

The modified circle

setRadius

public Circle setRadius(double newRadius)
                 throws IncompatibleDimensionsException

Sets the radius of the circle

Parameters:

newRadius - The new radius

Returns:

The modified circle

Throws:

IncompatibleDimensionsException

getDiameter

public double getDiameter()

Gets the diameter of the circle

Returns:

The diameter

getCircumference

public double getCircumference()

Gets the circumference of the circle

Returns:

The circumference

getArea

public double getArea()

Gets the area of the circle

Returns:

The area

isPointOnCircumference

public boolean isPointOnCircumference(TwoDimensionalVector point)

Checks if the specified point is on the circumference of the circle

Parameters:

point - The point

Returns:

If the point is on the circumference

isPointInCircle

public boolean isPointInCircle(TwoDimensionalVector point)

Checks if the specified point is inside the circle

Parameters:

point - The point

Returns:

If the point is in the circle