|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object java.awt.Component java.awt.Container javax.swing.JComponent javax.swing.JPanel javax.media.opengl.awt.GLJPanel
public class GLJPanel
A lightweight Swing component which provides OpenGL rendering support. Provided for compatibility with Swing user interfaces when adding a heavyweight doesn't work either because of Z-ordering or LayoutManager problems.
The GLJPanel can be made transparent by creating it with a
GLCapabilities object with alpha bits specified and calling setOpaque(boolean)
(false). Pixels with resulting OpenGL alpha values less
than 1.0 will be overlaid on any underlying Swing rendering.
Notes specific to the Reference Implementation: This component
attempts to use hardware-accelerated rendering via pbuffers and
falls back on to software rendering if problems occur.
Note that because this component attempts to use pbuffers for
rendering, and because pbuffers can not be resized, somewhat
surprising behavior may occur during resize operations; the GLEventListener.init(javax.media.opengl.GLAutoDrawable)
method may be called multiple times as the
pbuffer is resized to be able to cover the size of the GLJPanel.
This behavior is correct, as the textures and display lists for
the GLJPanel will have been lost during the resize operation. The
application should attempt to make its GLEventListener.init()
methods as side-effect-free as possible.
Nested Class Summary |
---|
Nested classes/interfaces inherited from class javax.swing.JPanel |
---|
JPanel.AccessibleJPanel |
Nested classes/interfaces inherited from class javax.swing.JComponent |
---|
JComponent.AccessibleJComponent |
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 |
---|
Fields inherited from class javax.swing.JComponent |
---|
accessibleContext, 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 |
---|
BOTTOM_ALIGNMENT, CENTER_ALIGNMENT, LEFT_ALIGNMENT, RIGHT_ALIGNMENT, TOP_ALIGNMENT |
Fields inherited from interface javax.media.opengl.GLAutoDrawable |
---|
SCREEN_CHANGE_ACTION_ENABLED |
Fields inherited from interface java.awt.image.ImageObserver |
---|
ABORT, ALLBITS, ERROR, FRAMEBITS, HEIGHT, PROPERTIES, SOMEBITS, WIDTH |
Constructor Summary | |
---|---|
GLJPanel()
Creates a new GLJPanel component with a default set of OpenGL capabilities and using the default OpenGL capabilities selection mechanism. |
|
GLJPanel(GLCapabilities capabilities)
Creates a new GLJPanel component with the requested set of OpenGL capabilities, using the default OpenGL capabilities selection mechanism. |
|
GLJPanel(GLCapabilities capabilities,
GLCapabilitiesChooser chooser,
GLContext shareWith)
Creates a new GLJPanel 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 |
destroy()
Just an alias for removeNotify |
void |
display()
Causes OpenGL rendering to be performed for this GLAutoDrawable by calling display(..) for all
registered GLEventListener s. |
protected void |
dispose(boolean regenerate)
|
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 / GLProfile) for this drawable.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. |
GLContext |
getContext()
Returns the context associated with this drawable. |
GLDrawableFactory |
getFactory()
|
GL |
getGL()
Returns the GL pipeline object this GLAutoDrawable uses. |
GLProfile |
getGLProfile()
Fetches the GLProfile for this drawable. |
NativeWindow |
getNativeWindow()
|
protected void |
paintComponent(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 GLEventListener s. |
void |
setAutoSwapBufferMode(boolean onOrOff)
Enables or disables automatic buffer swapping for this drawable. |
void |
setContext(GLContext ctx)
Associate a new context to this drawable. |
GL |
setGL(GL gl)
Sets the GL pipeline object this GLAutoDrawable uses. |
void |
setOpaque(boolean opaque)
|
void |
setRealized(boolean realized)
Indicates to on-screen GLDrawable implementations whether the underlying window has been created and can be drawn into. |
boolean |
shouldPreserveColorBufferIfTranslucent()
For a translucent GLJPanel (one for which setOpaque (false) has been called), indicates whether the
application should preserve the OpenGL color buffer
(GL_COLOR_BUFFER_BIT) for correct rendering of the GLJPanel and
underlying widgets which may show through portions of the
GLJPanel with alpha values less than 1. |
void |
swapBuffers()
Swaps the front and back buffers of this drawable. |
String |
toString()
|
Methods inherited from class javax.swing.JPanel |
---|
getAccessibleContext, getUI, getUIClassID, paramString, setUI, updateUI |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait |
Methods inherited from interface javax.media.opengl.awt.AWTGLAutoDrawable |
---|
repaint, setSize |
Methods inherited from interface javax.media.opengl.GLDrawable |
---|
getHeight, getWidth |
Constructor Detail |
---|
public GLJPanel()
public GLJPanel(GLCapabilities capabilities)
public GLJPanel(GLCapabilities capabilities, GLCapabilitiesChooser chooser, GLContext shareWith)
Note: Sharing cannot be enabled using J2D OpenGL FBO sharing, since J2D GL Context must be shared and we can only share one context.
Method Detail |
---|
public void display()
GLAutoDrawable
display(..)
for all
registered GLEventListener
s. 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.
In case of a new generated OpenGL context,
the implementation shall call init(..)
for all
registered GLEventListener
s before making the
actual display(..)
calls,
in case this has not been done yet.
display
in interface GLAutoDrawable
protected void dispose(boolean regenerate)
public void destroy()
destroy
in interface GLAutoDrawable
protected void paintComponent(Graphics g)
Overrides:
paintComponent
in class javax.swing.JComponent
paintComponent
in class JComponent
public void addNotify()
Overrides:
addNotify
in class java.awt.Component
addNotify
in class JComponent
public void removeNotify()
Overrides:
removeNotify
in class java.awt.Component
removeNotify
in class JComponent
public void reshape(int x, int y, int width, int height)
GLDrawableHelper.reshape(javax.media.opengl.GLAutoDrawable, int, int, int, int)
to be
called on all registered GLEventListener
s. 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
reshape
in class JComponent
public void setOpaque(boolean opaque)
setOpaque
in class JComponent
public void addGLEventListener(GLEventListener listener)
GLAutoDrawable
GLEventListener
to this drawable. If multiple
listeners are added to a given drawable, they are notified of
events in an arbitrary order.
addGLEventListener
in interface GLAutoDrawable
public void removeGLEventListener(GLEventListener listener)
GLAutoDrawable
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.
removeGLEventListener
in interface GLAutoDrawable
public GLContext createContext(GLContext shareWith)
GLDrawable
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.
createContext
in interface GLDrawable
public void setRealized(boolean realized)
GLDrawable
setRealized
on a GLCanvas, a GLJPanel, or a
GLPbuffer, as these perform the appropriate calls on their
underlying GLDrawables internally.
Developers implementing new OpenGL components for various window
toolkits need to call this method against GLDrawables obtained
from the GLDrawableFactory via the GLDrawableFactory.getGLDrawable()
method. It must typically be
called with an argument of true
when the component
associated with the GLDrawable is realized and with an argument
of false
just before the component is unrealized.
For the AWT, this means calling setRealized(true)
in
the addNotify
method and with an argument of
false
in the removeNotify
method.
GLDrawable
implementations should handle multiple
cycles of setRealized(true)
/
setRealized(false)
calls. Most, if not all, Java
window toolkits have a persistent object associated with a given
component, regardless of whether that component is currently
realized. The GLDrawable
object associated with a
particular component is intended to be similarly persistent. A
GLDrawable
is intended to be created for a given
component when it is constructed and live as long as that
component. setRealized
allows the
GLDrawable
to re-initialize and destroy any
associated resources as the component becomes realized and
unrealized, respectively.
With an argument of true
,
the minimum implementation shall call
NativeWindow's lockSurface()
and if successfull:
GLCapabilities
, which are associated with
the attached NativeWindow
's AbstractGraphicsConfiguration
.NativeWindow's unlockSurface()
.NativeWindow's lockSurface()
ensures resolving the window/surface handles, and the drawable's GLCapabilities
might have changed.
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.
setRealized
in interface GLDrawable
public void setContext(GLContext ctx)
GLAutoDrawable
setContext
in interface GLAutoDrawable
public GLContext getContext()
GLAutoDrawable
getContext
in interface GLAutoDrawable
public GL getGL()
GLAutoDrawable
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.
getGL
in interface GLAutoDrawable
public GL setGL(GL gl)
GLAutoDrawable
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.
setGL
in interface GLAutoDrawable
public void setAutoSwapBufferMode(boolean onOrOff)
GLAutoDrawable
GLDrawable.swapBuffers(..)
manually.
setAutoSwapBufferMode
in interface GLAutoDrawable
public boolean getAutoSwapBufferMode()
GLAutoDrawable
GLAutoDrawable.setAutoSwapBufferMode(boolean)
.
getAutoSwapBufferMode
in interface GLAutoDrawable
public void swapBuffers()
GLDrawable
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.
swapBuffers
in interface GLDrawable
public boolean shouldPreserveColorBufferIfTranslucent()
setOpaque
(false) has been called), indicates whether the
application should preserve the OpenGL color buffer
(GL_COLOR_BUFFER_BIT) for correct rendering of the GLJPanel and
underlying widgets which may show through portions of the
GLJPanel with alpha values less than 1. Most Swing
implementations currently expect the GLJPanel to be completely
cleared (e.g., by glClear(GL_COLOR_BUFFER_BIT |
GL_DEPTH_BUFFER_BIT)
), but for certain optimized Swing
implementations which use OpenGL internally, it may be possible
to perform OpenGL rendering using the GLJPanel into the same
OpenGL drawable as the Swing implementation uses.
public GLCapabilities getChosenGLCapabilities()
GLDrawable
GLCapabilities
corresponding to the chosen
OpenGL capabilities (pixel format / visual / GLProfile) for this drawable.NativeWindow
's
AbstractGraphicsConfiguration
, and if changes are necessary,
they should reflect those as well.
getChosenGLCapabilities
in interface GLDrawable
public final GLProfile getGLProfile()
GLDrawable
GLProfile
for this drawable.
Returns the GLProfile object, no copy.
getGLProfile
in interface GLDrawable
public NativeWindow getNativeWindow()
getNativeWindow
in interface GLDrawable
public final GLDrawableFactory getFactory()
getFactory
in interface GLDrawable
public String toString()
toString
in interface GLDrawable
toString
in class Component
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |