org.jmol.api

Interface JmolRendererInterface

public interface JmolRendererInterface

Method Summary
abstract intcalcSurfaceShade(Point3i screenA, Point3i screenB, Point3i screenC)
abstract booleancheckTranslucent(boolean isAlphaTranslucent)
abstract voiddrawCircleCentered(short colix, int diameter, int x, int y, int z, boolean doFill)
draws a screened circle ... every other dot is turned on
abstract voiddrawCylinderTriangle(int xA, int yA, int zA, int xB, int yB, int zB, int xC, int yC, int zC, int diameter)
abstract voiddrawDashedLine(int run, int rise, Point3i pointA, Point3i pointB)
abstract voiddrawDottedLine(Point3i pointA, Point3i pointB)
abstract voiddrawfillTriangle(int xA, int yA, int zA, int xB, int yB, int zB, int xC, int yC, int zC)
abstract voiddrawHermite(int tension, Point3i s0, Point3i s1, Point3i s2, Point3i s3)
abstract voiddrawHermite(boolean fill, boolean border, int tension, Point3i s0, Point3i s1, Point3i s2, Point3i s3, Point3i s4, Point3i s5, Point3i s6, Point3i s7, int aspectRatio)
abstract voiddrawImage(Image image, int x, int y, int z, int zslab, short bgcolix, int width, int height)
abstract voiddrawLine(int x1, int y1, int z1, int x2, int y2, int z2)
abstract voiddrawLine(Point3i pointA, Point3i pointB)
abstract voiddrawLine(short colixA, short colixB, int x1, int y1, int z1, int x2, int y2, int z2)
abstract voiddrawPixel(int x, int y, int z)
abstract voiddrawPoints(int count, int[] coordinates)
abstract voiddrawQuadrilateral(short colix, Point3i screenA, Point3i screenB, Point3i screenC, Point3i screenD)
abstract voiddrawRect(int x, int y, int z, int zSlab, int rWidth, int rHeight)
draws a rectangle
abstract voiddrawString(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
abstract voiddrawStringNoSlab(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
abstract voiddrawTriangle(Point3i screenA, short colixA, Point3i screenB, short colixB, Point3i screenC, short colixC, int check)
abstract voiddrawTriangle(Point3i screenA, Point3i screenB, Point3i screenC, int check)
abstract voidfillCone(byte endcap, int diameter, Point3i screenBase, Point3i screenTip)
abstract voidfillCone(byte endcap, int diameter, Point3f screenBase, Point3f screenTip)
abstract voidfillCylinder(short colixA, short colixB, byte endcaps, int diameter, int xA, int yA, int zA, int xB, int yB, int zB)
abstract voidfillCylinder(byte endcaps, int diameter, int xA, int yA, int zA, int xB, int yB, int zB)
abstract voidfillCylinder(byte endcaps, int diameter, Point3i screenA, Point3i screenB)
abstract voidfillCylinderBits(byte endcaps, int diameter, Point3f screenA, Point3f screenB)
abstract voidfillHermite(int tension, int diameterBeg, int diameterMid, int diameterEnd, Point3i s0, Point3i s1, Point3i s2, Point3i s3)
abstract voidfillQuadrilateral(Point3f screenA, Point3f screenB, Point3f screenC, Point3f screenD)
abstract voidfillQuadrilateral(Point3i screenA, short colixA, short normixA, Point3i screenB, short colixB, short normixB, Point3i screenC, short colixC, short normixC, Point3i screenD, short colixD, short normixD)
abstract voidfillRect(int x, int y, int z, int zSlab, int widthFill, int heightFill)
fills background rectangle for label

abstract voidfillScreenedCircleCentered(short colixFill, int diameter, int x, int y, int z)
draws a screened circle ... every other dot is turned on
abstract voidfillSphereCentered(int diameter, int x, int y, int z)
fills a solid sphere
abstract voidfillSphereCentered(int diameter, Point3i center)
fills a solid sphere
abstract voidfillSphereCentered(int diameter, Point3f center)
fills a solid sphere
abstract voidfillTriangle(Point3i screenA, short colixA, short normixA, Point3i screenB, short colixB, short normixB, Point3i screenC, short colixC, short normixC)
abstract voidfillTriangle(short normix, int xScreenA, int yScreenA, int zScreenA, int xScreenB, int yScreenB, int zScreenB, int xScreenC, int yScreenC, int zScreenC)
abstract voidfillTriangle(Point3f screenA, Point3f screenB, Point3f screenC)
abstract voidfillTriangle(Point3i screenA, Point3i screenB, Point3i screenC)
voidfillTriangle(Point3i screenA, int intensityA, Point3i screenB, int intensityB, Point3i screenC, int intensityC)
abstract voidfillTriangle(Point3i screenA, short colixA, short normixA, Point3i screenB, short colixB, short normixB, Point3i screenC, short colixC, short normixC, float factor)
abstract intgetColixArgb(short colix)
abstract intgetDepth()
gets g3d depth
abstract JmolExportInterfacegetExporter()
abstract Font3DgetFont3DCurrent()
abstract Font3DgetFont3DScaled(Font3D font3d, float imageFontScaling)
abstract bytegetFontFid(String fontFace, float fontSize)
abstract bytegetFontFid(float fontSize)
abstract StringgetHexColorFromIndex(short colix)
abstract shortgetInverseNormix(short normix)
abstract shortgetNormix(Vector3f vector)
abstract Vector3fgetNormixVector(short normix)
abstract intgetRenderHeight()
gets g3d height
abstract intgetRenderWidth()
gets g3d width
abstract intgetSlab()
gets g3d slab
abstract Vector3f[]getTransformedVertexVectors()
abstract booleanhaveTranslucentObjects()
abstract booleanisAntialiased()
abstract booleanisClippedXY(int i, int screenX, int screenY)
abstract booleanisClippedZ(int z)
abstract booleanisDirectedTowardsCamera(short normix)
abstract booleanisInDisplayRange(int x, int y)
abstract voidplotPixelClipped(Point3i a)
abstract voidplotPixelClippedNoSlab(int argb, int x, int y, int z)
abstract voidrenderEllipsoid(int x, int y, int z, int diameter, Matrix3f mToEllipsoidal, double[] coef, Matrix4f mDeriv, int selectedOctant, Point3i[] octantPoints)
abstract voidrenderIsosurface(Point3f[] vertices, short colix, short[] colixes, Vector3f[] normals, int[][] indices, BitSet bsFaces, int nVertices, int faceVertexMax)
abstract booleansetColix(short colix)
sets current color from colix color index
abstract voidsetFont(byte fid)
abstract voidsetg3dExporter(Graphics3D g3d, JmolExportInterface exporter)
abstract voidsetRenderer(ShapeRenderer shapeRenderer)
abstract voidsetSlab(int slabValue)

Method Detail

calcSurfaceShade

public abstract int calcSurfaceShade(Point3i screenA, Point3i screenB, Point3i screenC)

checkTranslucent

public abstract boolean checkTranslucent(boolean isAlphaTranslucent)

drawCircleCentered

public abstract void drawCircleCentered(short colix, int diameter, int x, int y, int z, boolean doFill)
draws a screened circle ... every other dot is turned on

Parameters: colix the color index diameter the pixel diameter x center x y center y z center z doFill fill or not

drawCylinderTriangle

public abstract void drawCylinderTriangle(int xA, int yA, int zA, int xB, int yB, int zB, int xC, int yC, int zC, int diameter)

drawDashedLine

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

drawDottedLine

public abstract void drawDottedLine(Point3i pointA, Point3i pointB)

drawfillTriangle

public abstract void drawfillTriangle(int xA, int yA, int zA, int xB, int yB, int zB, int xC, int yC, int zC)

drawHermite

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

drawHermite

public abstract 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)

drawImage

public abstract void drawImage(Image image, int x, int y, int z, int zslab, short bgcolix, int width, int height)

drawLine

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

drawLine

public abstract void drawLine(Point3i pointA, Point3i pointB)

drawLine

public abstract void drawLine(short colixA, short colixB, int x1, int y1, int z1, int x2, int y2, int z2)

drawPixel

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

drawPoints

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

drawQuadrilateral

public abstract void drawQuadrilateral(short colix, Point3i screenA, Point3i screenB, Point3i screenC, Point3i screenD)

drawRect

public abstract void drawRect(int x, int y, int z, int zSlab, int rWidth, int rHeight)
draws a rectangle

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

drawString

public abstract 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

Parameters: str the String font3d the Font3D xBaseline baseline x yBaseline baseline y z baseline z zSlab z for slab calculation

drawStringNoSlab

public abstract 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

Parameters: str the String font3d the Font3D xBaseline baseline x yBaseline baseline y z baseline z

drawTriangle

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

drawTriangle

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

fillCone

public abstract void fillCone(byte endcap, int diameter, Point3i screenBase, Point3i screenTip)

fillCone

public abstract void fillCone(byte endcap, int diameter, Point3f screenBase, Point3f screenTip)

fillCylinder

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

fillCylinder

public abstract void fillCylinder(byte endcaps, int diameter, int xA, int yA, int zA, int xB, int yB, int zB)

fillCylinder

public abstract void fillCylinder(byte endcaps, int diameter, Point3i screenA, Point3i screenB)

fillCylinderBits

public abstract void fillCylinderBits(byte endcaps, int diameter, Point3f screenA, Point3f screenB)

fillHermite

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

fillQuadrilateral

public abstract void fillQuadrilateral(Point3f screenA, Point3f screenB, Point3f screenC, Point3f screenD)

fillQuadrilateral

public abstract void fillQuadrilateral(Point3i screenA, short colixA, short normixA, Point3i screenB, short colixB, short normixB, Point3i screenC, short colixC, short normixC, Point3i screenD, short colixD, short normixD)

fillRect

public abstract void fillRect(int x, int y, int z, int zSlab, int widthFill, int heightFill)
fills background rectangle for label

Parameters: x upper left x y upper left y z upper left z zSlab z value for slabbing widthFill pixel count heightFill pixel count

fillScreenedCircleCentered

public abstract void fillScreenedCircleCentered(short colixFill, int diameter, int x, int y, int z)
draws a screened circle ... every other dot is turned on

Parameters: colixFill the color index diameter the pixel diameter x center x y center y z center z

fillSphereCentered

public abstract void fillSphereCentered(int diameter, int x, int y, int z)
fills a solid sphere

Parameters: diameter pixel count x center x y center y z center z

fillSphereCentered

public abstract void fillSphereCentered(int diameter, Point3i center)
fills a solid sphere

Parameters: diameter pixel count center javax.vecmath.Point3i defining the center

fillSphereCentered

public abstract void fillSphereCentered(int diameter, Point3f center)
fills a solid sphere

Parameters: diameter pixel count center a javax.vecmath.Point3f ... floats are casted to ints

fillTriangle

public abstract void fillTriangle(Point3i screenA, short colixA, short normixA, Point3i screenB, short colixB, short normixB, Point3i screenC, short colixC, short normixC)

fillTriangle

public abstract void fillTriangle(short normix, int xScreenA, int yScreenA, int zScreenA, int xScreenB, int yScreenB, int zScreenB, int xScreenC, int yScreenC, int zScreenC)

fillTriangle

public abstract void fillTriangle(Point3f screenA, Point3f screenB, Point3f screenC)

fillTriangle

public abstract void fillTriangle(Point3i screenA, Point3i screenB, Point3i screenC)

fillTriangle

public void fillTriangle(Point3i screenA, int intensityA, Point3i screenB, int intensityB, Point3i screenC, int intensityC)

fillTriangle

public abstract void fillTriangle(Point3i screenA, short colixA, short normixA, Point3i screenB, short colixB, short normixB, Point3i screenC, short colixC, short normixC, float factor)

getColixArgb

public abstract int getColixArgb(short colix)

getDepth

public abstract int getDepth()
gets g3d depth

Returns: depth

getExporter

public abstract JmolExportInterface getExporter()

getFont3DCurrent

public abstract Font3D getFont3DCurrent()

getFont3DScaled

public abstract Font3D getFont3DScaled(Font3D font3d, float imageFontScaling)

getFontFid

public abstract byte getFontFid(String fontFace, float fontSize)

getFontFid

public abstract byte getFontFid(float fontSize)

getHexColorFromIndex

public abstract String getHexColorFromIndex(short colix)

getInverseNormix

public abstract short getInverseNormix(short normix)

getNormix

public abstract short getNormix(Vector3f vector)

getNormixVector

public abstract Vector3f getNormixVector(short normix)

getRenderHeight

public abstract int getRenderHeight()
gets g3d height

Returns: height pixel count

getRenderWidth

public abstract int getRenderWidth()
gets g3d width

Returns: width pixel count;

getSlab

public abstract int getSlab()
gets g3d slab

Returns: slab

getTransformedVertexVectors

public abstract Vector3f[] getTransformedVertexVectors()

haveTranslucentObjects

public abstract boolean haveTranslucentObjects()

isAntialiased

public abstract boolean isAntialiased()

isClippedXY

public abstract boolean isClippedXY(int i, int screenX, int screenY)

isClippedZ

public abstract boolean isClippedZ(int z)

isDirectedTowardsCamera

public abstract boolean isDirectedTowardsCamera(short normix)

isInDisplayRange

public abstract boolean isInDisplayRange(int x, int y)

plotPixelClipped

public abstract void plotPixelClipped(Point3i a)

plotPixelClippedNoSlab

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

renderEllipsoid

public abstract void renderEllipsoid(int x, int y, int z, int diameter, Matrix3f mToEllipsoidal, double[] coef, Matrix4f mDeriv, int selectedOctant, Point3i[] octantPoints)

renderIsosurface

public abstract void renderIsosurface(Point3f[] vertices, short colix, short[] colixes, Vector3f[] normals, int[][] indices, BitSet bsFaces, int nVertices, int faceVertexMax)

setColix

public abstract boolean setColix(short colix)
sets current color from colix color index

Parameters: colix the color index

Returns: true or false if this is the right pass

setFont

public abstract void setFont(byte fid)

setg3dExporter

public abstract void setg3dExporter(Graphics3D g3d, JmolExportInterface exporter)

setRenderer

public abstract void setRenderer(ShapeRenderer shapeRenderer)

setSlab

public abstract void setSlab(int slabValue)