Package org.opensourcephysics.frames

Class LatticeFrame

java.lang.Object
java.awt.Component
java.awt.Container
java.awt.Window
java.awt.Frame
javax.swing.JFrame
org.opensourcephysics.display.OSPFrame
org.opensourcephysics.display.DrawingFrame
org.opensourcephysics.frames.LatticeFrame
All Implemented Interfaces:
ClipboardOwner, ImageObserver, MenuContainer, Serializable, Accessible, RootPaneContainer, WindowConstants, AppFrame, Hidable
public class LatticeFrame extends DrawingFrame
A DrawingFrame that displays plots using a Lattice.
Version:
1.0
Author:
W. Christian
See Also:

  • Field Details

  • Constructor Details

    • LatticeFrame

      public LatticeFrame(String xlabel, String ylabel, String frameTitle)
      Constructs a LatticeFrame with the given axes labels and frame title.
      Parameters:
      xlabel - String
      ylabel - String
      frameTitle - String

    • LatticeFrame

      public LatticeFrame(String frameTitle)
      Constructs a LatticeFrame with the given frame title but without axes.
      Parameters:
      frameTitle - String

  • Method Details

    • setShowGridLines

      public void setShowGridLines(boolean showGridLines)
      Outlines the lattice boundaries with a grid.
      Parameters:
      showGridLines -

    • showLegend

      public void showLegend()
      Shows the color associated with each value.

    • addMenuItems

      protected void addMenuItems()
      Adds Views menu items on the menu bar.
      Overrides:
      addMenuItems in class DrawingFrame

    • convertToSiteLattice

      public void convertToSiteLattice()
      Converts this lattice to a SiteLattice from a CellLattice.

    • convertToCellLattice

      public void convertToCellLattice()
      Converts this lattice to a Byte lattice from a CellLattice.

    • clearDrawables

      public void clearDrawables()
      Clears drawable objects added by the user from this frame.
      Overrides:
      clearDrawables in class DrawingFrame

    • getDrawables

      public ArrayList<Drawable> getDrawables()
      Gets Drawable objects added by the user to this frame.
      Overrides:
      getDrawables in class DrawingFrame
      Returns:
      the list

    • getDrawables

      public <T extends Drawable> ArrayList<T> getDrawables(Class<T> c)
      Gets Drawable objects added by the user of an assignable type. The list contains objects that are assignable from the class or interface.
      Overrides:
      getDrawables in class DrawingFrame
      Parameters:
      c - the type of Drawable object
      Returns:
      the cloned list
      See Also:

    • clearData

      public void clearData()
      Clears the lattice data by setting all values to zero.
      Overrides:
      clearData in class OSPFrame

    • setAll

      public void setAll(byte[][] val)
      Sets a block of data to new values. The lattice is resized to fit the new data as needed.
      Parameters:
      val -

    • setAll

      public void setAll(byte[][] val, double xmin, double xmax, double ymin, double ymax)
      Sets the lattice values and scale. The lattice is resized to fit the new data as needed.
      Parameters:
      val - int[][] the new values
      xmin - double
      xmax - double
      ymin - double
      ymax - double

    • randomize

      public void randomize()
      Randomizes the lattice values.

    • resizeLattice

      public void resizeLattice(int nx, int ny)
      Resizes the number of columns and rows in the lattice
      Parameters:
      nx - int
      ny - int

    • setIndexedColor

      public void setIndexedColor(int index, Color color)
      Sets the color for a single index.
      Parameters:
      index -
      color -

    • setColorPalette

      public void setColorPalette(Color[] colors)
      Sets the color palette.
      Parameters:
      colors -

    • setAtIndex

      public void setAtIndex(int i, int v)
      Sets the ith indexed cell or site of the lattice to store value v Values are in row-major format such that the index corresponds to iy*ny+ix.
      Parameters:
      i -
      v -

    • setValue

      public void setValue(int ix, int iy, int v)
      Sets the (ix,iy) value of the lattice.
      Parameters:
      ix -
      iy -
      v -

    • setAll

      public void setAll(int[] val, int nx, double xmin, double xmax, double ymin, double ymax)
      Sets the lattice values and scale. Values are in row-major format such that the index corresponds to iy*ny+ix.
      Parameters:
      val - int[][] the new values
      nx -
      xmin - double
      xmax - double
      ymin - double
      ymax - double

    • setAll

      public void setAll(int[] v)
      Sets an array v of int values into the lattice, starting at (x=0,y=0). Values are in row-major format such that the index corresponds to iy*ny+ix.
      Parameters:
      v -

    • getAtIndex

      public int getAtIndex(int i)
      Gets the ith indexed cell of the lattice Values are in row-major format such that the index corresponds to iy*ny+ix.
      Parameters:
      i -
      Returns:
      value indexed by i

    • getValue

      public int getValue(int ix, int iy)
      Gets the (x,y) value of the lattice.
      Parameters:
      ix -
      iy -
      Returns:
      value at (ix,iy)

    • getAll

      public int[] getAll()
      Gets the entire lattice contents in an int array. Values are in row-major format such that the index corresponds to iy*ny+ix.
      Returns:
      array containing entire lattice contents

    • setToggleOnClick

      public void setToggleOnClick(boolean enable, int v1, int v2)
      Sets an action to toggle the grid betweem the given values when the mouse is pressed.
      Parameters:
      enable - boolean
      v1 - int
      v2 - int

    • indexFromPoint

      public int indexFromPoint(double x, double y)
      Determines the lattice index (row-major order) from given x and y world coordinates
      Parameters:
      x -
      y -
      Returns:
      index