org.jmol.jvxl.api
Interface VertexDataServer

All Known Subinterfaces:

MeshDataServer

All Known Implementing Classes:

ApbsReader, AtomDataReader, AtomPropertyMapper, CastepDensityReader, Contact, CubeReader, Dsn6BinaryReader, EfvetReader, IsoFxyReader, IsoFxyzReader, IsoIntersectReader, IsoMepReader, IsoMlpReader, IsoMOReader, IsoPlaneReader, IsoShapeReader, IsoSolventReader, Isosurface, JaguarReader, JvxlReader, JvxlXmlReader, KinemageReader, LcaoCartoon, MapFileReader, MolecularOrbital, MrcBinaryReader, MsmsReader, ObjReader, Plot3D, PltFormattedReader, Pmesh, PmeshReader, PolygonFileReader, SurfaceFileReader, SurfaceReader, VolumeDataReader, VolumeFileReader, XplorReader

public interface VertexDataServer

Method Summary

int	addTriangleCheck(int iA, int iB, int iC, int check, int check2, boolean isAbsolute, int color) addTriangleCheck adds a triangle along with a 3-bit check indicating which edges to draw in mesh mode: 1 (iA-iB) + 2 (iB-iC) + 4 (iC-iA)
int	addVertexCopy(Point3f vertexXYZ, float value, int assocVertex) addVertexCopy is used by the Marching Squares algorithm to uniquely identify a new vertex when an edge is crossed in the 2D plane.
float[]	getPlane(int x)
int	getSurfacePointIndexAndFraction(float cutoff, boolean isCutoffAbsolute, int x, int y, int z, Point3i offset, int vertexA, int vertexB, float valueA, float valueB, Point3f pointA, Vector3f edgeVector, boolean isContourType, float[] fReturn) getSurfacePointIndex is used by the Marching Cubes algorithm and must return a unique integer identifier for a vertex created by the Marching Cube algorithm when it finds an edge.
float	getValue(int x, int y, int z, int ptyz) for readers only

Method Detail

getSurfacePointIndexAndFraction

int getSurfacePointIndexAndFraction(float cutoff,
                                    boolean isCutoffAbsolute,
                                    int x,
                                    int y,
                                    int z,
                                    Point3i offset,
                                    int vertexA,
                                    int vertexB,
                                    float valueA,
                                    float valueB,
                                    Point3f pointA,
                                    Vector3f edgeVector,
                                    boolean isContourType,
                                    float[] fReturn)

getSurfacePointIndex is used by the Marching Cubes algorithm and must return a unique integer identifier for a vertex created by the Marching Cube algorithm when it finds an edge. If a vertex is discarded, then Integer.MAX_VALUE should be returned. the 3D coordinate of the point can be calculated using surfacePoint.scaleAdd(fraction, edgeVector, pointA); where fraction is generally calculated as: fraction = (cutoff - valueA) / (valueB - valueA); if (isCutoffAbsolute && (fraction < 0 || fraction > 1)) fraction = (-cutoff - valueA) / (valueB - valueA); This method is also used by MarchingCubes to deliver the appropriate oblique planar coordinate to MarchingSquares for later contouring.

Parameters:

cutoff -

isCutoffAbsolute -

x -

y -

z -

offset -

vertexA - [0:7]

vertexB - [0:7]

valueA -

valueB -

pointA -

edgeVector - vector from A to B

isContourType -

fReturn -

Returns:

new vertex index or Integer.MAX_VALUE

addVertexCopy

int addVertexCopy(Point3f vertexXYZ,
                  float value,
                  int assocVertex)

addVertexCopy is used by the Marching Squares algorithm to uniquely identify a new vertex when an edge is crossed in the 2D plane. The implementing method should COPY the Point3f using Point3f.set(). The data consumer can use the association key to group this vertex with others near the same gridpoint.

Parameters:

vertexXYZ -

value -

assocVertex - unique association vertex or -1

Returns:

new vertex index

addTriangleCheck

int addTriangleCheck(int iA,
                     int iB,
                     int iC,
                     int check,
                     int check2,
                     boolean isAbsolute,
                     int color)

addTriangleCheck adds a triangle along with a 3-bit check indicating which edges to draw in mesh mode: 1 (iA-iB) + 2 (iB-iC) + 4 (iC-iA)

Parameters:

iA -

iB -

iC -

check -

check2 - TODO

isAbsolute -

color -

Returns:

polygon index or -1

getValue

float getValue(int x,
               int y,
               int z,
               int ptyz)

for readers only

Parameters:

x -

y -

z -

ptyz -

Returns:

value[x][y][z]

Throws:

Exception

getPlane

float[] getPlane(int x)