Package etomica.math.geometry

Class Polygon

java.lang.Object

etomica.math.geometry.Polytope

etomica.math.geometry.Polygon

All Implemented Interfaces:

Shape

Direct Known Subclasses:

Parallelogram, PolygonGeneral, Rectangle, Square

public abstract class Polygon
extends Polytope

Representation of a mathematical polygon, a 2-dimensional polytope. Contains all information needed to represent a polygon, methods to set its position and orientation, and methods that return an external representation of it. Provides no external means to change the polygon size and shape, as the form and capabilities of mutator methods are particular to the type of polygon defined by the subclass.

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
protected LineSegment[]	edges

Fields inherited from class etomica.math.geometry.Polytope

D, embeddedSpace, hyperPlanes, position, vertices

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	Polygon(LineSegment[] edges)	Constructs a polygon using the given edges for its sides.
protected	Polygon(Space embeddedSpace, int nSides)	Constructs a polygon with the given number of sides arranged in a closed loop.

Method Summary

Modifier and Type	Method	Description
abstract double	getArea()
LineSegment[]	getEdges()	Returns all edges defined by the polygon.
double	getPerimeter()	Returns the sum of the length of the edges of the polygon
double	getVolume()	Returns the 2-D volume of the polygon, which is its area

Methods inherited from class java.lang.Object

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

Methods inherited from class etomica.math.geometry.Polytope

applyTranslationRotation, contains, D, getEmbeddedSpace, getPosition, getVertexCount, getVertices, setPosition, toString, updateVertices

Field Detail

edges

protected final LineSegment[] edges

Constructor Detail

Polygon

protected Polygon(Space embeddedSpace,
                  int nSides)

Constructs a polygon with the given number of sides arranged in a closed loop.

Polygon

protected Polygon(LineSegment[] edges)

Constructs a polygon using the given edges for its sides.

Method Detail

getEdges

public LineSegment[] getEdges()

Returns all edges defined by the polygon.

Specified by:

getEdges in class Polytope

getVolume

public double getVolume()

Returns the 2-D volume of the polygon, which is its area

Specified by:

getVolume in interface Shape

Specified by:

getVolume in class Polytope

getPerimeter

public double getPerimeter()

Returns the sum of the length of the edges of the polygon

getArea

public abstract double getArea()