Package etomica.math.geometry

Class Rectangle

java.lang.Object

etomica.math.geometry.Polytope

etomica.math.geometry.Polygon

etomica.math.geometry.Rectangle

All Implemented Interfaces:

Rectangular, Shape

public class Rectangle
extends Polygon
implements Rectangular

A 2-dimensional geometric rectangle.

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
Rectangle(Space embeddedSpace)	Constructs a square rectangle of unit size.
Rectangle(Space embeddedSpace, double xLength, double yLength)	Constructs a rectangle with edge lengths having the given values.

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 the area enclosed by the rectangle.
Vector	getEdgeLengths()	Returns a vector with elements equal to the edge lengths of the rectangle.
double	getPerimeter()	Returns the perimeter of the rectangle.
protected void	setEdgeLengths(double edgeLengthX, double edgeLengthY)
void	setEdgeLengths(Vector e)	Sets the two edge lengths of the rectangle, taking each element of the given vector for the length of the corresponding rectangle edge.
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, getVolume

Methods inherited from class etomica.math.geometry.Polytope

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

Constructor Detail

Rectangle

public Rectangle(Space embeddedSpace)

Constructs a square rectangle of unit size.

Rectangle

public Rectangle(Space embeddedSpace,
                 double xLength,
                 double yLength)

Constructs a rectangle with edge lengths having the given values.

Method Detail

getArea

public double getArea()

Returns the area enclosed by the rectangle.

Specified by:

getArea in class Polygon

getPerimeter

public double getPerimeter()

Returns the perimeter of the rectangle.

Overrides:

getPerimeter 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

setEdgeLengths

public void setEdgeLengths(Vector e)

Sets the two edge lengths of the rectangle, taking each element of the given vector for the length of the corresponding rectangle edge.

Specified by:

setEdgeLengths in interface Rectangular

getEdgeLengths

public Vector getEdgeLengths()

Returns a vector with elements equal to the edge lengths of the rectangle. The returned vector is not used to represent the rectangle internally, so changing its values will not affect the state of the rectangle.

Specified by:

getEdgeLengths in interface Rectangular

Returns:

the D edge lengths as the elements of the vector.

setEdgeLengths

protected void setEdgeLengths(double edgeLengthX,
                              double edgeLengthY)

Parameters:

edgeLengthX - the new length of the sides of the square

edgeLengthY - 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