Package etomica.math.geometry

Class PolygonGeneral

java.lang.Object

etomica.math.geometry.Polytope

etomica.math.geometry.Polygon

etomica.math.geometry.PolygonGeneral

All Implemented Interfaces:

Shape

public class PolygonGeneral
extends Polygon

TODO To change the template for this generated type comment go to Window - Preferences - Java - Code Style - Code Templates

See Also:

Serialized Form

Field Summary

Fields inherited from class etomica.math.geometry.Polygon

edges

Fields inherited from class etomica.math.geometry.Polytope

D, embeddedSpace, hyperPlanes, position, vertices

Constructor Summary

Constructors

Constructor	Description
PolygonGeneral(LineSegment[] edges)
PolygonGeneral(Space embeddedSpace, int nSides)

Method Summary

Modifier and Type	Method	Description
boolean	contains(Vector vector)	Returns true if the given point lies inside or on an edge of the polygon
double	getArea()	Returns the value of the area enclosed by the polygon
void	updateVertices()	This method should be defined by the subclass to calculate the vertices in accordance with the internal representation of the polytope.

Methods inherited from class java.lang.Object

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

Methods inherited from class etomica.math.geometry.Polygon

getEdges, getPerimeter, getVolume

Methods inherited from class etomica.math.geometry.Polytope

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

Constructor Detail

PolygonGeneral

public PolygonGeneral(Space embeddedSpace,
                      int nSides)

Parameters:

embeddedSpace -

nSides -

PolygonGeneral

public PolygonGeneral(LineSegment[] edges)

Parameters:

edges -

Method Detail

getArea

public double getArea()

Returns the value of the area enclosed by the polygon

Specified by:

getArea in class Polygon

contains

public boolean contains(Vector vector)

Returns true if the given point lies inside or on an edge of the polygon

Specified by:

contains in interface Shape

Specified by:

contains in class Polytope

updateVertices

public void updateVertices()

Description copied from class: Polytope

This method should be defined by the subclass to calculate the vertices in accordance with the internal representation of the polytope. If the internal representation is kept by the vertices themselves, then this method need do nothing; if this method applies another internal representation to the vertices (for example, it might represent a square by keeping the edge length), it should then invoke applyTranslationRotation() before returning. Subclass methods allowing mutation of the internal representation should invoke updateVertices to ensure the vertices reflect the internal state. Vertices may be changed directly, but these changes will overridden by updateVertices if it is called afterwards.

Specified by:

updateVertices in class Polytope