org.jmol.export
Class Export3D

java.lang.Object
  org.jmol.export.Export3D

All Implemented Interfaces:

JmolRendererInterface

public final class Export3D
extends Object
implements JmolRendererInterface

Provides high-level graphics primitives for 3D graphics export.

Author:

hansonr, hansonr@stolaf.edu

Field Summary

private short	colix
private ___Exporter	exporter
(package private) String	exportName
private Graphics3D	g3d
private int	height
private Hermite3D	hermite3d
private double	privateKey
private Point3f	ptA
private Point3i	ptAi
private Point3f	ptB
private Point3i	ptBi
private Point3f	ptC
private Point3f	ptD
private int	slab
private int	width

Constructor Summary

Export3D()

Method Summary

boolean	checkTranslucent(boolean isAlphaTranslucent)
int	clipCode(int x, int y, int z)
void	drawAtom(Atom atom)
void	drawBond(Atom atomA, Atom atomB, short colixA, short colixB, byte endcaps, short mad)
void	drawCircle(short colix, int diameter, int x, int y, int z, boolean doFill) draws a simple circle (draw circle)
void	drawDashedLine(int run, int rise, Point3i pointA, Point3i pointB)
void	drawDottedLine(Point3i pointA, Point3i pointB)
boolean	drawEllipse(Point3f ptAtom, Point3f ptX, Point3f ptY, boolean fillArc, boolean wireframeOnly)
void	drawFilledCircle(short colixRing, short colixFill, int diameter, int x, int y, int z) draws a screened circle ...
void	drawHermite(boolean fill, boolean border, int tension, Point3i s0, Point3i s1, Point3i s2, Point3i s3, Point3i s4, Point3i s5, Point3i s6, Point3i s7, int aspectRatio)
void	drawHermite(int tension, Point3i s0, Point3i s1, Point3i s2, Point3i s3)
private void	drawHLine(int x, int y, int z, int w)
void	drawImage(Object objImage, int x, int y, int z, int zSlab, short bgcolix, int width, int height)
void	drawLine(int x1, int y1, int z1, int x2, int y2, int z2)
void	drawLine(Point3i pointA, Point3i pointB)
void	drawLine(short colixA, short colixB, int xA, int yA, int zA, int xB, int yB, int zB)
void	drawPixel(int x, int y, int z)
void	drawPoints(int count, int[] coordinates, int scale)
void	drawQuadrilateral(short colix, Point3i pointA, Point3i pointB, Point3i pointC, Point3i screenD)
void	drawRect(int x, int y, int z, int zSlab, int rWidth, int rHeight) draws a rectangle
void	drawString(String str, Font3D font3d, int xBaseline, int yBaseline, int z, int zSlab) draws the specified string in the current font.
void	drawStringNoSlab(String str, Font3D font3d, int xBaseline, int yBaseline, int z) draws the specified string in the current font.
void	drawSurface(MeshSurface meshSurface, short colix)
void	drawTriangle(Point3i screenA, Point3i screenB, Point3i screenC, int check)
void	drawTriangle(Point3i screenA, short colixA, Point3i screenB, short colixB, Point3i screenC, short colixC, int check)
private void	drawVLine(int x, int y, int z, int h)
void	fillConeSceen(byte endcap, int screenDiameter, Point3f pointBase, Point3f screenTip)
void	fillConeScreen(byte endcap, int screenDiameter, Point3i pointBase, Point3i screenTip, boolean isBarb)
void	fillCylinder(byte endcaps, int diameter, Point3i pointA, Point3i pointB)
void	fillCylinder(short colixA, short colixB, byte endcaps, int mad, int xA, int yA, int zA, int xB, int yB, int zB)
void	fillCylinderBits(byte endcaps, int diameter, Point3f pointA, Point3f pointB)
void	fillCylinderScreen(byte endcaps, int screenDiameter, int xA, int yA, int zA, int xB, int yB, int zB)
void	fillCylinderScreen(byte endcaps, int diameter, Point3i pointA, Point3i pointB)
void	fillEllipsoid(Point3f center, Point3f[] points, int x, int y, int z, int diameter, Matrix3f mToEllipsoidal, double[] coef, Matrix4f mDeriv, int selectedOctant, Point3i[] octantPoints)
void	fillHermite(int tension, int diameterBeg, int diameterMid, int diameterEnd, Point3i s0, Point3i s1, Point3i s2, Point3i s3)
void	fillQuadrilateral(Point3f pointA, Point3f pointB, Point3f pointC, Point3f pointD)
void	fillQuadrilateral(Point3i pointA, short colixA, short normixA, Point3i pointB, short colixB, short normixB, Point3i pointC, short colixC, short normixC, Point3i screenD, short colixD, short normixD)
void	fillRect(int x, int y, int z, int zSlab, int widthFill, int heightFill) fills background rectangle for label
void	fillSphere(int diameter, int x, int y, int z) fills a solid sphere
void	fillSphere(int diameter, Point3f center) fills a solid sphere
void	fillSphere(int diameter, Point3i center) fills a solid sphere
void	fillTriangle(Point3f pointA, Point3f pointB, Point3f pointC)
void	fillTriangle(Point3i pointA, Point3i pointB, Point3i pointC)
void	fillTriangle(Point3i pointA, short colixA, short normixA, Point3i pointB, short colixB, short normixB, Point3i pointC, short colixC, short normixC)
void	fillTriangle(Point3i pointA, short colixA, short normixA, Point3i pointB, short colixB, short normixB, Point3i pointC, short colixC, short normixC, float factor)
void	fillTriangleTwoSided(short normix, int xpointA, int ypointA, int zpointA, int xpointB, int ypointB, int zpointB, int xpointC, int ypointC, int zpointC)
String	finalizeOutput()
short[]	getBgColixes(short[] bgcolixes)
int	getColorArgbOrGray(short colix)
int	getDepth() gets g3d depth
String	getExportName()
int	getExportType()
Font3D	getFont3DCurrent()
Font3D	getFont3DScaled(Font3D font, float scale)
byte	getFontFid(float fontSize)
byte	getFontFid(String fontFace, float fontSize)
double	getPrivateKey()
int	getRenderHeight() gets g3d height
int	getRenderWidth() gets g3d width
int	getSlab() gets g3d slab
Vector3f[]	getTransformedVertexVectors()
boolean	haveTranslucentObjects()
boolean	initializeExporter(String type, Viewer viewer, double privateKey, Graphics3D g3d, Object output)
boolean	isAntialiased() is full scene / oversampling antialiasing in effect
protected boolean	isClipped(int x, int y)
boolean	isClipped(int x, int y, int z)
boolean	isClippedXY(int diameter, int x, int y)
boolean	isClippedZ(int z)
boolean	isDirectedTowardsCamera(short normix)
boolean	isInDisplayRange(int x, int y)
boolean	isPass2()
(package private) void	plotPixelClipped(int x, int y, int z)
void	plotPixelClipped(Point3i screen)
void	plotPixelClippedNoSlab(int argb, int x, int y, int z)
void	renderBackground()
boolean	setColix(short colix) sets current color from colix color index
void	setColor(int color)
void	setFont(byte fid)
void	setNoisySurfaceShade(Point3i pointA, Point3i pointB, Point3i pointC)
void	setSlab(int slabValue)
void	setTranslucentCoverOnly(boolean TF)
void	volumeRender(boolean TF)
void	volumeRender(int diam, int x, int y, int z)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

exporter

private ___Exporter exporter

privateKey

private double privateKey

g3d

private Graphics3D g3d

colix

private short colix

hermite3d

private Hermite3D hermite3d

width

private int width

height

private int height

slab

private int slab

exportName

String exportName

ptA

private Point3f ptA

ptB

private Point3f ptB

ptC

private Point3f ptC

ptD

private Point3f ptD

ptAi

private Point3i ptAi

ptBi

private Point3i ptBi

Constructor Detail

Export3D

public Export3D()

Method Detail

getExportType

public int getExportType()

Specified by:

getExportType in interface JmolRendererInterface

getExportName

public String getExportName()

Specified by:

getExportName in interface JmolRendererInterface

initializeExporter

public boolean initializeExporter(String type,
                                  Viewer viewer,
                                  double privateKey,
                                  Graphics3D g3d,
                                  Object output)

Specified by:

initializeExporter in interface JmolRendererInterface

finalizeOutput

public String finalizeOutput()

Specified by:

finalizeOutput in interface JmolRendererInterface

setSlab

public void setSlab(int slabValue)

Specified by:

setSlab in interface JmolRendererInterface

renderBackground

public void renderBackground()

Specified by:

renderBackground in interface JmolRendererInterface

drawAtom

public void drawAtom(Atom atom)

Specified by:

drawAtom in interface JmolRendererInterface

drawFilledCircle

public void drawFilledCircle(short colixRing,
                             short colixFill,
                             int diameter,
                             int x,
                             int y,
                             int z)

draws a screened circle ... every other dot is turned on

Specified by:

drawFilledCircle in interface JmolRendererInterface

Parameters:

colixRing -

colixFill -

diameter -

x - center x

y - center y

z - center z

drawCircle

public void drawCircle(short colix,
                       int diameter,
                       int x,
                       int y,
                       int z,
                       boolean doFill)

draws a simple circle (draw circle)

Parameters:

colix - the color index

diameter - the pixel diameter

x - center x

y - center y

z - center z

doFill - (not implemented in exporters)

fillSphere

public void fillSphere(int diameter,
                       int x,
                       int y,
                       int z)

fills a solid sphere

Specified by:

fillSphere in interface JmolRendererInterface

Parameters:

diameter - pixel count

x - center x

y - center y

z - center z

fillSphere

public void fillSphere(int diameter,
                       Point3i center)

fills a solid sphere

Specified by:

fillSphere in interface JmolRendererInterface

Parameters:

diameter - pixel count

center - javax.vecmath.Point3i defining the center

fillSphere

public void fillSphere(int diameter,
                       Point3f center)

fills a solid sphere

Specified by:

fillSphere in interface JmolRendererInterface

Parameters:

diameter - pixel count

center - a javax.vecmath.Point3f ... floats are casted to ints

drawRect

public void drawRect(int x,
                     int y,
                     int z,
                     int zSlab,
                     int rWidth,
                     int rHeight)

draws a rectangle

Specified by:

drawRect in interface JmolRendererInterface

Parameters:

x - upper left x

y - upper left y

z - upper left z

zSlab - z for slab check (for set labelsFront)

rWidth - pixel count

rHeight - pixel count

drawHLine

private void drawHLine(int x,
                       int y,
                       int z,
                       int w)

drawVLine

private void drawVLine(int x,
                       int y,
                       int z,
                       int h)

fillRect

public void fillRect(int x,
                     int y,
                     int z,
                     int zSlab,
                     int widthFill,
                     int heightFill)

fills background rectangle for label

Specified by:

fillRect in interface JmolRendererInterface

Parameters:

x - upper left x

y - upper left y

z - upper left z

zSlab - z value for slabbing

widthFill - pixel count

heightFill - pixel count

drawString

public void drawString(String str,
                       Font3D font3d,
                       int xBaseline,
                       int yBaseline,
                       int z,
                       int zSlab)

draws the specified string in the current font. no line wrapping -- axis, labels, measures

Specified by:

drawString in interface JmolRendererInterface

Parameters:

str - the String

font3d - the Font3D

xBaseline - baseline x

yBaseline - baseline y

z - baseline z

zSlab - z for slab calculation

drawStringNoSlab

public void drawStringNoSlab(String str,
                             Font3D font3d,
                             int xBaseline,
                             int yBaseline,
                             int z)

draws the specified string in the current font. no line wrapping -- echo, frank, hover, molecularOrbital, uccage

Specified by:

drawStringNoSlab in interface JmolRendererInterface

Parameters:

str - the String

font3d - the Font3D

xBaseline - baseline x

yBaseline - baseline y

z - baseline z

drawImage

public void drawImage(Object objImage,
                      int x,
                      int y,
                      int z,
                      int zSlab,
                      short bgcolix,
                      int width,
                      int height)

Specified by:

drawImage in interface JmolRendererInterface

drawPixel

public void drawPixel(int x,
                      int y,
                      int z)

Specified by:

drawPixel in interface JmolRendererInterface

plotPixelClipped

void plotPixelClipped(int x,
                      int y,
                      int z)

plotPixelClippedNoSlab

public void plotPixelClippedNoSlab(int argb,
                                   int x,
                                   int y,
                                   int z)

Specified by:

plotPixelClippedNoSlab in interface JmolRendererInterface

plotPixelClipped

public void plotPixelClipped(Point3i screen)

Specified by:

plotPixelClipped in interface JmolRendererInterface

drawPoints

public void drawPoints(int count,
                       int[] coordinates,
                       int scale)

Specified by:

drawPoints in interface JmolRendererInterface

drawDashedLine

public void drawDashedLine(int run,
                           int rise,
                           Point3i pointA,
                           Point3i pointB)

Specified by:

drawDashedLine in interface JmolRendererInterface

drawDottedLine

public void drawDottedLine(Point3i pointA,
                           Point3i pointB)

Specified by:

drawDottedLine in interface JmolRendererInterface

drawLine

public void drawLine(int x1,
                     int y1,
                     int z1,
                     int x2,
                     int y2,
                     int z2)

Specified by:

drawLine in interface JmolRendererInterface

drawLine

public void drawLine(short colixA,
                     short colixB,
                     int xA,
                     int yA,
                     int zA,
                     int xB,
                     int yB,
                     int zB)

Specified by:

drawLine in interface JmolRendererInterface

drawLine

public void drawLine(Point3i pointA,
                     Point3i pointB)

Specified by:

drawLine in interface JmolRendererInterface

drawBond

public void drawBond(Atom atomA,
                     Atom atomB,
                     short colixA,
                     short colixB,
                     byte endcaps,
                     short mad)

Specified by:

drawBond in interface JmolRendererInterface

fillCylinder

public void fillCylinder(short colixA,
                         short colixB,
                         byte endcaps,
                         int mad,
                         int xA,
                         int yA,
                         int zA,
                         int xB,
                         int yB,
                         int zB)

Specified by:

fillCylinder in interface JmolRendererInterface

fillCylinderScreen

public void fillCylinderScreen(byte endcaps,
                               int screenDiameter,
                               int xA,
                               int yA,
                               int zA,
                               int xB,
                               int yB,
                               int zB)

Specified by:

fillCylinderScreen in interface JmolRendererInterface

fillCylinderScreen

public void fillCylinderScreen(byte endcaps,
                               int diameter,
                               Point3i pointA,
                               Point3i pointB)

Specified by:

fillCylinderScreen in interface JmolRendererInterface

fillCylinder

public void fillCylinder(byte endcaps,
                         int diameter,
                         Point3i pointA,
                         Point3i pointB)

Specified by:

fillCylinder in interface JmolRendererInterface

fillCylinderBits

public void fillCylinderBits(byte endcaps,
                             int diameter,
                             Point3f pointA,
                             Point3f pointB)

Specified by:

fillCylinderBits in interface JmolRendererInterface

fillConeScreen

public void fillConeScreen(byte endcap,
                           int screenDiameter,
                           Point3i pointBase,
                           Point3i screenTip,
                           boolean isBarb)

Specified by:

fillConeScreen in interface JmolRendererInterface

fillConeSceen

public void fillConeSceen(byte endcap,
                          int screenDiameter,
                          Point3f pointBase,
                          Point3f screenTip)

Specified by:

fillConeSceen in interface JmolRendererInterface

drawHermite

public void drawHermite(int tension,
                        Point3i s0,
                        Point3i s1,
                        Point3i s2,
                        Point3i s3)

Specified by:

drawHermite in interface JmolRendererInterface

fillHermite

public void fillHermite(int tension,
                        int diameterBeg,
                        int diameterMid,
                        int diameterEnd,
                        Point3i s0,
                        Point3i s1,
                        Point3i s2,
                        Point3i s3)

Specified by:

fillHermite in interface JmolRendererInterface

drawHermite

public void drawHermite(boolean fill,
                        boolean border,
                        int tension,
                        Point3i s0,
                        Point3i s1,
                        Point3i s2,
                        Point3i s3,
                        Point3i s4,
                        Point3i s5,
                        Point3i s6,
                        Point3i s7,
                        int aspectRatio)

Specified by:

drawHermite in interface JmolRendererInterface

drawTriangle

public void drawTriangle(Point3i screenA,
                         short colixA,
                         Point3i screenB,
                         short colixB,
                         Point3i screenC,
                         short colixC,
                         int check)

Specified by:

drawTriangle in interface JmolRendererInterface

drawTriangle

public void drawTriangle(Point3i screenA,
                         Point3i screenB,
                         Point3i screenC,
                         int check)

Specified by:

drawTriangle in interface JmolRendererInterface

fillTriangle

public void fillTriangle(Point3i pointA,
                         short colixA,
                         short normixA,
                         Point3i pointB,
                         short colixB,
                         short normixB,
                         Point3i pointC,
                         short colixC,
                         short normixC)

Specified by:

fillTriangle in interface JmolRendererInterface

fillTriangleTwoSided

public void fillTriangleTwoSided(short normix,
                                 int xpointA,
                                 int ypointA,
                                 int zpointA,
                                 int xpointB,
                                 int ypointB,
                                 int zpointB,
                                 int xpointC,
                                 int ypointC,
                                 int zpointC)

Specified by:

fillTriangleTwoSided in interface JmolRendererInterface

fillTriangle

public void fillTriangle(Point3f pointA,
                         Point3f pointB,
                         Point3f pointC)

Specified by:

fillTriangle in interface JmolRendererInterface

fillTriangle

public void fillTriangle(Point3i pointA,
                         Point3i pointB,
                         Point3i pointC)

Specified by:

fillTriangle in interface JmolRendererInterface

fillTriangle

public void fillTriangle(Point3i pointA,
                         short colixA,
                         short normixA,
                         Point3i pointB,
                         short colixB,
                         short normixB,
                         Point3i pointC,
                         short colixC,
                         short normixC,
                         float factor)

Specified by:

fillTriangle in interface JmolRendererInterface

drawQuadrilateral

public void drawQuadrilateral(short colix,
                              Point3i pointA,
                              Point3i pointB,
                              Point3i pointC,
                              Point3i screenD)

Specified by:

drawQuadrilateral in interface JmolRendererInterface

fillQuadrilateral

public void fillQuadrilateral(Point3f pointA,
                              Point3f pointB,
                              Point3f pointC,
                              Point3f pointD)

Specified by:

fillQuadrilateral in interface JmolRendererInterface

fillQuadrilateral

public void fillQuadrilateral(Point3i pointA,
                              short colixA,
                              short normixA,
                              Point3i pointB,
                              short colixB,
                              short normixB,
                              Point3i pointC,
                              short colixC,
                              short normixC,
                              Point3i screenD,
                              short colixD,
                              short normixD)

Specified by:

fillQuadrilateral in interface JmolRendererInterface

drawSurface

public void drawSurface(MeshSurface meshSurface,
                        short colix)

Specified by:

drawSurface in interface JmolRendererInterface

getBgColixes

public short[] getBgColixes(short[] bgcolixes)

Specified by:

getBgColixes in interface JmolRendererInterface

fillEllipsoid

public void fillEllipsoid(Point3f center,
                          Point3f[] points,
                          int x,
                          int y,
                          int z,
                          int diameter,
                          Matrix3f mToEllipsoidal,
                          double[] coef,
                          Matrix4f mDeriv,
                          int selectedOctant,
                          Point3i[] octantPoints)

Specified by:

fillEllipsoid in interface JmolRendererInterface

drawEllipse

public boolean drawEllipse(Point3f ptAtom,
                           Point3f ptX,
                           Point3f ptY,
                           boolean fillArc,
                           boolean wireframeOnly)

Specified by:

drawEllipse in interface JmolRendererInterface

isAntialiased

public boolean isAntialiased()

is full scene / oversampling antialiasing in effect

Specified by:

isAntialiased in interface JmolRendererInterface

Returns:

the answer

checkTranslucent

public boolean checkTranslucent(boolean isAlphaTranslucent)

Specified by:

checkTranslucent in interface JmolRendererInterface

haveTranslucentObjects

public boolean haveTranslucentObjects()

Specified by:

haveTranslucentObjects in interface JmolRendererInterface

setColor

public void setColor(int color)

Specified by:

setColor in interface JmolRendererInterface

getRenderWidth

public int getRenderWidth()

gets g3d width

Specified by:

getRenderWidth in interface JmolRendererInterface

Returns:

width pixel count;

getRenderHeight

public int getRenderHeight()

gets g3d height

Specified by:

getRenderHeight in interface JmolRendererInterface

Returns:

height pixel count

isPass2

public boolean isPass2()

Specified by:

isPass2 in interface JmolRendererInterface

getSlab

public int getSlab()

gets g3d slab

Specified by:

getSlab in interface JmolRendererInterface

Returns:

slab

getDepth

public int getDepth()

gets g3d depth

Specified by:

getDepth in interface JmolRendererInterface

Returns:

depth

setColix

public boolean setColix(short colix)

sets current color from colix color index

Specified by:

setColix in interface JmolRendererInterface

Parameters:

colix - the color index

Returns:

true or false if this is the right pass

setFont

public void setFont(byte fid)

Specified by:

setFont in interface JmolRendererInterface

getFont3DCurrent

public Font3D getFont3DCurrent()

Specified by:

getFont3DCurrent in interface JmolRendererInterface

isInDisplayRange

public boolean isInDisplayRange(int x,
                                int y)

Specified by:

isInDisplayRange in interface JmolRendererInterface

isClippedZ

public boolean isClippedZ(int z)

Specified by:

isClippedZ in interface JmolRendererInterface

clipCode

public int clipCode(int x,
                    int y,
                    int z)

isClippedXY

public boolean isClippedXY(int diameter,
                           int x,
                           int y)

Specified by:

isClippedXY in interface JmolRendererInterface

isClipped

public boolean isClipped(int x,
                         int y,
                         int z)

isClipped

protected boolean isClipped(int x,
                            int y)

getColorArgbOrGray

public int getColorArgbOrGray(short colix)

Specified by:

getColorArgbOrGray in interface JmolRendererInterface

setNoisySurfaceShade

public void setNoisySurfaceShade(Point3i pointA,
                                 Point3i pointB,
                                 Point3i pointC)

Specified by:

setNoisySurfaceShade in interface JmolRendererInterface

getFontFid

public byte getFontFid(String fontFace,
                       float fontSize)

Specified by:

getFontFid in interface JmolRendererInterface

isDirectedTowardsCamera

public boolean isDirectedTowardsCamera(short normix)

Specified by:

isDirectedTowardsCamera in interface JmolRendererInterface

getTransformedVertexVectors

public Vector3f[] getTransformedVertexVectors()

Specified by:

getTransformedVertexVectors in interface JmolRendererInterface

getFont3DScaled

public Font3D getFont3DScaled(Font3D font,
                              float scale)

Specified by:

getFont3DScaled in interface JmolRendererInterface

getFontFid

public byte getFontFid(float fontSize)

Specified by:

getFontFid in interface JmolRendererInterface

setTranslucentCoverOnly

public void setTranslucentCoverOnly(boolean TF)

Specified by:

setTranslucentCoverOnly in interface JmolRendererInterface

getPrivateKey

public double getPrivateKey()

volumeRender

public void volumeRender(boolean TF)

Specified by:

volumeRender in interface JmolRendererInterface

volumeRender

public void volumeRender(int diam,
                         int x,
                         int y,
                         int z)

Specified by:

volumeRender in interface JmolRendererInterface