com.metsci.glimpse.canvas

Class NewtSwingGlimpseCanvas

java.lang.Object

java.awt.Component

java.awt.Container

javax.swing.JComponent

javax.swing.JPanel

com.metsci.glimpse.canvas.NewtSwingGlimpseCanvas

All Implemented Interfaces:

GlimpseCanvas, NewtGlimpseCanvas, GlimpseTarget, ImageObserver, MenuContainer, Serializable, Accessible

Direct Known Subclasses:

NewtSwingEDTGlimpseCanvas

public class NewtSwingGlimpseCanvas
extends JPanel
implements NewtGlimpseCanvas

A GlimpseCanvas backed by the JOGL NewtCanvasAWT. This is the default GlimpseCanvas which should be used for most Swing applications. The underlying NewtCanvasAWT is being actively developed, whereas the underlying canvas for SwingGlimpseCanvas is no longer supported and has fewer features.

Author:

ulman

See Also:

Serialized Form

Nested Class Summary

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

JComponent.AccessibleJComponent

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

Component.BaselineResizeBehavior

Field Summary

Fields inherited from class javax.swing.JComponent

TOOL_TIP_TEXT_KEY, UNDEFINED_CONDITION, WHEN_ANCESTOR_OF_FOCUSED_COMPONENT, WHEN_FOCUSED, WHEN_IN_FOCUSED_WINDOW

Fields inherited from class java.awt.Component

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
NewtSwingGlimpseCanvas()
NewtSwingGlimpseCanvas(javax.media.opengl.GLContext context)
NewtSwingGlimpseCanvas(javax.media.opengl.GLProfile glProfile)
NewtSwingGlimpseCanvas(javax.media.opengl.GLProfile glProfile, javax.media.opengl.GLContext context) Deprecated. Use NewtSwingGlimpseCanvas(GLContext) instead. The context implicitly provides a GLProfile.
NewtSwingGlimpseCanvas(String profile)
NewtSwingGlimpseCanvas(String glProfile, javax.media.opengl.GLContext context) Deprecated. Use NewtSwingGlimpseCanvas(GLContext) instead. The context implicitly provides a GLProfile.

Method Summary

Modifier and Type	Method and Description
void	addDisposeListener(javax.media.opengl.GLRunnable runnable) Called when GLEventListener.dispose(GLAutoDrawable) event is fired by the GLAutoDrawable associated with the GlimpseCanvas.
void	addLayout(GlimpseLayout layout) Adds a sub-layout to this GlimpseTarget which will only paint in a region of this GlimpseTarget based on its layout constraints.
void	addLayout(GlimpseLayout layout, int zOrder)
void	destroy() Destroys the native surface which this canvas draws to.
void	dispose() A convenience method which is equivalent to: disposeAttached( ); destroy( );
void	disposeAttached() Disposes native resources of GlimpseLayouts and GlimpsePainters associated with the GlimpseCanvas.
void	disposePainter(GlimpsePainter painter) Calls GlimpsePainter.dispose(GlimpseContext) the next time the GLContext associated with this GlimpseCanvas is active.
com.jogamp.newt.awt.NewtCanvasAWT	getCanvas()
Dimension	getDimension()
javax.media.opengl.GLContext	getGLContext()
javax.media.opengl.GLAutoDrawable	getGLDrawable()
GlimpseContext	getGlimpseContext()
javax.media.opengl.GLProfile	getGLProfile()
com.jogamp.newt.opengl.GLWindow	getGLWindow()
int[]	getSurfaceScale() Returns the scale factors needed to convert the _native_ pixel coordinates to the _window_ pixel coordinates.
GlimpseBounds	getTargetBounds()
GlimpseBounds	getTargetBounds(GlimpseTargetStack stack) Returns the cached or calculated bounds of this GlimpseTarget for a particular context.
List<GlimpseTarget>	getTargetChildren()
boolean	isDestroyed()
boolean	isEventConsumer() Sets whether this GlimpseTarget hides events from GlimpseTargets under it.
boolean	isEventGenerator() Sets whether this GlimpseTarget generates GlimpseMouseEvents.
void	paint() Lays out any GlimpseLayout instances attached to the GlimpseCanvas and paints all GlimpsePainter instances attached to the GlimpseLayouts.
void	removeAllLayouts() Clears the canvas, removing all attached GlimpseLayouts.
void	removeLayout(GlimpseLayout layout) Removes a previously added layout from this GlimpseTarget.
void	setEventConsumer(boolean consume) Set whether or not this GlimpseTarget will consume or pass through mouse events.
void	setEventGenerator(boolean generate) Set whether or not this GlimpseTarget will generate GlimpseMouseEvents.
void	setLookAndFeel(LookAndFeel laf) Sets the LookAndFeel for this GlimpseTarget and all child GlimpseTargets.
void	setZOrder(GlimpseLayout layout, int zOrder)
String	toString()

Methods inherited from class javax.swing.JPanel

getAccessibleContext, getUI, getUIClassID, setUI, updateUI

Methods inherited from class javax.swing.JComponent

addAncestorListener, addNotify, addVetoableChangeListener, computeVisibleRect, contains, createToolTip, disable, enable, firePropertyChange, firePropertyChange, firePropertyChange, getActionForKeyStroke, getActionMap, getAlignmentX, getAlignmentY, getAncestorListeners, getAutoscrolls, getBaseline, getBaselineResizeBehavior, getBorder, getBounds, getClientProperty, 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, getVerifyInputWhenFocusTarget, getVetoableChangeListeners, getVisibleRect, getWidth, getX, getY, grabFocus, hide, isDoubleBuffered, isLightweightComponent, isManagingFocus, isOpaque, isOptimizedDrawingEnabled, isPaintingForPrint, isPaintingTile, isRequestFocusEnabled, isValidateRoot, paint, paintImmediately, paintImmediately, print, printAll, putClientProperty, registerKeyboardAction, registerKeyboardAction, removeAncestorListener, removeNotify, removeVetoableChangeListener, repaint, repaint, requestDefaultFocus, requestFocus, requestFocus, 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, setVerifyInputWhenFocusTarget, setVisible, unregisterKeyboardAction, update

Methods inherited from class java.awt.Container

add, add, add, add, add, addContainerListener, 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, remove, remove, removeAll, removeContainerListener, setComponentZOrder, setFocusCycleRoot, setFocusTraversalPolicy, setFocusTraversalPolicyProvider, setLayout, transferFocusDownCycle, validate

Methods inherited from class java.awt.Component

action, add, addComponentListener, addFocusListener, addHierarchyBoundsListener, addHierarchyListener, addInputMethodListener, addKeyListener, addMouseListener, addMouseMotionListener, addMouseWheelListener, bounds, checkImage, checkImage, contains, createImage, createImage, createVolatileImage, createVolatileImage, dispatchEvent, enable, enableInputMethods, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, 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, 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, transferFocus, transferFocusBackward, transferFocusUpCycle

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.metsci.glimpse.context.GlimpseTarget

isVisible

Constructor Detail

NewtSwingGlimpseCanvas

@Deprecated
public NewtSwingGlimpseCanvas(String glProfile,
                                          javax.media.opengl.GLContext context)

Deprecated. Use NewtSwingGlimpseCanvas(GLContext) instead. The context implicitly provides a GLProfile.

NewtSwingGlimpseCanvas

@Deprecated
public NewtSwingGlimpseCanvas(javax.media.opengl.GLProfile glProfile,
                                          javax.media.opengl.GLContext context)

Deprecated. Use NewtSwingGlimpseCanvas(GLContext) instead. The context implicitly provides a GLProfile.

NewtSwingGlimpseCanvas

public NewtSwingGlimpseCanvas(javax.media.opengl.GLProfile glProfile)

NewtSwingGlimpseCanvas

public NewtSwingGlimpseCanvas(String profile)

NewtSwingGlimpseCanvas

public NewtSwingGlimpseCanvas(javax.media.opengl.GLContext context)

NewtSwingGlimpseCanvas

public NewtSwingGlimpseCanvas()

Method Detail

getGLProfile

public javax.media.opengl.GLProfile getGLProfile()

Specified by:

getGLProfile in interface GlimpseCanvas

getCanvas

public com.jogamp.newt.awt.NewtCanvasAWT getCanvas()

getGLDrawable

public javax.media.opengl.GLAutoDrawable getGLDrawable()

Specified by:

getGLDrawable in interface GlimpseCanvas

getGLWindow

public com.jogamp.newt.opengl.GLWindow getGLWindow()

Specified by:

getGLWindow in interface NewtGlimpseCanvas

getGlimpseContext

public GlimpseContext getGlimpseContext()

Specified by:

getGlimpseContext in interface GlimpseCanvas

setLookAndFeel

public void setLookAndFeel(LookAndFeel laf)

Description copied from interface: GlimpseTarget

Sets the LookAndFeel for this GlimpseTarget and all child GlimpseTargets.

Specified by:

setLookAndFeel in interface GlimpseTarget

addLayout

public void addLayout(GlimpseLayout layout)

Description copied from interface: GlimpseTarget

Adds a sub-layout to this GlimpseTarget which will only paint in a region of this GlimpseTarget based on its layout constraints. This same GlimpseLayout may be a child of any number of different GlimpseTargets.

Specified by:

addLayout in interface GlimpseTarget

addLayout

public void addLayout(GlimpseLayout layout,
                      int zOrder)

Specified by:

addLayout in interface GlimpseTarget

setZOrder

public void setZOrder(GlimpseLayout layout,
                      int zOrder)

Specified by:

setZOrder in interface GlimpseTarget

removeLayout

public void removeLayout(GlimpseLayout layout)

Description copied from interface: GlimpseTarget

Removes a previously added layout from this GlimpseTarget.

Specified by:

removeLayout in interface GlimpseTarget

removeAllLayouts

public void removeAllLayouts()

Description copied from interface: GlimpseTarget

Clears the canvas, removing all attached GlimpseLayouts.

Specified by:

removeAllLayouts in interface GlimpseTarget

getTargetChildren

public List<GlimpseTarget> getTargetChildren()

Specified by:

getTargetChildren in interface GlimpseTarget

Returns:

the list of children added through addLayout( GlimpseLayout ).

getDimension

public Dimension getDimension()

getTargetBounds

public GlimpseBounds getTargetBounds(GlimpseTargetStack stack)

Description copied from interface: GlimpseTarget

Returns the cached or calculated bounds of this GlimpseTarget for a particular context.

Specified by:

getTargetBounds in interface GlimpseTarget

Returns:

the bounds for the given stack

getTargetBounds

public GlimpseBounds getTargetBounds()

Specified by:

getTargetBounds in interface GlimpseCanvas

paint

public void paint()

Description copied from interface: GlimpseCanvas

Lays out any GlimpseLayout instances attached to the GlimpseCanvas and paints all GlimpsePainter instances attached to the GlimpseLayouts.

Specified by:

paint in interface GlimpseCanvas

getGLContext

public javax.media.opengl.GLContext getGLContext()

Specified by:

getGLContext in interface GlimpseCanvas

toString

public String toString()

Overrides:

toString in class Component

isEventConsumer

public boolean isEventConsumer()

Description copied from interface: GlimpseTarget

Sets whether this GlimpseTarget hides events from GlimpseTargets under it. This value does not determine whether or not the GlimpseTarget will generate GlimpseMouseEvents (see {@link #isEventGenerator()).

Specified by:

isEventConsumer in interface GlimpseTarget

Returns:

whether this target hides events from targets under it

setEventConsumer

public void setEventConsumer(boolean consume)

Description copied from interface: GlimpseTarget

Set whether or not this GlimpseTarget will consume or pass through mouse events.

Specified by:

setEventConsumer in interface GlimpseTarget

isEventGenerator

public boolean isEventGenerator()

Description copied from interface: GlimpseTarget

Sets whether this GlimpseTarget generates GlimpseMouseEvents. This value does not determine whether or not GlimpseTargets underneath this GlimpseTarget will also generate GlimpseMouseEvents (see GlimpseTarget.isEventConsumer()).

Specified by:

isEventGenerator in interface GlimpseTarget

Returns:

whether this target will generate GlimpseMouseEvents

setEventGenerator

public void setEventGenerator(boolean generate)

Description copied from interface: GlimpseTarget

Set whether or not this GlimpseTarget will generate GlimpseMouseEvents.

Specified by:

setEventGenerator in interface GlimpseTarget

destroy

public void destroy()

Description copied from interface: GlimpseCanvas

Destroys the native surface which this canvas draws to. Does not dispose of GL resources associated with GlimpsePainters and GlimpseLayouts attached to the GlimpseCanvas (as these may be attached to other GlimpseCanvases as well). Disposing of Glimpse resources can be done via #disposeAttached().

Specified by:

destroy in interface GlimpseCanvas

See Also:

GlimpseCanvas.disposeAttached()

isDestroyed

public boolean isDestroyed()

Specified by:

isDestroyed in interface GlimpseCanvas

Returns:

whether or not #dispose() has been successfully called. Once true, this GlimpseCanvas is no longer valid for rendering.

addDisposeListener

public void addDisposeListener(javax.media.opengl.GLRunnable runnable)

Description copied from interface: GlimpseCanvas

Called when GLEventListener.dispose(GLAutoDrawable) event is fired by the GLAutoDrawable associated with the GlimpseCanvas. This can happen for reasons other than the window containing the GlimpseCanvas being closed (for example, moving the window between physical monitors or moving the container between docks in a docking framework). Thus, GlimpsePainters and GlimpseLayouts attached to this GlimpseCanvas should generally not be disposed when this callback occurs.

Specified by:

addDisposeListener in interface GlimpseCanvas

dispose

public void dispose()

Description copied from interface: GlimpseCanvas

A convenience method which is equivalent to: disposeAttached( ); destroy( );

Specified by:

dispose in interface GlimpseCanvas

disposeAttached

public void disposeAttached()

Description copied from interface: GlimpseCanvas

Disposes native resources of GlimpseLayouts and GlimpsePainters associated with the GlimpseCanvas.

Specified by:

disposeAttached in interface GlimpseCanvas

See Also:

GlimpseCanvas.destroy()

disposePainter

public void disposePainter(GlimpsePainter painter)

Description copied from interface: GlimpseCanvas

Calls GlimpsePainter.dispose(GlimpseContext) the next time the GLContext associated with this GlimpseCanvas is active. Generally this call is equivalent to:

this.getGLDrawable( ).invoke( false, new GLRunnable( ) {

Specified by:

disposePainter in interface GlimpseCanvas

getSurfaceScale

public int[] getSurfaceScale()

Description copied from interface: GlimpseCanvas

Returns the scale factors needed to convert the _native_ pixel coordinates to the _window_ pixel coordinates. This only really matters on displays like like Macbook Retina.

Specified by:

getSurfaceScale in interface GlimpseCanvas

Returns:

the scale factors as {scaleX, scaleY}