org.openpnp.gui.components

Class CameraView

java.lang.Object

java.awt.Component

java.awt.Container

javax.swing.JComponent

org.openpnp.gui.components.CameraView

All Implemented Interfaces:

java.awt.image.ImageObserver, java.awt.MenuContainer, java.io.Serializable, CameraListener

public class CameraView
extends javax.swing.JComponent
implements CameraListener

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	CameraView.RenderingQuality

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

javax.swing.JComponent.AccessibleJComponent

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

java.awt.Container.AccessibleAWTContainer

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

java.awt.Component.AccessibleAWTComponent, java.awt.Component.BaselineResizeBehavior, java.awt.Component.BltBufferStrategy, java.awt.Component.FlipBufferStrategy

Field Summary

Fields

Modifier and Type	Field and Description
CameraViewSelectionTextDelegate	pixelsAndUnitsTextSelectionDelegate

Fields inherited from class javax.swing.JComponent

listenerList, TOOL_TIP_TEXT_KEY, ui, UNDEFINED_CONDITION, WHEN_ANCESTOR_OF_FOCUSED_COMPONENT, WHEN_FOCUSED, WHEN_IN_FOCUSED_WINDOW

Fields inherited from class java.awt.Component

accessibleContext, BOTTOM_ALIGNMENT, CENTER_ALIGNMENT, LEFT_ALIGNMENT, RIGHT_ALIGNMENT, TOP_ALIGNMENT

Fields inherited from interface java.awt.image.ImageObserver

ABORT, ALLBITS, ERROR, FRAMEBITS, HEIGHT, PROPERTIES, SOMEBITS, WIDTH

Constructor Summary

Constructors

Constructor and Description
CameraView()

Method Summary

Modifier and Type	Method and Description
void	addActionListener(CameraViewActionListener listener)
java.awt.image.BufferedImage	captureSelectionImage()
void	flash() Causes a short flash in the CameraView to get the user's attention.
void	frameReceived(java.awt.image.BufferedImage img)
Camera	getCamera()
Location	getCameraViewCenterOffsetsFromXy(int x, int y)
java.awt.Point	getCameraViewCenterPixelsFromXy(int x, int y) Gets the offset from the center of the image in camera pixels given a set of coordinates in the camera view component.
static java.awt.Cursor	getCursorForHandlePosition(org.openpnp.gui.components.CameraView.HandlePosition handlePosition)
Reticle	getDefaultReticle()
CameraView.RenderingQuality	getRenderingQuality()
Reticle	getReticle(java.lang.Object key)
java.awt.Rectangle	getSelection()
CameraViewSelectionTextDelegate	getSelectionTextDelegate()
java.lang.String	getText()
double	getZoomIncPerMouseWheelTick()
boolean	isSelectionEnabled()
boolean	isShowImageInfo()
boolean	isShowName()
boolean	isViewingPlaneChangable() Checks to see if the viewing plane for this camera can be changed to different heights.
protected void	paintComponent(java.awt.Graphics g)
boolean	removeActionListener(CameraViewActionListener listener)
Reticle	removeReticle(java.lang.Object key)
void	setCamera(Camera camera)
void	setCameraViewFilter(CameraViewFilter cameraViewFilter)
void	setDefaultReticle(Reticle reticle)
void	setRenderingQuality(CameraView.RenderingQuality renderingQuality)
void	setReticle(java.lang.Object key, Reticle reticle)
void	setSelection(int x, int y, int width, int height) Set the selection rectangle in image coordinates.
void	setSelection(java.awt.Rectangle r) Set the selection rectangle in image coordinates.
void	setSelectionEnabled(boolean selectionEnabled)
void	setSelectionTextDelegate(CameraViewSelectionTextDelegate selectionTextDelegate)
void	setShowImageInfo(boolean showImageInfo)
void	setShowName(boolean showName)
void	setText(java.lang.String text)
void	setZoomIncPerMouseWheelTick(double zoomIncPerMouseWheelTick)
void	showFilteredImage(java.awt.image.BufferedImage filteredImage, long milliseconds)
void	showFilteredImage(java.awt.image.BufferedImage filteredImage, java.lang.String text, long milliseconds) Show image instead of the camera image for milliseconds.
void	showFilteredImages(java.awt.image.BufferedImage[] filteredImages, java.lang.String[] texts, long milliseconds) Show an animation of N images instead of the camera image for milliseconds each frame.

Methods inherited from class javax.swing.JComponent

addAncestorListener, addNotify, addVetoableChangeListener, computeVisibleRect, contains, createToolTip, disable, enable, firePropertyChange, firePropertyChange, firePropertyChange, fireVetoableChange, getActionForKeyStroke, getActionMap, getAlignmentX, getAlignmentY, getAncestorListeners, getAutoscrolls, getBaseline, getBaselineResizeBehavior, getBorder, getBounds, getClientProperty, getComponentGraphics, getComponentPopupMenu, getConditionForKeyStroke, getDebugGraphicsOptions, getDefaultLocale, getFontMetrics, getGraphics, getHeight, getInheritsPopupMenu, getInputMap, getInputMap, getInputVerifier, getInsets, getInsets, getListeners, getLocation, getMaximumSize, getMinimumSize, getNextFocusableComponent, getPopupLocation, getPreferredSize, getRegisteredKeyStrokes, getRootPane, getSize, getToolTipLocation, getToolTipText, getToolTipText, getTopLevelAncestor, getTransferHandler, getUIClassID, getVerifyInputWhenFocusTarget, getVetoableChangeListeners, getVisibleRect, getWidth, getX, getY, grabFocus, hide, isDoubleBuffered, isLightweightComponent, isManagingFocus, isOpaque, isOptimizedDrawingEnabled, isPaintingForPrint, isPaintingOrigin, isPaintingTile, isRequestFocusEnabled, isValidateRoot, paint, paintBorder, paintChildren, paintImmediately, paintImmediately, paramString, print, printAll, printBorder, printChildren, printComponent, processComponentKeyEvent, processKeyBinding, processKeyEvent, processMouseEvent, processMouseMotionEvent, putClientProperty, registerKeyboardAction, registerKeyboardAction, removeAncestorListener, removeNotify, removeVetoableChangeListener, repaint, repaint, requestDefaultFocus, requestFocus, requestFocus, requestFocusInWindow, requestFocusInWindow, resetKeyboardActions, reshape, revalidate, scrollRectToVisible, setActionMap, setAlignmentX, setAlignmentY, setAutoscrolls, setBackground, setBorder, setComponentPopupMenu, setDebugGraphicsOptions, setDefaultLocale, setDoubleBuffered, setEnabled, setFocusTraversalKeys, setFont, setForeground, setInheritsPopupMenu, setInputMap, setInputVerifier, setMaximumSize, setMinimumSize, setNextFocusableComponent, setOpaque, setPreferredSize, setRequestFocusEnabled, setToolTipText, setTransferHandler, setUI, setVerifyInputWhenFocusTarget, setVisible, unregisterKeyboardAction, update, updateUI

Methods inherited from class java.awt.Container

add, add, add, add, add, addContainerListener, addImpl, addPropertyChangeListener, addPropertyChangeListener, applyComponentOrientation, areFocusTraversalKeysSet, countComponents, deliverEvent, doLayout, findComponentAt, findComponentAt, getComponent, getComponentAt, getComponentAt, getComponentCount, getComponents, getComponentZOrder, getContainerListeners, getFocusTraversalKeys, getFocusTraversalPolicy, getLayout, getMousePosition, insets, invalidate, isAncestorOf, isFocusCycleRoot, isFocusCycleRoot, isFocusTraversalPolicyProvider, isFocusTraversalPolicySet, layout, list, list, locate, minimumSize, paintComponents, preferredSize, printComponents, processContainerEvent, processEvent, remove, remove, removeAll, removeContainerListener, setComponentZOrder, setFocusCycleRoot, setFocusTraversalPolicy, setFocusTraversalPolicyProvider, setLayout, 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, createImage, createImage, createVolatileImage, createVolatileImage, disableEvents, dispatchEvent, enable, enableEvents, enableInputMethods, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, getAccessibleContext, getBackground, getBounds, getColorModel, getComponentListeners, getComponentOrientation, getCursor, getDropTarget, getFocusCycleRootAncestor, getFocusListeners, getFocusTraversalKeysEnabled, getFont, getForeground, getGraphicsConfiguration, getHierarchyBoundsListeners, getHierarchyListeners, getIgnoreRepaint, getInputContext, getInputMethodListeners, getInputMethodRequests, getKeyListeners, getLocale, getLocation, getLocationOnScreen, getMouseListeners, getMouseMotionListeners, getMousePosition, getMouseWheelListeners, getName, getParent, getPeer, getPropertyChangeListeners, getPropertyChangeListeners, getSize, getToolkit, getTreeLock, gotFocus, handleEvent, hasFocus, imageUpdate, inside, isBackgroundSet, isCursorSet, isDisplayable, isEnabled, isFocusable, isFocusOwner, isFocusTraversable, isFontSet, isForegroundSet, isLightweight, isMaximumSizeSet, isMinimumSizeSet, isPreferredSizeSet, isShowing, isValid, isVisible, keyDown, keyUp, list, list, list, location, lostFocus, mouseDown, mouseDrag, mouseEnter, mouseExit, mouseMove, mouseUp, move, nextFocus, paintAll, postEvent, prepareImage, prepareImage, processComponentEvent, processFocusEvent, processHierarchyBoundsEvent, processHierarchyEvent, processInputMethodEvent, processMouseWheelEvent, remove, removeComponentListener, removeFocusListener, removeHierarchyBoundsListener, removeHierarchyListener, removeInputMethodListener, removeKeyListener, removeMouseListener, removeMouseMotionListener, removeMouseWheelListener, removePropertyChangeListener, removePropertyChangeListener, repaint, repaint, repaint, resize, resize, setBounds, setBounds, setComponentOrientation, setCursor, setDropTarget, setFocusable, setFocusTraversalKeysEnabled, setIgnoreRepaint, setLocale, setLocation, setLocation, setName, setSize, setSize, show, show, size, toString, transferFocus, transferFocusBackward, transferFocusUpCycle

Methods inherited from class java.lang.Object

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

Field Detail

pixelsAndUnitsTextSelectionDelegate

public CameraViewSelectionTextDelegate pixelsAndUnitsTextSelectionDelegate

Constructor Detail

CameraView

public CameraView()

Method Detail

addActionListener

public void addActionListener(CameraViewActionListener listener)

removeActionListener

public boolean removeActionListener(CameraViewActionListener listener)

setCamera

public void setCamera(Camera camera)

getCamera

public Camera getCamera()

setShowName

public void setShowName(boolean showName)

isShowName

public boolean isShowName()

setDefaultReticle

public void setDefaultReticle(Reticle reticle)

getDefaultReticle

public Reticle getDefaultReticle()

setReticle

public void setReticle(java.lang.Object key,
                       Reticle reticle)

getReticle

public Reticle getReticle(java.lang.Object key)

removeReticle

public Reticle removeReticle(java.lang.Object key)

getSelectionTextDelegate

public CameraViewSelectionTextDelegate getSelectionTextDelegate()

setSelectionTextDelegate

public void setSelectionTextDelegate(CameraViewSelectionTextDelegate selectionTextDelegate)

getText

public java.lang.String getText()

setText

public void setText(java.lang.String text)

getZoomIncPerMouseWheelTick

public double getZoomIncPerMouseWheelTick()

setZoomIncPerMouseWheelTick

public void setZoomIncPerMouseWheelTick(double zoomIncPerMouseWheelTick)

getRenderingQuality

public CameraView.RenderingQuality getRenderingQuality()

setRenderingQuality

public void setRenderingQuality(CameraView.RenderingQuality renderingQuality)

isViewingPlaneChangable

public boolean isViewingPlaneChangable()

Checks to see if the viewing plane for this camera can be changed to different heights. This is true if the camera's Units Per Pixel is different at two different heights.

Returns:

true if the viewing plane can be changed

flash

public void flash()

Causes a short flash in the CameraView to get the user's attention.

setCameraViewFilter

public void setCameraViewFilter(CameraViewFilter cameraViewFilter)

showFilteredImage

public void showFilteredImage(java.awt.image.BufferedImage filteredImage,
                              long milliseconds)

showFilteredImages

public void showFilteredImages(java.awt.image.BufferedImage[] filteredImages,
                               java.lang.String[] texts,
                               long milliseconds)

Show an animation of N images instead of the camera image for milliseconds each frame. After N*milliseconds elapses the view goes back to showing the camera image. See also showFilteredImage().

Parameters:

images -

texts -

millseconds -

showFilteredImage

public void showFilteredImage(java.awt.image.BufferedImage filteredImage,
                              java.lang.String text,
                              long milliseconds)

Show image instead of the camera image for milliseconds. After milliseconds elapses the view goes back to showing the camera image. The image should be the same width and height as the camera image otherwise the behavior is undefined. This function is intended to be used to briefly show the result of image processing. This is a shortcut to setCameraViewFilter(CameraViewFilter) which simply removes itself after the specified time. In addition to showing the given image, if the text parameters is not null the text will be shown during the timeout using setText().

Parameters:

image -

text -

millseconds -

captureSelectionImage

public java.awt.image.BufferedImage captureSelectionImage()

getSelection

public java.awt.Rectangle getSelection()

frameReceived

public void frameReceived(java.awt.image.BufferedImage img)

Specified by:

frameReceived in interface CameraListener

paintComponent

protected void paintComponent(java.awt.Graphics g)

Overrides:

paintComponent in class javax.swing.JComponent

setSelection

public void setSelection(int x,
                         int y,
                         int width,
                         int height)

Set the selection rectangle in image coordinates.

Parameters:

x -

y -

width -

height -

setSelection

public void setSelection(java.awt.Rectangle r)

Set the selection rectangle in image coordinates.

Parameters:

r -

isSelectionEnabled

public boolean isSelectionEnabled()

setSelectionEnabled

public void setSelectionEnabled(boolean selectionEnabled)

isShowImageInfo

public boolean isShowImageInfo()

setShowImageInfo

public void setShowImageInfo(boolean showImageInfo)

getCursorForHandlePosition

public static java.awt.Cursor getCursorForHandlePosition(org.openpnp.gui.components.CameraView.HandlePosition handlePosition)

getCameraViewCenterPixelsFromXy

public java.awt.Point getCameraViewCenterPixelsFromXy(int x,
                                                      int y)

Gets the offset from the center of the image in camera pixels given a set of coordinates in the camera view component.

Parameters:

x - - the x position in the camera's view component as returned by a mouse click

y - - the y position in the camera's view component as returned by a mouse click

Returns:

the offset in camera pixels from the center of the image in a bottom left to top right coordinate system

getCameraViewCenterOffsetsFromXy

public Location getCameraViewCenterOffsetsFromXy(int x,
                                                 int y)