javax.media.opengl
Class GLCanvas

java.lang.Object
  java.awt.Component
      java.awt.Canvas
          javax.media.opengl.GLCanvas

All Implemented Interfaces:

Accessible, ComponentEvents, GLAutoDrawable, GLDrawable, ImageObserver, MenuContainer, Serializable

public class GLCanvas

extends Canvas

implements GLAutoDrawable

A heavyweight AWT component which provides OpenGL rendering support. This is the primary implementation of GLDrawable; GLJPanel is provided for compatibility with Swing user interfaces when adding a heavyweight doesn't work either because of Z-ordering or LayoutManager problems.

See Also:

Serialized Form

Nested Class Summary

Nested classes inherited from class java.awt.Canvas

Canvas.AccessibleAWTCanvas

Nested classes inherited from class java.awt.Component

Component.AccessibleAWTComponent, Component.BltBufferStrategy, Component.FlipBufferStrategy

Field Summary

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

GLCanvas()
Creates a new GLCanvas component with a default set of OpenGL capabilities, using the default OpenGL capabilities selection mechanism, on the default screen device.

GLCanvas(GLCapabilities capabilities)
Creates a new GLCanvas component with the requested set of OpenGL capabilities, using the default OpenGL capabilities selection mechanism, on the default screen device.

GLCanvas(GLCapabilities capabilities, GLCapabilitiesChooser chooser, GLContext shareWith, GraphicsDevice device)
Creates a new GLCanvas component.

Method Summary

void	addGLEventListener(GLEventListener listener) Adds a GLEventListener to this drawable.
void	addNotify() Overridden to track when this component is added to a container.
GLContext	createContext(GLContext shareWith) Creates a new context for drawing to this drawable that will optionally share display lists and other server-side OpenGL objects with the specified GLContext.
void	display() Causes OpenGL rendering to be performed for this GLAutoDrawable by calling display for all registered GLEventListeners.
boolean	getAutoSwapBufferMode() Indicates whether automatic buffer swapping is enabled for this drawable.
GLCapabilities	getChosenGLCapabilities() Fetches the GLCapabilities corresponding to the chosen OpenGL capabilities (pixel format / visual) for this drawable.
GLContext	getContext() Returns the context associated with this drawable.
GL	getGL() Returns the GL pipeline object this GLAutoDrawable uses.
GraphicsConfiguration	getGraphicsConfiguration() Overridden to choose a GraphicsConfiguration on a parent container's GraphicsDevice because both devices
void	paint(Graphics g) Overridden to cause OpenGL rendering to be performed during repaint cycles.
void	removeGLEventListener(GLEventListener listener) Removes a GLEventListener from this drawable.
void	removeNotify() Overridden to track when this component is removed from a container.
void	reshape(int x, int y, int width, int height) Overridden to cause GLDrawableHelper.reshape(javax.media.opengl.GLAutoDrawable, int, int, int, int) to be called on all registered GLEventListeners.
void	setAutoSwapBufferMode(boolean onOrOff) Enables or disables automatic buffer swapping for this drawable.
void	setGL(GL gl) Sets the GL pipeline object this GLAutoDrawable uses.
void	setRealized(boolean realized) Indicates to on-screen GLDrawable implementations whether the underlying window has been created and can be drawn into.
void	swapBuffers() Swaps the front and back buffers of this drawable.
void	update(Graphics g) Overrides: update in class java.awt.Component

Methods inherited from class java.awt.Canvas

createBufferStrategy, createBufferStrategy, getAccessibleContext, getBufferStrategy

Methods inherited from class java.awt.Component

action, add, addComponentListener, addFocusListener, addHierarchyBoundsListener, addHierarchyListener, addInputMethodListener, addKeyListener, addMouseListener, addMouseMotionListener, addMouseWheelListener, addPropertyChangeListener, addPropertyChangeListener, applyComponentOrientation, areFocusTraversalKeysSet, bounds, checkImage, checkImage, coalesceEvents, contains, contains, createImage, createImage, createVolatileImage, createVolatileImage, deliverEvent, disable, disableEvents, dispatchEvent, doLayout, enable, enable, enableEvents, enableInputMethods, firePropertyChange, firePropertyChange, firePropertyChange, getAlignmentX, getAlignmentY, getBackground, getBounds, getBounds, getColorModel, getComponentAt, getComponentAt, getComponentListeners, getComponentOrientation, getCursor, getDropTarget, getFocusCycleRootAncestor, getFocusListeners, getFocusTraversalKeys, getFocusTraversalKeysEnabled, getFont, getFontMetrics, getForeground, getGraphics, getHeight, getHierarchyBoundsListeners, getHierarchyListeners, getIgnoreRepaint, getInputContext, getInputMethodListeners, getInputMethodRequests, getKeyListeners, getListeners, getLocale, getLocation, getLocation, getLocationOnScreen, getMaximumSize, getMinimumSize, getMouseListeners, getMouseMotionListeners, getMouseWheelListeners, getName, getParent, getPeer, getPreferredSize, getPropertyChangeListeners, getPropertyChangeListeners, getSize, getSize, getToolkit, getTreeLock, getWidth, getX, getY, gotFocus, handleEvent, hasFocus, hide, imageUpdate, inside, invalidate, isBackgroundSet, isCursorSet, isDisplayable, isDoubleBuffered, isEnabled, isFocusable, isFocusCycleRoot, isFocusOwner, isFocusTraversable, isFontSet, isForegroundSet, isLightweight, isOpaque, isShowing, isValid, isVisible, keyDown, keyUp, layout, list, list, list, list, list, locate, location, lostFocus, minimumSize, mouseDown, mouseDrag, mouseEnter, mouseExit, mouseMove, mouseUp, move, nextFocus, paintAll, paramString, postEvent, preferredSize, prepareImage, prepareImage, print, printAll, processComponentEvent, processEvent, processFocusEvent, processHierarchyBoundsEvent, processHierarchyEvent, processInputMethodEvent, processKeyEvent, processMouseEvent, processMouseMotionEvent, processMouseWheelEvent, remove, removeComponentListener, removeFocusListener, removeHierarchyBoundsListener, removeHierarchyListener, removeInputMethodListener, removeKeyListener, removeMouseListener, removeMouseMotionListener, removeMouseWheelListener, removePropertyChangeListener, removePropertyChangeListener, repaint, repaint, repaint, repaint, requestFocus, requestFocus, requestFocusInWindow, requestFocusInWindow, resize, resize, setBackground, setBounds, setBounds, setComponentOrientation, setCursor, setDropTarget, setEnabled, setFocusable, setFocusTraversalKeys, setFocusTraversalKeysEnabled, setFont, setForeground, setIgnoreRepaint, setLocale, setLocation, setLocation, setName, setSize, setSize, setVisible, show, show, size, toString, transferFocus, transferFocusBackward, transferFocusUpCycle, validate

Methods inherited from class java.lang.Object

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

Methods inherited from interface javax.media.opengl.GLAutoDrawable

repaint

Methods inherited from interface javax.media.opengl.GLDrawable

getHeight, getWidth, setSize

Methods inherited from interface javax.media.opengl.ComponentEvents

addComponentListener, addFocusListener, addHierarchyBoundsListener, addHierarchyListener, addInputMethodListener, addKeyListener, addMouseListener, addMouseMotionListener, addMouseWheelListener, addPropertyChangeListener, addPropertyChangeListener, removeComponentListener, removeFocusListener, removeHierarchyBoundsListener, removeHierarchyListener, removeInputMethodListener, removeKeyListener, removeMouseListener, removeMouseMotionListener, removeMouseWheelListener, removePropertyChangeListener, removePropertyChangeListener

Constructor Detail

GLCanvas

public GLCanvas()

Creates a new GLCanvas component with a default set of OpenGL capabilities, using the default OpenGL capabilities selection mechanism, on the default screen device.

GLCanvas

public GLCanvas(GLCapabilities capabilities)

Creates a new GLCanvas component with the requested set of OpenGL capabilities, using the default OpenGL capabilities selection mechanism, on the default screen device.

GLCanvas

public GLCanvas(GLCapabilities capabilities,
                GLCapabilitiesChooser chooser,
                GLContext shareWith,
                GraphicsDevice device)

Creates a new GLCanvas component. The passed GLCapabilities specifies the OpenGL capabilities for the component; if null, a default set of capabilities is used. The GLCapabilitiesChooser specifies the algorithm for selecting one of the available GLCapabilities for the component; a DefaultGLCapabilitesChooser is used if null is passed for this argument. The passed GLContext specifies an OpenGL context with which to share textures, display lists and other OpenGL state, and may be null if sharing is not desired. See the note in the overview documentation on context sharing. The passed GraphicsDevice indicates the screen on which to create the GLCanvas; the GLDrawableFactory uses the default screen device of the local GraphicsEnvironment if null is passed for this argument.

Method Detail

getGraphicsConfiguration

public GraphicsConfiguration getGraphicsConfiguration()

Overridden to choose a GraphicsConfiguration on a parent container's GraphicsDevice because both devices

createContext

public GLContext createContext(GLContext shareWith)

Description copied from interface: GLDrawable

Creates a new context for drawing to this drawable that will optionally share display lists and other server-side OpenGL objects with the specified GLContext.

The GLContext share need not be associated with this GLDrawable and may be null if sharing of display lists and other objects is not desired. See the note in the overview documentation on context sharing.

Specified by:

createContext in interface GLDrawable

setRealized

public void setRealized(boolean realized)

Description copied from interface: GLDrawable

Indicates to on-screen GLDrawable implementations whether the underlying window has been created and can be drawn into. This method must be called from GLDrawables obtained from the GLDrawableFactory via the GLDrawableFactory.getGLDrawable() method. It must typically be called with an argument of true in the addNotify method of components performing OpenGL rendering and with an argument of false in the removeNotify method. Calling this method has no other effects. For example, if removeNotify is called on a Canvas implementation for which a GLDrawable has been created, it is also necessary to destroy all OpenGL contexts associated with that GLDrawable. This is not done automatically by the implementation. It is not necessary to call setRealized on a GLCanvas, a GLJPanel, or a GLPbuffer, as these perform the appropriate calls on their underlying GLDrawables internally..

Specified by:

setRealized in interface GLDrawable

display

public void display()

Description copied from interface: GLAutoDrawable

Causes OpenGL rendering to be performed for this GLAutoDrawable by calling display for all registered GLEventListeners. Called automatically by the window system toolkit upon receiving a repaint() request. this routine may be called manually for better control over the rendering process. It is legal to call another GLAutoDrawable's display method from within the display callback.

Specified by:

display in interface GLAutoDrawable

paint

public void paint(Graphics g)

Overridden to cause OpenGL rendering to be performed during repaint cycles. Subclasses which override this method must call super.paint() in their paint() method in order to function properly.

Overrides:

paint in class java.awt.Component

addNotify

public void addNotify()

Overridden to track when this component is added to a container. Subclasses which override this method must call super.addNotify() in their addNotify() method in order to function properly.

Overrides:

addNotify in class java.awt.Component

removeNotify

public void removeNotify()

Overridden to track when this component is removed from a container. Subclasses which override this method must call super.removeNotify() in their removeNotify() method in order to function properly.

Overrides:

removeNotify in class java.awt.Component

reshape

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

Overridden to cause GLDrawableHelper.reshape(javax.media.opengl.GLAutoDrawable, int, int, int, int) to be called on all registered GLEventListeners. Subclasses which override this method must call super.reshape() in their reshape() method in order to function properly.

Overrides:

reshape in class java.awt.Component

update

public void update(Graphics g)

Overrides:

update in class java.awt.Component

addGLEventListener

public void addGLEventListener(GLEventListener listener)

Description copied from interface: GLAutoDrawable

Adds a GLEventListener to this drawable. If multiple listeners are added to a given drawable, they are notified of events in an arbitrary order.

Specified by:

addGLEventListener in interface GLAutoDrawable

removeGLEventListener

public void removeGLEventListener(GLEventListener listener)

Description copied from interface: GLAutoDrawable

Removes a GLEventListener from this drawable. Note that if this is done from within a particular drawable's GLEventListener handler (reshape, display, etc.) that it is not guaranteed that all other listeners will be evaluated properly during this update cycle.

Specified by:

removeGLEventListener in interface GLAutoDrawable

getContext

public GLContext getContext()

Description copied from interface: GLAutoDrawable

Returns the context associated with this drawable. The returned context will be synchronized.

Specified by:

getContext in interface GLAutoDrawable

getGL

public GL getGL()

Description copied from interface: GLAutoDrawable

Returns the GL pipeline object this GLAutoDrawable uses. If this method is called outside of the GLEventListener's callback methods (init, display, etc.) it may return null. Users should not rely on the identity of the returned GL object; for example, users should not maintain a hash table with the GL object as the key. Additionally, the GL object should not be cached in client code, but should be re-fetched from the GLAutoDrawable at the beginning of each call to init, display, etc.

Specified by:

getGL in interface GLAutoDrawable

setGL

public void setGL(GL gl)

Description copied from interface: GLAutoDrawable

Sets the GL pipeline object this GLAutoDrawable uses. This should only be called from within the GLEventListener's callback methods, and usually only from within the init() method, in order to install a composable pipeline. See the JOGL demos for examples.

Specified by:

setGL in interface GLAutoDrawable

setAutoSwapBufferMode

public void setAutoSwapBufferMode(boolean onOrOff)

Description copied from interface: GLAutoDrawable

Enables or disables automatic buffer swapping for this drawable. By default this property is set to true; when true, after all GLEventListeners have been called for a display() event, the front and back buffers are swapped, displaying the results of the render. When disabled, the user is responsible for calling GLDrawable.swapBuffers() manually.

Specified by:

setAutoSwapBufferMode in interface GLAutoDrawable

getAutoSwapBufferMode

public boolean getAutoSwapBufferMode()

Description copied from interface: GLAutoDrawable

Indicates whether automatic buffer swapping is enabled for this drawable. See GLAutoDrawable.setAutoSwapBufferMode(boolean).

Specified by:

getAutoSwapBufferMode in interface GLAutoDrawable

swapBuffers

public void swapBuffers()

Description copied from interface: GLDrawable

Swaps the front and back buffers of this drawable. For GLAutoDrawable implementations, when automatic buffer swapping is enabled (as is the default), this method is called automatically and should not be called by the end user.

Specified by:

swapBuffers in interface GLDrawable

getChosenGLCapabilities

public GLCapabilities getChosenGLCapabilities()

Description copied from interface: GLDrawable

Fetches the GLCapabilities corresponding to the chosen OpenGL capabilities (pixel format / visual) for this drawable. Some drawables, in particular on-screen drawables, may be created lazily; null is returned if the drawable is not currently created or if its pixel format has not been set yet. On some platforms, the pixel format is not directly associated with the drawable; a best attempt is made to return a reasonable value in this case.

Specified by:

getChosenGLCapabilities in interface GLDrawable