public abstract class BaseVoronoiFace extends java.lang.Object implements java.lang.Comparable<BaseVoronoiFace>
Modifier and Type | Field and Description |
---|---|
protected java.util.List<BaseVoronoiEdge> |
Edges
Edges defining this face
|
protected double |
FaceArea
Face area.
|
protected org.apache.commons.math3.geometry.euclidean.threed.Vector3D |
FaceCenter
Center of the face
|
protected double |
FaceDistance
Distance from cell center to face
|
protected org.apache.commons.math3.geometry.euclidean.threed.Vector3D |
FaceNormal
Normal of face
|
protected org.apache.commons.math3.geometry.euclidean.threed.Plane |
FacePlane
Plane of face
|
protected Atom |
InsideAtom
Atom on "inside" of this face
|
protected AtomImage |
OutsideAtom
Atom on the "outside" of this face
|
protected java.util.List<BaseVoronoiVertex> |
Vertices
Vertices associated with this face
|
Constructor and Description |
---|
BaseVoronoiFace(Atom insideAtom,
AtomImage outsideAtom,
boolean radical)
Create a blank Voronoi face
|
Modifier and Type | Method and Description |
---|---|
int |
compareTo(BaseVoronoiFace o) |
boolean |
equals(java.lang.Object obj) |
double |
getArea()
Determine the surface area of this face
|
org.apache.commons.math3.geometry.euclidean.threed.Vector3D |
getCentroid()
Get the centroid of this face
|
java.util.Set<BaseVoronoiVertex> |
getCommonVertices(BaseVoronoiFace otherFace)
Get number of common vertices between two faces
|
java.util.List<BaseVoronoiEdge> |
getEdges()
Get the edges that form this face
|
org.apache.commons.math3.geometry.euclidean.threed.Vector3D |
getFaceCenter()
Get center of this face
|
double |
getFaceDistance()
Get distance from center of the cell to this face.
|
Atom |
getInsideAtom()
Get the atom on the inside of this face
|
double |
getNeighborDistance()
Get distance between central atom and neighbor associated with this face
|
java.util.Set<BaseVoronoiFace> |
getNeighboringFaces()
Get all faces that share a vertex with this face
|
org.apache.commons.math3.geometry.euclidean.threed.Vector3D |
getNormal()
Get normal to this face
|
AtomImage |
getOutsideAtom()
Get identifying information about atom on other side of this face.
|
org.apache.commons.math3.geometry.euclidean.threed.Plane |
getPlane()
Get the plane on which this face lies
|
protected static double |
getPlaneDistance(double radius1,
double radius2,
double d)
Get distance from the center to the closest-point on a radical plane dividing
two atoms.
|
java.util.Iterator<BaseVoronoiVertex> |
getVertexIterator()
Get vertex iterator.
|
java.util.List<BaseVoronoiVertex> |
getVertices()
Get the list of vertices describing this face.
|
int |
hashCode() |
abstract boolean |
isClosed()
Test whether the edges form a closed face.
|
int |
NEdges()
Get the number of edges this face has
|
int |
nVertices()
Compute number of vertices
|
int |
positionRelativeToFace(org.apache.commons.math3.geometry.euclidean.threed.Vector3D point)
Get position of point with respect to face.
|
java.lang.String |
toString() |
protected org.apache.commons.math3.geometry.euclidean.threed.Plane FacePlane
protected org.apache.commons.math3.geometry.euclidean.threed.Vector3D FaceNormal
protected final java.util.List<BaseVoronoiEdge> Edges
protected final java.util.List<BaseVoronoiVertex> Vertices
protected final Atom InsideAtom
protected final AtomImage OutsideAtom
protected double FaceDistance
protected org.apache.commons.math3.geometry.euclidean.threed.Vector3D FaceCenter
protected double FaceArea
protected static double getPlaneDistance(double radius1, double radius2, double d)
radius1
- Radius of atom #1radius2
- Radius of atom #2d
- Distance between atomspublic boolean equals(java.lang.Object obj)
equals
in class java.lang.Object
public int hashCode()
hashCode
in class java.lang.Object
public int compareTo(BaseVoronoiFace o)
compareTo
in interface java.lang.Comparable<BaseVoronoiFace>
public Atom getInsideAtom()
public org.apache.commons.math3.geometry.euclidean.threed.Vector3D getFaceCenter()
public AtomImage getOutsideAtom()
public org.apache.commons.math3.geometry.euclidean.threed.Plane getPlane()
public org.apache.commons.math3.geometry.euclidean.threed.Vector3D getNormal()
public int NEdges()
public double getArea()
public org.apache.commons.math3.geometry.euclidean.threed.Vector3D getCentroid()
public double getFaceDistance()
public double getNeighborDistance()
public java.util.List<BaseVoronoiVertex> getVertices()
public int nVertices()
public java.util.Iterator<BaseVoronoiVertex> getVertexIterator()
public java.util.List<BaseVoronoiEdge> getEdges()
public java.util.Set<BaseVoronoiFace> getNeighboringFaces()
public java.util.Set<BaseVoronoiVertex> getCommonVertices(BaseVoronoiFace otherFace)
otherFace
- Other facepublic int positionRelativeToFace(org.apache.commons.math3.geometry.euclidean.threed.Vector3D point)
point
- Point in questionpublic java.lang.String toString()
toString
in class java.lang.Object
public abstract boolean isClosed()