Package etomica.math.geometry

Interface Shape

All Known Implementing Classes:

Circle, Cube, Cuboid, Hexahedron, Hypersphere, LineSegment, Parallelepiped, Parallelogram, Point, Polygon, PolygonGeneral, Polyhedron, PolyhedronGeneral, Polytope, Rectangle, Sphere, Square, TruncatedOctahedron

public interface Shape

Interface for an object that defines a closed region of space.

Method Summary

Modifier and Type	Method	Description
boolean	contains(Vector r)	Returns true if the point described by the vector lies in or on the enclosed region.
int	D()	Returns the spatial dimension of the shape.
double	getVolume()	Returns the (hyper-)volume of the enclosed region.
void	setPosition(Vector r)	Sets the position of the shape, which typically represents some central point within it.

Method Detail

getVolume

double getVolume()

Returns the (hyper-)volume of the enclosed region. In 1D this is a length, in 2D it is an area, in 3D it is a volume.

contains

boolean contains(Vector r)

Returns true if the point described by the vector lies in or on the enclosed region.

setPosition

void setPosition(Vector r)

Sets the position of the shape, which typically represents some central point within it. Specific definition depends on the definition of the shape.

D

int D()

Returns the spatial dimension of the shape. For example, D = 2 for a square, D = 3 for a cube.