Package etomica.math.geometry

Class LineSegment

java.lang.Object

etomica.math.geometry.Polytope

etomica.math.geometry.LineSegment

All Implemented Interfaces:

Rectangular, Shape

public class LineSegment
extends Polytope
implements Rectangular

A geometrical line segment, a 1-dimensional polytope.

See Also:

Serialized Form

Field Summary

Fields inherited from class etomica.math.geometry.Polytope

D, embeddedSpace, hyperPlanes, position, vertices

Constructor Summary

Constructors

Constructor	Description
LineSegment(Space embeddedSpace)

Method Summary

Modifier and Type	Method	Description
boolean	contains(Vector v)	Returns true if the given vector lies between the ends of the segment, on the line joining them.
Vector	getEdgeLengths()	Returns the length of the line segment as the element of a 1D vector.
LineSegment[]	getEdges()
double	getLength()
Vector[]	getVertices()	Returns an array of all vertices of the polytrope.
double	getVolume()	Returns the (hyper)volume enclosed by the polytope.
static void	main(java.lang.String[] args)
void	setEdgeLengths(Vector v)	Sets the length equal to the element of the (presumably 1D) vector.
void	setLength(double newLength)	Sets the length of the segment to the given value, keeping its orientation and the position of its midpoint fixed.
void	setVertex1(Vector newVertex1)
void	setVertex2(Vector newVertex2)
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.Polytope

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

Constructor Detail

LineSegment

public LineSegment(Space embeddedSpace)

Method Detail

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

getVertices

public Vector[] getVertices()

Description copied from class: Polytope

Returns an array of all vertices of the polytrope. For most subclasses this array will not provide the direct representation of the polytope. Instead polytope will be defined in another internal representation, which is used to calculate the vertices via the updateVertices method. In a few subclasses the vertices are the representation, so alteration of the returned array will change the polytope.

Overrides:

getVertices in class Polytope

contains

public boolean contains(Vector v)

Returns true if the given vector lies between the ends of the segment, on the line joining them. Point must lie exactly on the line to return true, so rounding error will in most cases lead to return of false unless embedded in a 1D space.

Specified by:

contains in interface Shape

Specified by:

contains in class Polytope

getVolume

public double getVolume()

Description copied from class: Polytope

Returns the (hyper)volume enclosed by the polytope. So for a LineSegment instance, this is its length; for a polygon, it is the area; for a polyhedron, it is the volume.

Specified by:

getVolume in interface Shape

Specified by:

getVolume in class Polytope

setVertex1

public void setVertex1(Vector newVertex1)

setVertex2

public void setVertex2(Vector newVertex2)

getLength

public double getLength()

setLength

public void setLength(double newLength)

Sets the length of the segment to the given value, keeping its orientation and the position of its midpoint fixed.

setEdgeLengths

public void setEdgeLengths(Vector v)

Sets the length equal to the element of the (presumably 1D) vector. Implementation of Rectangular interface.

Specified by:

setEdgeLengths in interface Rectangular

getEdgeLengths

public Vector getEdgeLengths()

Returns the length of the line segment as the element of a 1D vector. Implmentation of the Rectangular interface.

Specified by:

getEdgeLengths in interface Rectangular

Returns:

the D edge lengths as the elements of the vector.

getEdges

public LineSegment[] getEdges()

Specified by:

getEdges in class Polytope

main

public static void main(java.lang.String[] args)