optics.graphics
Class SpotDiagram

java.lang.Object
  java.awt.Component
      java.awt.Container
          java.awt.Window
              java.awt.Frame
                  javax.swing.JFrame
                      optics.graphics.Diagram2DFrame
                          optics.graphics.SpotDiagram

All Implemented Interfaces:

ImageObserver, MenuContainer, Serializable, Accessible, RootPaneContainer, WindowConstants

public class SpotDiagram
extends Diagram2DFrame

Class to implement a controllable Spot Diagram with slider and button controls in it own JFrame.

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class javax.swing.JFrame

JFrame.AccessibleJFrame

Nested classes/interfaces inherited from class java.awt.Frame

Frame.AccessibleAWTFrame

Nested classes/interfaces inherited from class java.awt.Window

Window.AccessibleAWTWindow

Nested classes/interfaces inherited from class java.awt.Container

Container.AccessibleAWTContainer

Nested classes/interfaces inherited from class java.awt.Component

Component.AccessibleAWTComponent, Component.BaselineResizeBehavior, Component.BltBufferStrategy, Component.FlipBufferStrategy

Field Summary

int	HEIGHT Default heigh of panel
double	planeIncrement
int	WIDTH Default width of frame

Fields inherited from class optics.graphics.Diagram2DFrame

frame, handler, menuColour, optionsMenu, panel, statusBar

Fields inherited from class javax.swing.JFrame

accessibleContext, EXIT_ON_CLOSE, rootPane, rootPaneCheckingEnabled

Fields inherited from class java.awt.Frame

CROSSHAIR_CURSOR, DEFAULT_CURSOR, E_RESIZE_CURSOR, HAND_CURSOR, ICONIFIED, MAXIMIZED_BOTH, MAXIMIZED_HORIZ, MAXIMIZED_VERT, MOVE_CURSOR, N_RESIZE_CURSOR, NE_RESIZE_CURSOR, NORMAL, NW_RESIZE_CURSOR, S_RESIZE_CURSOR, SE_RESIZE_CURSOR, SW_RESIZE_CURSOR, TEXT_CURSOR, W_RESIZE_CURSOR, WAIT_CURSOR

Fields inherited from class java.awt.Component

BOTTOM_ALIGNMENT, CENTER_ALIGNMENT, LEFT_ALIGNMENT, RIGHT_ALIGNMENT, TOP_ALIGNMENT

Fields inherited from interface javax.swing.WindowConstants

DISPOSE_ON_CLOSE, DO_NOTHING_ON_CLOSE, HIDE_ON_CLOSE

Fields inherited from interface java.awt.image.ImageObserver

ABORT, ALLBITS, ERROR, FRAMEBITS, PROPERTIES, SOMEBITS

Constructor Summary

SpotDiagram(Position p, double range)
Form a SpotDiagram with the centre of the disgram at the specified point in three-dimensions.

Method Summary

void	addRay(Ray r, Color c, boolean autoupdate) Method to add a Ray to the SpotDiagram.
int	addRayPencil(RayPencil pencil) Method to add a RayPencil of Rays with their colour colour determined by the wavelength of the first valid ray in the Pencil
int	addRayPencil(RayPencil pencil, Color c) Method to add a RayPencil to the SpotDiagram is a specified colour.
void	addToCentre(double dx, double dy) Method to incrementally move the centre of the diaplay
void	addToPlane(double dz) Increment the current output plane.
void	clear() Clear the spot diagram
void	extraButtons(ActionEvent e) Local action to deal with the 6 control buttons to move plane and centre.
double	getPlane() Get the position of the current plane
static void	main(String[] args) Method to test the SpotDiagram by making an on-axis dpot disgram in the back focal plane of a specifed lens in the default wavelength
void	setCentre(Point2d c) Set the centre of the displayed spot panel.
void	setPlane(double z) Set outout plane.
void	setRange(double range) Set the range of the Spotdiagram.

Methods inherited from class optics.graphics.Diagram2DFrame

addPanel, addStatusBar, centre, getActionListener, getMainMenu, getOptionsMenu, getPanel, setStatusBarText

Methods inherited from class javax.swing.JFrame

addImpl, createRootPane, frameInit, getAccessibleContext, getContentPane, getDefaultCloseOperation, getGlassPane, getGraphics, getJMenuBar, getLayeredPane, getRootPane, getTransferHandler, isDefaultLookAndFeelDecorated, isRootPaneCheckingEnabled, paramString, processWindowEvent, remove, repaint, setContentPane, setDefaultCloseOperation, setDefaultLookAndFeelDecorated, setGlassPane, setIconImage, setJMenuBar, setLayeredPane, setLayout, setRootPane, setRootPaneCheckingEnabled, setTransferHandler, update

Methods inherited from class java.awt.Frame

addNotify, getCursorType, getExtendedState, getFrames, getIconImage, getMaximizedBounds, getMenuBar, getState, getTitle, isResizable, isUndecorated, remove, removeNotify, setCursor, setExtendedState, setMaximizedBounds, setMenuBar, setResizable, setState, setTitle, setUndecorated

Methods inherited from class java.awt.Window

addPropertyChangeListener, addPropertyChangeListener, addWindowFocusListener, addWindowListener, addWindowStateListener, applyResourceBundle, applyResourceBundle, createBufferStrategy, createBufferStrategy, dispose, getBufferStrategy, getFocusableWindowState, getFocusCycleRootAncestor, getFocusOwner, getFocusTraversalKeys, getGraphicsConfiguration, getIconImages, getInputContext, getListeners, getLocale, getModalExclusionType, getMostRecentFocusOwner, getOwnedWindows, getOwner, getOwnerlessWindows, getToolkit, getWarningString, getWindowFocusListeners, getWindowListeners, getWindows, getWindowStateListeners, hide, isActive, isAlwaysOnTop, isAlwaysOnTopSupported, isFocusableWindow, isFocusCycleRoot, isFocused, isLocationByPlatform, isShowing, pack, postEvent, processEvent, processWindowFocusEvent, processWindowStateEvent, removeWindowFocusListener, removeWindowListener, removeWindowStateListener, reshape, setAlwaysOnTop, setBounds, setBounds, setCursor, setFocusableWindowState, setFocusCycleRoot, setIconImages, setLocationByPlatform, setLocationRelativeTo, setMinimumSize, setModalExclusionType, setSize, setSize, setVisible, show, toBack, toFront

Methods inherited from class java.awt.Container

add, add, add, add, add, addContainerListener, applyComponentOrientation, areFocusTraversalKeysSet, countComponents, deliverEvent, doLayout, findComponentAt, findComponentAt, getAlignmentX, getAlignmentY, getComponent, getComponentAt, getComponentAt, getComponentCount, getComponents, getComponentZOrder, getContainerListeners, getFocusTraversalPolicy, getInsets, getLayout, getMaximumSize, getMinimumSize, getMousePosition, getPreferredSize, insets, invalidate, isAncestorOf, isFocusCycleRoot, isFocusTraversalPolicyProvider, isFocusTraversalPolicySet, layout, list, list, locate, minimumSize, paint, paintComponents, preferredSize, print, printComponents, processContainerEvent, remove, removeAll, removeContainerListener, setComponentZOrder, setFocusTraversalKeys, setFocusTraversalPolicy, setFocusTraversalPolicyProvider, setFont, transferFocusBackward, transferFocusDownCycle, validate, validateTree

Methods inherited from class java.awt.Component

action, add, addComponentListener, addFocusListener, addHierarchyBoundsListener, addHierarchyListener, addInputMethodListener, addKeyListener, addMouseListener, addMouseMotionListener, addMouseWheelListener, bounds, checkImage, checkImage, coalesceEvents, contains, contains, createImage, createImage, createVolatileImage, createVolatileImage, disable, disableEvents, dispatchEvent, enable, enable, enableEvents, enableInputMethods, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, getBackground, getBaseline, getBaselineResizeBehavior, getBounds, getBounds, getColorModel, getComponentListeners, getComponentOrientation, getCursor, getDropTarget, getFocusListeners, getFocusTraversalKeysEnabled, getFont, getFontMetrics, getForeground, getHeight, getHierarchyBoundsListeners, getHierarchyListeners, getIgnoreRepaint, getInputMethodListeners, getInputMethodRequests, getKeyListeners, getLocation, getLocation, getLocationOnScreen, getMouseListeners, getMouseMotionListeners, getMousePosition, getMouseWheelListeners, getName, getParent, getPeer, getPropertyChangeListeners, getPropertyChangeListeners, getSize, getSize, getTreeLock, getWidth, getX, getY, gotFocus, handleEvent, hasFocus, imageUpdate, inside, isBackgroundSet, isCursorSet, isDisplayable, isDoubleBuffered, isEnabled, isFocusable, isFocusOwner, isFocusTraversable, isFontSet, isForegroundSet, isLightweight, isMaximumSizeSet, isMinimumSizeSet, isOpaque, isPreferredSizeSet, isValid, isVisible, keyDown, keyUp, list, list, list, location, lostFocus, mouseDown, mouseDrag, mouseEnter, mouseExit, mouseMove, mouseUp, move, nextFocus, paintAll, prepareImage, prepareImage, printAll, processComponentEvent, processFocusEvent, processHierarchyBoundsEvent, processHierarchyEvent, processInputMethodEvent, processKeyEvent, processMouseEvent, processMouseMotionEvent, processMouseWheelEvent, removeComponentListener, removeFocusListener, removeHierarchyBoundsListener, removeHierarchyListener, removeInputMethodListener, removeKeyListener, removeMouseListener, removeMouseMotionListener, removeMouseWheelListener, removePropertyChangeListener, removePropertyChangeListener, repaint, repaint, repaint, requestFocus, requestFocus, requestFocusInWindow, requestFocusInWindow, resize, resize, setBackground, setComponentOrientation, setDropTarget, setEnabled, setFocusable, setFocusTraversalKeysEnabled, setForeground, setIgnoreRepaint, setLocale, setLocation, setLocation, setMaximumSize, setName, setPreferredSize, show, size, toString, transferFocus, transferFocusUpCycle

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.awt.MenuContainer

getFont, postEvent

Field Detail

WIDTH

public int WIDTH

Default width of frame

HEIGHT

public int HEIGHT

Default heigh of panel

planeIncrement

public double planeIncrement

Constructor Detail

SpotDiagram

public SpotDiagram(Position p,
                   double range)

Form a SpotDiagram with the centre of the disgram at the specified point in three-dimensions.

Parameters:

p - position of the centre of panel

range - initial range of the Spot panel.

Method Detail

setRange

public void setRange(double range)

Set the range of the Spotdiagram. This will also force the panel to repaint.

Parameters:

range - the range of the panel

setCentre

public void setCentre(Point2d c)

Set the centre of the displayed spot panel. This will also force the SpotPanel to repaint.

Parameters:

c - the centre

addToCentre

public void addToCentre(double dx,
                        double dy)

Method to incrementally move the centre of the diaplay

Parameters:

dx - the x shift

dy - the y shift

setPlane

public void setPlane(double z)

Set outout plane. This will in general move the spots and automatically repaint the screen.

Parameters:

z - the plane position

addToPlane

public void addToPlane(double dz)

Increment the current output plane. This will in general move the spots and automatically repaint the screen.

Parameters:

dz - the plane increment

getPlane

public double getPlane()

Get the position of the current plane

Returns:

double Position of plane

clear

public void clear()

Clear the spot diagram

addRay

public void addRay(Ray r,
                   Color c,
                   boolean autoupdate)

Method to add a Ray to the SpotDiagram. The ray is held in the internal vector and also the Spot is set to appear in the display.

Invalid rays are ignored

Parameters:

r - the Ray

c - the Spot colour

autoupdate - if true panel is repain live else spot will be displayed on the next repaint.

addRayPencil

public int addRayPencil(RayPencil pencil,
                        Color c)

Method to add a RayPencil to the SpotDiagram is a specified colour.

Invalid rays will be ignored

Parameters:

pencil - the RayPencil to be added

c - Color of the rays on the panel.

Returns:

int number of valid rays added.

addRayPencil

public int addRayPencil(RayPencil pencil)

Method to add a RayPencil of Rays with their colour colour determined by the wavelength of the first valid ray in the Pencil

Parameters:

pencil - the RayPencil

Returns:

int number of valid rays added.

extraButtons

public void extraButtons(ActionEvent e)

Local action to deal with the 6 control buttons to move plane and centre.

Overrides:

extraButtons in class Diagram2DFrame

main

public static void main(String[] args)

Method to test the SpotDiagram by making an on-axis dpot disgram in the back focal plane of a specifed lens in the default wavelength