GData

java.lang.Object
- org.jmol.util.GData

Direct Known Subclasses:: Graphics3D

public class GData
extends java.lang.Object

Field Summary

Fields
Modifier and Type	Field	Description
`protected boolean`	`antialiasEnabled`
`protected boolean`	`antialiasThisFrame`
`ApiPlatform`	`apiPlatform`
`protected int`	`argbCurrent`
`protected java.lang.Object`	`backgroundImage`
`int`	`bgcolor`
`int`	`bufferSize`
`protected short[]`	`changeableColixMap`
`protected short`	`colixCurrent`
`int`	`depth`
`protected int`	`displayMaxX`
`protected int`	`displayMaxY`
`protected int`	`displayMinX`
`protected int`	`displayMinY`
`static byte`	`ENDCAPS_FLAT`
`static byte`	`ENDCAPS_NONE`
`static byte`	`ENDCAPS_OPEN`
`static byte`	`ENDCAPS_OPENEND`
`static byte`	`ENDCAPS_SPHERICAL`
`static int`	`EXPORT_CARTESIAN`
`static int`	`EXPORT_NOT`
`static int`	`EXPORT_RAYTRACER`
`protected java.lang.Object`	`graphicsForMetrics`
`int`	`height`
`protected boolean`	`inGreyscaleMode`
`boolean`	`isPass2`
`protected boolean`	`newAntialiasing`
`protected int`	`newWindowHeight`
`protected int`	`newWindowWidth`
`int`	`slab`
`int`	`width`
`protected int`	`windowHeight`
`protected int`	`windowWidth`
`static int`	`xGT`
`int`	`xLast`
`static int`	`xLT`
`static int`	`yGT`
`int`	`yLast`
`static int`	`yLT`
`int`	`zDepth`
`static int`	`zGT`
`static int`	`zLT`
`int`	`zShadeB`
`int`	`zShadeG`
`int`	`zShadePower`
`int`	`zShadeR`
`int`	`zSlab`

Constructor Summary

Constructors
Constructor Description

GData()

Constructors
Constructor	Description
`GData()`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`void`	`applyAnaglygh(EnumStereoMode stereoMode, int[] stereoColors)`
`void`	`beginRendering(Matrix3f stereoRotationMatrix)`
`void`	`changeColixArgb(short id, int argb)`
`void`	`clear()`
`void`	`clearFontCache()`
`int`	`clipCode(int z)`
`int`	`clipCode3(int x, int y, int z)`
`void`	`destroy()`
`void`	`endRendering()`
`static int`	`getAmbientPercent()`
`short[]`	`getBgColixes(short[] bgcolixes)`
`short`	`getChangeableColix(short id, int argb)`
`int`	`getColorArgbOrGray(short colix)`
`int`	`getDepth()`	gets g3d depth
`static int`	`getDiffusePercent()`
`JmolFont`	`getFont3D(float fontSize)`
`JmolFont`	`getFont3DCurrent()`
`JmolFont`	`getFont3DFS(java.lang.String fontFace, float fontSize)`
`JmolFont`	`getFont3DFSS(java.lang.String fontFace, java.lang.String fontStyle, float fontSize)`
`JmolFont`	`getFont3DScaled(JmolFont font, float scale)`
`byte`	`getFontFid(float fontSize)`
`byte`	`getFontFidFS(java.lang.String fontFace, float fontSize)`
`static int`	`getFontStyleID(java.lang.String fontStyle)`
`static Point3f`	`getLightSource()`
`static int`	`getPhongExponent()`
`int`	`getRenderHeight()`	gets g3d height
`int`	`getRenderWidth()`	gets g3d width
`java.lang.Object`	`getScreenImage()`
`int[]`	`getShades(short colix)`
`int`	`getSlab()`	gets g3d slab
`static boolean`	`getSpecular()`
`static int`	`getSpecularExponent()`
`static int`	`getSpecularPercent()`
`static int`	`getSpecularPower()`
`Vector3f[]`	`getTransformedVertexVectors()`
`void`	`initialize(ApiPlatform apiPlatform)`
`boolean`	`isAntialiased()`	is full scene / oversampling antialiasing in effect
`boolean`	`isClipped(int x, int y)`
`boolean`	`isClipped3(int x, int y, int z)`
`boolean`	`isClippedXY(int diameter, int x, int y)`
`boolean`	`isClippedZ(int z)`
`boolean`	`isDirectedTowardsCamera(short normix)`
`boolean`	`isDisplayAntialiased()`	is full scene / oversampling antialiasing GENERALLY in effect
`boolean`	`isInDisplayRange(int x, int y)`
`boolean`	`isPass2()`
`void`	`plotImage(int x, int y, int z, java.awt.Image image, Graphics3D jmolRenderer, short bgcolix, int width, int height)`
`void`	`plotText(int x, int y, int z, int colorArgbOrGray, int bgColor, java.lang.String text, JmolFont font3d, Graphics3D jmolRenderer)`
`void`	`releaseScreenImage()`
`void`	`renderAllStrings(java.lang.Object jmolRenderer)`
`void`	`renderBackground(Graphics3D jmolRenderer)`
`static int`	`roundInt(int a)`	JavaScript won't really have an integer here after integer division.
`static void`	`setAmbientPercent(int val)`	fractional distance from black for ambient color
`void`	`setBackgroundArgb(int argb)`	sets background color to the specified argb value
`void`	`setBackgroundImage(java.lang.Object image)`
`void`	`setBackgroundTransparent(boolean TF)`
`boolean`	`setColix(short colix)`
`void`	`setColor(int color)`
`void`	`setDepth(int depthValue)`	clipping from the front and the back
`static void`	`setDiffusePercent(int val)`	df in I = df * (N dot L) + sf * (R dot V)^p
`void`	`setFont(JmolFont font3d)`
`void`	`setFontFid(byte fid)`
`void`	`setGreyscaleMode(boolean greyscaleMode)`	controls greyscale rendering
`void`	`setNewWindowParametersForExport()`
`void`	`setNoisySurfaceShade(Point3i pointA, Point3i pointB, Point3i pointC)`
`boolean`	`setPass2(boolean antialias)`
`static void`	`setPhongExponent(int val)`	p in I = df * (N dot L) + sf * (R dot V)^p
`void`	`setSlab(int slabValue)`	clipping from the front and the back
`static void`	`setSpecular(boolean val)`
`static void`	`setSpecularExponent(int val)`	log_2(p) in I = df * (N dot L) + sf * (R dot V)^p for faster calculation of shades
`static void`	`setSpecularPercent(int val)`	sf in I = df * (N dot L) + sf * (R dot V)^p not a percent of anything, really
`static void`	`setSpecularPower(int val)`	fractional distance to white for specular dot
`protected void`	`setWidthHeight(boolean isAntialiased)`
`void`	`setWindowParameters(int width, int height, boolean antialias)`
`void`	`setZShade(boolean zShade, int zSlab, int zDepth, int zPower)`
`void`	`snapshotAnaglyphChannelBytes()`

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

apiPlatform
```
public ApiPlatform apiPlatform
```

windowWidth
```
protected int windowWidth
```

windowHeight
```
protected int windowHeight
```

displayMinX
```
protected int displayMinX
```

displayMaxX
```
protected int displayMaxX
```

displayMinY
```
protected int displayMinY
```

displayMaxY
```
protected int displayMaxY
```

antialiasThisFrame
```
protected boolean antialiasThisFrame
```

antialiasEnabled
```
protected boolean antialiasEnabled
```

inGreyscaleMode
```
protected boolean inGreyscaleMode
```

changeableColixMap
```
protected short[] changeableColixMap
```

backgroundImage

protected java.lang.Object backgroundImage

newWindowWidth
```
protected int newWindowWidth
```

newWindowHeight
```
protected int newWindowHeight
```

newAntialiasing
```
protected boolean newAntialiasing
```

bgcolor
```
public int bgcolor
```

xLast
```
public int xLast
```

yLast
```
public int yLast
```

slab
```
public int slab
```

depth
```
public int depth
```

width
```
public int width
```

height
```
public int height
```

zSlab
```
public int zSlab
```

zDepth
```
public int zDepth
```

zShadePower
```
public int zShadePower
```

colixCurrent
```
protected short colixCurrent
```

argbCurrent
```
protected int argbCurrent
```

bufferSize
```
public int bufferSize
```

ENDCAPS_NONE
```
public static final byte ENDCAPS_NONE
```
See Also:

Constant Field Values

ENDCAPS_OPEN
```
public static final byte ENDCAPS_OPEN
```
See Also:

Constant Field Values

ENDCAPS_FLAT
```
public static final byte ENDCAPS_FLAT
```
See Also:

Constant Field Values

ENDCAPS_SPHERICAL
```
public static final byte ENDCAPS_SPHERICAL
```
See Also:

Constant Field Values

ENDCAPS_OPENEND
```
public static final byte ENDCAPS_OPENEND
```
See Also:

Constant Field Values

zShadeR
```
public int zShadeR
```

zShadeG
```
public int zShadeG
```

zShadeB
```
public int zShadeB
```

graphicsForMetrics

protected java.lang.Object graphicsForMetrics

EXPORT_RAYTRACER
```
public static final int EXPORT_RAYTRACER
```
See Also:

Constant Field Values

EXPORT_CARTESIAN
```
public static final int EXPORT_CARTESIAN
```
See Also:

Constant Field Values

EXPORT_NOT
```
public static final int EXPORT_NOT
```
See Also:

Constant Field Values

yGT
```
public static final int yGT
```
See Also:

Constant Field Values

yLT
```
public static final int yLT
```
See Also:

Constant Field Values

xGT
```
public static final int xGT
```
See Also:

Constant Field Values

xLT
```
public static final int xLT
```
See Also:

Constant Field Values

zGT
```
public static final int zGT
```
See Also:

Constant Field Values

zLT
```
public static final int zLT
```
See Also:

Constant Field Values

isPass2
```
public boolean isPass2
```

Constructor Detail
- GData
```
public GData()
```

Method Detail

initialize

public void initialize(ApiPlatform apiPlatform)

setDepth
```
public void setDepth(int depthValue)
```
clipping from the front and the back
the plane is defined as a percentage from the back of the image to the front
for depth values:
- 0 means 100% is shown
- 25 means the back 25% is not shown
- 50 means the back half is not shown
- 100 means that nothing is shown
Parameters:

depthValue - rear clipping percentage [0,100]

setSlab
```
public void setSlab(int slabValue)
```
clipping from the front and the back
the plane is defined as a percentage from the back of the image to the front
For slab values:
- 100 means 100% is shown
- 75 means the back 75% is shown
- 50 means the back half is shown
- 0 means that nothing is shown
Parameters:

slabValue - front clipping percentage [0,100]

setZShade

public void setZShade(boolean zShade,
                      int zSlab,
                      int zDepth,
                      int zPower)

Parameters:: zShade - whether to shade along z front to back; zSlab - for zShade; zDepth - for zShade; zPower -

getRenderWidth
```
public int getRenderWidth()
```
gets g3d width

Returns:

width pixel count;

getRenderHeight
```
public int getRenderHeight()
```
gets g3d height

Returns:

height pixel count

getSlab
```
public int getSlab()
```
gets g3d slab

Returns:

slab

getDepth
```
public int getDepth()
```
gets g3d depth

Returns:

depth

isDisplayAntialiased
```
public boolean isDisplayAntialiased()
```
is full scene / oversampling antialiasing GENERALLY in effect

Returns:

the answer

isAntialiased
```
public boolean isAntialiased()
```
is full scene / oversampling antialiasing in effect

Returns:

the answer

getChangeableColix

public short getChangeableColix(short id,
                                int argb)

changeColixArgb

public void changeColixArgb(short id,
                            int argb)

getBgColixes

public short[] getBgColixes(short[] bgcolixes)

getColorArgbOrGray

public int getColorArgbOrGray(short colix)

getShades

public int[] getShades(short colix)

setGreyscaleMode
```
public void setGreyscaleMode(boolean greyscaleMode)
```
controls greyscale rendering

Parameters:

greyscaleMode - Flag for greyscale rendering

getSpecularPower

public static int getSpecularPower()

setSpecularPower
```
public static void setSpecularPower(int val)
```
fractional distance to white for specular dot

Parameters:

val -

getSpecularPercent

public static int getSpecularPercent()

setSpecularPercent
```
public static void setSpecularPercent(int val)
```
sf in I = df * (N dot L) + sf * (R dot V)^p not a percent of anything, really

Parameters:

val -

getSpecularExponent

public static int getSpecularExponent()

setSpecularExponent
```
public static void setSpecularExponent(int val)
```
log_2(p) in I = df * (N dot L) + sf * (R dot V)^p for faster calculation of shades

Parameters:

val -

getPhongExponent

public static int getPhongExponent()

setPhongExponent
```
public static void setPhongExponent(int val)
```
p in I = df * (N dot L) + sf * (R dot V)^p

Parameters:

val -

getDiffusePercent

public static int getDiffusePercent()

setDiffusePercent
```
public static void setDiffusePercent(int val)
```
df in I = df * (N dot L) + sf * (R dot V)^p

Parameters:

val -

getAmbientPercent

public static int getAmbientPercent()

setAmbientPercent
```
public static void setAmbientPercent(int val)
```
fractional distance from black for ambient color

Parameters:

val -

getSpecular

public static boolean getSpecular()

setSpecular

public static void setSpecular(boolean val)

getLightSource

public static Point3f getLightSource()

isClipped3

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

isClipped

public boolean isClipped(int x,
                         int y)

isInDisplayRange

public boolean isInDisplayRange(int x,
                                int y)

isClippedXY

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

isClippedZ
```
public boolean isClippedZ(int z)
```

clipCode3

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

clipCode
```
public int clipCode(int z)
```

getFont3D

public JmolFont getFont3D(float fontSize)

getFont3DFS

public JmolFont getFont3DFS(java.lang.String fontFace,
                            float fontSize)

getFontFidFS

public byte getFontFidFS(java.lang.String fontFace,
                         float fontSize)

getFont3DFSS

public JmolFont getFont3DFSS(java.lang.String fontFace,
                             java.lang.String fontStyle,
                             float fontSize)

getFont3DScaled

public JmolFont getFont3DScaled(JmolFont font,
                                float scale)

getFontFid

public byte getFontFid(float fontSize)

getFontStyleID

public static int getFontStyleID(java.lang.String fontStyle)

setBackgroundTransparent

public void setBackgroundTransparent(boolean TF)

Parameters:: TF -

setBackgroundArgb
```
public void setBackgroundArgb(int argb)
```
sets background color to the specified argb value

Parameters:

argb - an argb value with alpha channel

setBackgroundImage

public void setBackgroundImage(java.lang.Object image)

setWindowParameters

public void setWindowParameters(int width,
                                int height,
                                boolean antialias)

setNewWindowParametersForExport

public void setNewWindowParametersForExport()

setWidthHeight

protected void setWidthHeight(boolean isAntialiased)

beginRendering

public void beginRendering(Matrix3f stereoRotationMatrix)

Parameters:: stereoRotationMatrix -

endRendering
```
public void endRendering()
```

snapshotAnaglyphChannelBytes

public void snapshotAnaglyphChannelBytes()

getScreenImage

public java.lang.Object getScreenImage()

releaseScreenImage
```
public void releaseScreenImage()
```

applyAnaglygh

public void applyAnaglygh(EnumStereoMode stereoMode,
                          int[] stereoColors)

Parameters:: stereoMode -; stereoColors -

setPass2
```
public boolean setPass2(boolean antialias)
```
Parameters:

antialias -

Returns:

true if need a second (translucent) pass

destroy
```
public void destroy()
```

clearFontCache
```
public void clearFontCache()
```

plotImage

public void plotImage(int x,
                      int y,
                      int z,
                      java.awt.Image image,
                      Graphics3D jmolRenderer,
                      short bgcolix,
                      int width,
                      int height)

Parameters:: x -; y -; z -; image -; jmolRenderer -; bgcolix -; width -; height -

plotText

public void plotText(int x,
                     int y,
                     int z,
                     int colorArgbOrGray,
                     int bgColor,
                     java.lang.String text,
                     JmolFont font3d,
                     Graphics3D jmolRenderer)

Parameters:: x -; y -; z -; colorArgbOrGray -; bgColor - TODO; text -; font3d -; jmolRenderer -

renderBackground

public void renderBackground(Graphics3D jmolRenderer)

Parameters:: jmolRenderer -

getFont3DCurrent
```
public JmolFont getFont3DCurrent()
```

setFont

public void setFont(JmolFont font3d)

Parameters:: font3d -

setFontFid
```
public void setFontFid(byte fid)
```
Parameters:

fid -

setColor
```
public void setColor(int color)
```
Parameters:

color -

isPass2
```
public boolean isPass2()
```

setColix
```
public boolean setColix(short colix)
```
Parameters:

colix -

Returns:

TRUE if correct pass (translucent or opaque)

isDirectedTowardsCamera
```
public boolean isDirectedTowardsCamera(short normix)
```
Parameters:

normix -

Returns:

true if front

getTransformedVertexVectors

public Vector3f[] getTransformedVertexVectors()

setNoisySurfaceShade

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

Parameters:: pointA -; pointB -; pointC -

roundInt
```
public static int roundInt(int a)
```
JavaScript won't really have an integer here after integer division. So we need to round it to the integer between it and zero.

Parameters:

a -

Returns:

number closest to zero

clear
```
public void clear()
```

renderAllStrings

public void renderAllStrings(java.lang.Object jmolRenderer)

Class GData

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

apiPlatform

windowWidth

windowHeight

displayMinX

displayMaxX

displayMinY

displayMaxY

antialiasThisFrame

antialiasEnabled

inGreyscaleMode

changeableColixMap

backgroundImage

newWindowWidth

newWindowHeight

newAntialiasing

bgcolor

xLast

yLast

slab

depth

width

height

zSlab

zDepth

zShadePower

colixCurrent

argbCurrent

bufferSize

ENDCAPS_NONE

ENDCAPS_OPEN

ENDCAPS_FLAT

ENDCAPS_SPHERICAL

ENDCAPS_OPENEND

zShadeR

zShadeG

zShadeB

graphicsForMetrics

EXPORT_RAYTRACER

EXPORT_CARTESIAN

EXPORT_NOT

yGT

yLT

xGT

xLT

zGT

zLT

isPass2

Constructor Detail

GData

Method Detail

initialize

setDepth

setSlab

setZShade

getRenderWidth

getRenderHeight

getSlab

getDepth

isDisplayAntialiased

isAntialiased

getChangeableColix

changeColixArgb

getBgColixes

getColorArgbOrGray

getShades

setGreyscaleMode

getSpecularPower

setSpecularPower

getSpecularPercent

setSpecularPercent

getSpecularExponent

setSpecularExponent

getPhongExponent

setPhongExponent