Package app.media

Class PolygonShape

java.lang.Object

app.media.Media

app.media.GenericShape

app.media.PolygonShape

All Implemented Interfaces:

Serializable

public class PolygonShape
extends GenericShape

An implementation of GenericShape representing a polygon

We assume the polygon is a regular shape, i.e. that each interior angle and each side length are the same.

See Also:

• Serialized Form

Property Summary

Properties inherited from class app.media.Media

angle, height, name, width, x, y, zIndex

Field Summary

Fields inherited from class app.media.Media

EMPTY_ID

Constructor Summary

Constructors

Constructor	Description
PolygonShape(javafx.geometry.Point2D p1, javafx.geometry.Point2D p2, String colour, double radius, double startAngle, int sideCount)	Initializes a polygon with the following settings

Method Summary

Modifier and Type	Method	Description
double	getRadius()	Returns the radius of the polygon
int	getSideCount()	Returns the number of sides of the polygon
double	getStartAngle()	Returns the starting angle of the polygon
void	setRadius(double radius)	Sets the radius of the polygon
void	setSideCount(int sideCount)	Sets the side count of the polygon
void	setStartAngle(double startAngle)	Sets the starting angle of the polygon
String	toString()	Returns the shape's type, position, dimensions and color

Methods inherited from class app.media.GenericShape

getColour, getP1, getP2, setColour, setP1, setP2

Methods inherited from class app.media.Media

angleProperty, getAngle, getHeight, getID, getName, getTags, getWidth, getX, getY, getZindex, heightProperty, isWithin, nameProperty, setAngle, setHeight, setID, setName, setTags, setWidth, setX, setY, setZindex, widthProperty, xProperty, yProperty, zIndexProperty

Methods inherited from class java.lang.Object

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

Constructor Details

PolygonShape

public PolygonShape(javafx.geometry.Point2D p1,
 javafx.geometry.Point2D p2,
 String colour,
 double radius,
 double startAngle,
 int sideCount)

Initializes a polygon with the following settings

Parameters:

p1 - The position of the polygon's center

p2 - The position which determines the polygon's radius and starting angle

colour - The shape's color

radius - The shape's radius

startAngle - The shape's starting angle

sideCount - The number of sides the shape has

Method Details

getRadius

public double getRadius()

Returns the radius of the polygon

Since the polygons are all regular shapes, this represents the distance from its center towards any vertex

Returns:

The radius of the polygon

getStartAngle

public double getStartAngle()

Returns the starting angle of the polygon

More specifically, this is the angle the polygon is rotationally offset by

Returns:

The rotational offset of the polygon

getSideCount

public int getSideCount()

Returns the number of sides of the polygon

Returns:

the number of sides of the polygon

setRadius

public void setRadius(double radius)

Sets the radius of the polygon

Parameters:

radius - The desired new radius of the polygon

setStartAngle

public void setStartAngle(double startAngle)

Sets the starting angle of the polygon

More specifically, this is the angle the Polygon is to be rotationally offset by

Parameters:

startAngle - The desired new rotational offset of the Polygon

setSideCount

public void setSideCount(int sideCount)

Sets the side count of the polygon

Parameters:

sideCount - The new number of sides the polygon should have

toString

public String toString()

Returns the shape's type, position, dimensions and color

Additionally, returns the starting angular offset and side count (unique to polygon)

Overrides:

toString in class Media

Returns:

the shape's type, position, dimensions and color