Package etomica.math.geometry

Class Square

java.lang.Object

etomica.math.geometry.Polytope

etomica.math.geometry.Polygon

etomica.math.geometry.Square

All Implemented Interfaces:

Shape

public class Square
extends Polygon

A 2-dimensional geometric square.

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
Square(Space embeddedSpace)	Constructs a square of unit size.
Square(Space embeddedSpace, double size)	Constructs a square with edge length having the given value.

Method Summary

Modifier and Type	Method	Description
boolean	contains(Vector v)	Returns true if the given vector lies inside (or on the surface of) this cell, false otherwise.
double	getArea()	Returns edgeLength^2.
double	getEdgeLength()
void	setEdgeLength(double edgeLength)
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

Square

public Square(Space embeddedSpace)

Constructs a square of unit size.

Square

public Square(Space embeddedSpace,
              double size)

Constructs a square with edge length having the given value.

Parameters:

size - edge length of the cube

Method Detail

getArea

public double getArea()

Returns edgeLength^2.

Specified by:

getArea in class Polygon

contains

public boolean contains(Vector v)

Returns true if the given vector lies inside (or on the surface of) this cell, false otherwise.

Specified by:

contains in interface Shape

Specified by:

contains in class Polytope

getEdgeLength

public double getEdgeLength()

Returns:

the length the edge of the square.

setEdgeLength

public void setEdgeLength(double edgeLength)

Parameters:

edgeLength - the new length of the sides of the square

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