DisplayBox

java.lang.Object
- etomica.graphics.Display
- - etomica.graphics.DisplayBox

```
public class DisplayBox
extends Display
```
Displays a picture of a box, with configurations of molecules, boundaries, and other objects as appropriate, assuming 2-dimensional system. Instantiates a ConfigurationCanvas (an inner class of this one) for most of the work. DisplayBox is an input event (mouse and key) listener of the canvas. It receives these events and uses information from them to form and fire a DisplayBoxEvent to registered listeners.

Field Summary

Fields
Modifier and Type	Field	Description
`int[]`	`align`
`protected AtomTest`	`atomTestDoDisplay`
`static int`	`BOTTOM`
`DisplayCanvas`	`canvas`
`static int`	`CENTER`
`protected int[]`	`centralOrigin`	Coordinate origin for central image Explicit to 2D because drawing is done to 2D image
`protected ColorScheme`	`colorScheme`
`protected Controller`	`controller`
`protected DiameterHash`	`diameterHash`
`protected boolean`	`displayBoundary`
`protected int[]`	`drawSize`	Size of drawing region of central image, in pixels
`static int`	`LEFT`
`static int`	`RIGHT`
`protected double`	`scale`	Factor used to scale the size of the image.
`protected Simulation`	`sim`
`static int`	`TOP`

Fields inherited from class etomica.graphics.Display
label, support

Constructor Summary

Constructors
Constructor	Description
`DisplayBox(Simulation sim, Box box)`	Warning: after instantiation, clients using G3DSys may need to toggle display.canvas.setVisible false and then true to fix the 'sometimes gray' bug.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`void`	`addDrawable(Drawable obj)`
`void`	`addDrawable(java.lang.Object obj)`
`void`	`computeImageParameters()`
`void`	`computeImageParameters2(int w, int h)`
`int`	`getAlign(int i)`
`AtomTest`	`getAtomTestDoDisplay()`	Accessor method for the atom filter that determines which atoms are displayed.
`Box`	`getBox()`
`ColorScheme`	`getColorScheme()`	Accessor method for the color scheme used for this display
`DiameterHash`	`getDiameterHash()`	Returns the DiameterHash used by this DisplayBox.
`java.util.LinkedList`	`getDrawables()`
`int`	`getDrawingHeight()`	return int : height of the drawing area (only relevant for 1D)
`boolean`	`getDrawOverflow()`
`int[]`	`getDrawSize()`
`int`	`getImageShells()`
`int[]`	`getOrigin()`
`double`	`getPaddingSigma()`	Returns the amount of padding added around the edge of the drawing area.
`Pixel`	`getPixelUnit()`
`boolean`	`getResizeOnNewBox()`	Get the flag indicating whether the graphic should resize from its currently displayed size when a new box is set.
`double`	`getScale()`
`boolean`	`getShowBoundary()`	Get the flag indicating if the boundary should be drawn.
`java.awt.Dimension`	`getSize()`	Gets the size of the box graphic.
`double`	`getToPixels()`
`java.awt.Component`	`graphic()`	Simulation.GraphicalElement interface method.
`void`	`removeDrawable(Drawable obj)`
`void`	`removeDrawable(java.lang.Object obj)`
`void`	`repaint()`	Repaint the graphic associated with the display box.
`void`	`setAlign(int i, int value)`
`void`	`setAtomTestDoDisplay(AtomTest atomTest)`	Mutator method for the atom filter that determines which atoms are displayed.
`void`	`setBox(Box p)`	Specifies the box for this display.
`void`	`setBoxCanvas(DisplayCanvas boxCanvas)`
`void`	`setColorScheme(ColorScheme colorScheme)`	Mutator method for the color scheme used for this display
`void`	`setDiameterHash(DiameterHash newDiameterManager)`	Sets the DiameterHash used by this DisplayBox.
`void`	`setDrawingHeight(int newDrawingHeight)`	Set the height of the drawing area (only relevant for 1D)
`void`	`setDrawOverflow(boolean b)`
`void`	`setImageShells(int n)`	Changes the value of image shells, and increases/decreases scale accordingly.
`void`	`setOriginShift(int dimension, int shift)`	Amount (in pixels) of a simple shift (translation) applied in determing origin.
`void`	`setPaddingSigma(double sigma)`	Sets the amount of padding added around the edge of the drawing area.
`void`	`setPixelUnit(Pixel pixel)`	Sets unit for conversion between simulation units and display pixels.
`void`	`setResizeOnNewBox(boolean b)`	Set the flag indicating whether the graphic should resize from its currently displayed size when a new box is set.
`void`	`setScale(double s)`
`void`	`setShowBoundary(boolean b)`	Set the flag indicating if the boundary should be drawn.

Methods inherited from class etomica.graphics.Display
addPropertyChangeListener, getLabel, removePropertyChangeListener, setLabel, toString

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

- Field Detail
  - LEFT
```
public static final int LEFT
```
    See Also:
    
    Constant Field Values
  - CENTER
```
public static final int CENTER
```
    See Also:
    
    Constant Field Values
  - RIGHT
```
public static final int RIGHT
```
    See Also:
    
    Constant Field Values
  - TOP
```
public static final int TOP
```
    See Also:
    
    Constant Field Values
  - BOTTOM
```
public static final int BOTTOM
```
    See Also:
    
    Constant Field Values
  - colorScheme
```
protected ColorScheme colorScheme
```
  - diameterHash
```
protected DiameterHash diameterHash
```
  - atomTestDoDisplay
```
protected AtomTest atomTestDoDisplay
```
  - displayBoundary
```
protected boolean displayBoundary
```
  - sim
```
protected final Simulation sim
```
  - canvas
```
public DisplayCanvas canvas
```
  - align
```
public final int[] align
```
  - drawSize
```
protected final int[] drawSize
```
    Size of drawing region of central image, in pixels
    
    See Also:
    
    computeImageParameters()
  - scale
```
protected double scale
```
    Factor used to scale the size of the image. May be used to scale up or down the image within one box without affecting those in other displays. Default value is 1.0.
  - centralOrigin
```
protected final int[] centralOrigin
```
    Coordinate origin for central image Explicit to 2D because drawing is done to 2D image
  - controller
```
protected final Controller controller
```
- Constructor Detail
  - DisplayBox
```
public DisplayBox(Simulation sim,
                  Box box)
```
    Warning: after instantiation, clients using G3DSys may need to toggle display.canvas.setVisible false and then true to fix the 'sometimes gray' bug. i.e.; = new ColorSchemeByType() if(display.canvas instanceof JComponent) { ((JComponent)display.canvas).setVisible(false); ((JComponent)display.canvas).setVisible(true); }
    
    Parameters:
    
    box -
- Method Detail
  - getSize
```
public java.awt.Dimension getSize()
```
    Gets the size of the box graphic.
    
    Returns:
    
    java.awt.Dimension : Dimension object containing box graphic size
  - setOriginShift
```
public void setOriginShift(int dimension,
                           int shift)
```
    Amount (in pixels) of a simple shift (translation) applied in determing origin. Usually zero, but can be set to any value by passing in dimension and the number of pixels to shift in the specified dimension.
    Dimension : 0 : X direction 1 : Y direction 2 : Z direction (not used)
  - getOrigin
```
public int[] getOrigin()
```
    Returns:
    
    int[] :
  - getDrawSize
```
public int[] getDrawSize()
```
    Returns:
    
    int[] :
  - setAlign
```
public void setAlign(int i,
                     int value)
```
  - getAlign
```
public int getAlign(int i)
```
    Returns:
    
    int :
  - getDrawOverflow
```
public final boolean getDrawOverflow()
```
    Returns:
    
    final boolean :
  - setDrawOverflow
```
public final void setDrawOverflow(boolean b)
```
  - getToPixels
```
public double getToPixels()
```
    Returns:
    
    double
  - setScale
```
public void setScale(double s)
```
  - getScale
```
public double getScale()
```
    Returns:
    
    double
  - addDrawable
```
public void addDrawable(Drawable obj)
```
  - removeDrawable
```
public void removeDrawable(Drawable obj)
```
  - addDrawable
```
public void addDrawable(java.lang.Object obj)
```
  - removeDrawable
```
public void removeDrawable(java.lang.Object obj)
```
  - getBox
```
public final Box getBox()
```
    Returns:
    
    Box : the box associated with this display
  - getPaddingSigma
```
public double getPaddingSigma()
```
    Returns the amount of padding added around the edge of the drawing area. This allows atoms at the edge of the boundary to be fully drawn. The padding is given in terms of simulations length units (Angstroms) and should (in general) be equal to the diameter of atoms in the box.
  - setPaddingSigma
```
public void setPaddingSigma(double sigma)
```
    Sets the amount of padding added around the edge of the drawing area. This allows atoms at the edge of the boundary to be fully drawn. The padding is given in terms of simulations length units (Angstroms) and should (in general) be equal to the diameter of atoms in the box. DisplayBoxCanvas2D is currently the only thing that pays attention to this.
  - setBox
```
public void setBox(Box p)
```
    Specifies the box for this display. Updates atomIterator appropriately.
  - setBoxCanvas
```
public void setBoxCanvas(DisplayCanvas boxCanvas)
```
  - setColorScheme
```
public void setColorScheme(ColorScheme colorScheme)
```
    Mutator method for the color scheme used for this display
  - getColorScheme
```
public ColorScheme getColorScheme()
```
    Accessor method for the color scheme used for this display
    
    Returns:
    
    ColorScheme
  - getDiameterHash
```
public DiameterHash getDiameterHash()
```
    Returns the DiameterHash used by this DisplayBox. The default DiameterHash is an instance of DiameterHashByElementType.
  - setDiameterHash
```
public void setDiameterHash(DiameterHash newDiameterManager)
```
    Sets the DiameterHash used by this DisplayBox.
  - setAtomTestDoDisplay
```
public void setAtomTestDoDisplay(AtomTest atomTest)
```
    Mutator method for the atom filter that determines which atoms are displayed. Atoms for which the filter returns false are not displayed. Default is null, meaning all atoms are displayed.
  - getAtomTestDoDisplay
```
public AtomTest getAtomTestDoDisplay()
```
    Accessor method for the atom filter that determines which atoms are displayed. Atoms for which the filter returns false are not displayed. Default is null, meaning all atoms are displayed.
    
    Returns:
    
    Atomfilter
  - getDrawables
```
public java.util.LinkedList getDrawables()
```
    Returns:
    
    LinkedList
  - graphic
```
public java.awt.Component graphic()
```
    Simulation.GraphicalElement interface method. Overrides Display method to return the DisplayBox.Canvas as the display object.
    
    Specified by:
    
    graphic in class Display
    
    Returns:
    
    Component
  - getImageShells
```
public int getImageShells()
```
    Returns:
    
    int : the current value of imageShells.
  - setImageShells
```
public void setImageShells(int n)
```
    Changes the value of image shells, and increases/decreases scale accordingly.
    
    Parameters:
    
    n - the new value of imageShells
  - computeImageParameters
```
public void computeImageParameters()
```
  - computeImageParameters2
```
public void computeImageParameters2(int w,
                                    int h)
```
    Parameters:
    
    w -
    
    h -
  - repaint
```
public void repaint()
```
    Repaint the graphic associated with the display box.
  - getPixelUnit
```
public Pixel getPixelUnit()
```
    Returns:
    
    Pixel : unit for conversion between simulation units and display pixels.
  - setPixelUnit
```
public void setPixelUnit(Pixel pixel)
```
    Sets unit for conversion between simulation units and display pixels.
    
    Parameters:
    
    pixel - :
  - setDrawingHeight
```
public void setDrawingHeight(int newDrawingHeight)
```
    Set the height of the drawing area (only relevant for 1D)
    
    Parameters:
    
    newDrawingHeight - :
  - getDrawingHeight
```
public int getDrawingHeight()
```
    return int : height of the drawing area (only relevant for 1D)
  - setShowBoundary
```
public void setShowBoundary(boolean b)
```
    Set the flag indicating if the boundary should be drawn.
    
    Parameters:
    
    b - : draw boundary flag
  - getShowBoundary
```
public boolean getShowBoundary()
```
    Get the flag indicating if the boundary should be drawn.
    
    Returns:
    
    boolean
  - setResizeOnNewBox
```
public void setResizeOnNewBox(boolean b)
```
    Set the flag indicating whether the graphic should resize from its currently displayed size when a new box is set.
    
    Parameters:
    
    b -
  - getResizeOnNewBox
```
public boolean getResizeOnNewBox()
```
    Get the flag indicating whether the graphic should resize from its currently displayed size when a new box is set.
    
    Returns:
    
    boolean

Class DisplayBox

Field Summary

Fields inherited from class etomica.graphics.Display

Constructor Summary

Method Summary

Methods inherited from class etomica.graphics.Display

Methods inherited from class java.lang.Object

Field Detail

LEFT

CENTER

RIGHT

TOP

BOTTOM

colorScheme

diameterHash

atomTestDoDisplay

displayBoundary

sim

canvas

align

drawSize

scale

centralOrigin

controller

Constructor Detail

DisplayBox

Method Detail

getSize

setOriginShift

getOrigin

getDrawSize

setAlign

getAlign

getDrawOverflow

setDrawOverflow

getToPixels

setScale

getScale

addDrawable

removeDrawable

addDrawable

removeDrawable

getBox

getPaddingSigma

setPaddingSigma

setBox

setBoxCanvas

setColorScheme

getColorScheme

getDiameterHash

setDiameterHash

setAtomTestDoDisplay

getAtomTestDoDisplay

getDrawables

graphic

getImageShells

setImageShells

computeImageParameters

computeImageParameters2

repaint

getPixelUnit

setPixelUnit

setDrawingHeight

getDrawingHeight

setShowBoundary

getShowBoundary

setResizeOnNewBox

getResizeOnNewBox