GLDrawableComponent (Artisynth API documentation)

java.lang.Object
- maspack.render.GL.GLDrawableComponent

Direct Known Subclasses:

GLDrawableComponent.GLDrawableCanvas, GLDrawableComponent.GLDrawableJPanel
```
public abstract class GLDrawableComponent
extends java.lang.Object
```
Wrapper for either GLCanvas or GLJPanel, since the two do not have a sufficient common interface to act as both an AWT Component and a GLAutoDrawable interface

Author:

Antonio

Nested Class Summary

Nested Classes
Modifier and Type	Class and Description
`static class`	`GLDrawableComponent.GLDrawableCanvas` Wrapper for a GLCanvas
`static class`	`GLDrawableComponent.GLDrawableJPanel` Wrapper for a GLJPanel

Method Summary

All Methods Static Methods Instance Methods Abstract Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`addGLEventListener(com.jogamp.opengl.GLEventListener listener)` Adds a listener to the end of the underlying drawable's queue
`void`	`addKeyListener(java.awt.event.KeyListener l)` Adds a key listener to the underlying component
`void`	`addMouseListener(java.awt.event.MouseListener l)` Adds a mouse listener to the end of the underlying component's queue
`void`	`addMouseMotionListener(java.awt.event.MouseMotionListener l)` Adds a mouse motion listener to the underlying component
`void`	`addMouseWheelListener(java.awt.event.MouseWheelListener l)` Adds a mouse wheel listener to the underlying component
`static GLDrawableComponent`	`create(com.jogamp.opengl.awt.GLCanvas canvas)` Creates a GLAutoDrawable and Component wrapper for a GLCanvas
`static GLDrawableComponent`	`create(GLJPanel panel)` Creates a GLAutoDrawable and Component wrapper for a GLJPanel
`void`	`destroy()` Destroys all resources associated with the underlying drawable
`void`	`display()` Causes OpenGL rendering to be performed
`boolean`	`getAutoSwapBufferMode()` Indicates whether automatic buffer swapping is enabled
`java.awt.Component`	`getComponent()` Returns the AWT Component
`java.awt.Cursor`	`getCursor()` Get the cursor image for the underlying AWT component
`com.jogamp.opengl.GLAutoDrawable`	`getDrawable()` Returns the auto-drawable component
`java.awt.Graphics`	`getGraphics()` Creates a graphics context for the underlying component
`int`	`getHeight()` Gets the pixel height of the underlying AWT component
`java.awt.event.KeyListener[]`	`getKeyListeners()` Returns an array of all key listeners registered with the underlying component
`java.awt.Point`	`getLocationOnScreen()` Gets the top-left corner location of the component
`java.awt.Dimension`	`getMaximumSize()` Gets the maximum size for the underlying AWT component
`java.awt.Dimension`	`getMinimumSize()` Gets the minimum size for the underlying AWT component
`java.awt.Dimension`	`getPreferredSize()` Gets the preferred size for the underlying AWT component
`java.awt.Dimension`	`getSize()` Gets the size of the underlying AWT component
`int`	`getSurfaceHeight()` Gets the real pixel height of the underlying GLAutoDrawable.
`int`	`getSurfaceWidth()` Gets the real pixel width of the underlying GLAutoDrawable.
`int`	`getWidth()` Gets the pixel width of the underlying AWT component
`int`	`getX()` Gets the x component of the origin of the underlying AWT component
`int`	`getY()` Gets the y component of the origin of the underlying AWT component
`boolean`	`isVisible()` Visibility of underlying Java AWT component
`void`	`paint(java.awt.Graphics graphics)` Paints the underlying AWT component
`com.jogamp.opengl.GLEventListener`	`removeGLEventListener(com.jogamp.opengl.GLEventListener listener)` Removes a listener from the underlying drawable's queue
`void`	`removeKeyListener(java.awt.event.KeyListener l)` Removes a key listener from the underlying component
`void`	`removeMouseListener(java.awt.event.MouseListener l)` Removes a mouse listener from the underlying component
`void`	`removeMouseMotionListener(java.awt.event.MouseMotionListener l)` Removes a mouse motion listener from the underlying component
`void`	`removeMouseWheelListener(java.awt.event.MouseWheelListener l)` Removes a mouse wheel listener from the underlying component
`void`	`repaint()` Repaints the AWT component
`void`	`setAutoSwapBufferMode(boolean enable)` Enables or disables automatic buffer swapping
`void`	`setCursor(java.awt.Cursor cursor)` Sets the cursor image for the underlying AWT component
`void`	`setMaximumSize(java.awt.Dimension maximumSize)` Sets the maximum size for the underlying AWT component
`void`	`setMinimumSize(java.awt.Dimension minimumSize)` Sets the minimum size for the underlying AWT component
`void`	`setPreferredSize(java.awt.Dimension preferredSize)` Sets the preferred size for the underlying AWT component
`void`	`setSize(java.awt.Dimension size)` Resizes the underlying AWT component
`void`	`setSize(int width, int height)` Resizes the underlying AWT component
`abstract void`	`setSurfaceScale(float[] scale)`

Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Method Detail
  - isVisible
```
public boolean isVisible()
```
    Visibility of underlying Java AWT component
    
    Returns:
    
    true if display component is visible
    
    See Also:
    
    Component.isVisible()
  - getDrawable
```
public com.jogamp.opengl.GLAutoDrawable getDrawable()
```
    Returns the auto-drawable component
    
    Returns:
    
    the underlying GLAutoDrawable
  - getComponent
```
public java.awt.Component getComponent()
```
    Returns the AWT Component
    
    Returns:
    
    the AWT component
  - repaint
```
public void repaint()
```
    Repaints the AWT component
    
    See Also:
    
    Component.repaint()
  - display
```
public void display()
```
    Causes OpenGL rendering to be performed
    
    See Also:
    
    GLAutoDrawable.display()
  - paint
```
public void paint(java.awt.Graphics graphics)
```
    Paints the underlying AWT component
    
    See Also:
    
    Component.paint(Graphics)
  - getGraphics
```
public java.awt.Graphics getGraphics()
```
    Creates a graphics context for the underlying component
    
    Returns:
    
    a graphics context, or null if none exists
    
    See Also:
    
    Component.getGraphics()
  - setPreferredSize
```
public void setPreferredSize(java.awt.Dimension preferredSize)
```
    Sets the preferred size for the underlying AWT component
    
    Parameters:
    
    preferredSize - width/height dimension
    
    See Also:
    
    Component.setPreferredSize(Dimension)
  - getPreferredSize
```
public java.awt.Dimension getPreferredSize()
```
    Gets the preferred size for the underlying AWT component
    
    Returns:
    
    preferred size (width/height)
    
    See Also:
    
    Component.getPreferredSize()
  - setMinimumSize
```
public void setMinimumSize(java.awt.Dimension minimumSize)
```
    Sets the minimum size for the underlying AWT component
    
    Parameters:
    
    minimumSize - width/height dimension
    
    See Also:
    
    Component.setMinimumSize(Dimension)
  - getMinimumSize
```
public java.awt.Dimension getMinimumSize()
```
    Gets the minimum size for the underlying AWT component
    
    Returns:
    
    minimum size (width/height)
    
    See Also:
    
    Component.getMinimumSize()
  - setMaximumSize
```
public void setMaximumSize(java.awt.Dimension maximumSize)
```
    Sets the maximum size for the underlying AWT component
    
    Parameters:
    
    maximumSize - width/height dimension
    
    See Also:
    
    Component.setMaximumSize(Dimension)
  - getMaximumSize
```
public java.awt.Dimension getMaximumSize()
```
    Gets the maximum size for the underlying AWT component
    
    Returns:
    
    maximum size (width/height)
    
    See Also:
    
    Component.getMaximumSize()
  - setSize
```
public void setSize(int width,
                    int height)
```
    Resizes the underlying AWT component
    
    Parameters:
    
    width - pixel width
    
    height - pixel height
    
    See Also:
    
    Component.setSize(int, int)
  - setSize
```
public void setSize(java.awt.Dimension size)
```
    Resizes the underlying AWT component
    
    Parameters:
    
    size - width/height dimension
    
    See Also:
    
    Component.setSize(Dimension)
  - getWidth
```
public int getWidth()
```
    Gets the pixel width of the underlying AWT component
    
    Returns:
    
    pixel width
    
    See Also:
    
    Component.getWidth()
  - getHeight
```
public int getHeight()
```
    Gets the pixel height of the underlying AWT component
    
    Returns:
    
    pixel height
    
    See Also:
    
    Component.getHeight()
  - getSize
```
public java.awt.Dimension getSize()
```
    Gets the size of the underlying AWT component
    
    Returns:
    
    underlying component size
  - getSurfaceWidth
```
public int getSurfaceWidth()
```
    Gets the real pixel width of the underlying GLAutoDrawable.
    
    Returns:
    
    pixel width
    
    See Also:
    
    GLDrawable.getSurfaceWidth()
  - getSurfaceHeight
```
public int getSurfaceHeight()
```
    Gets the real pixel height of the underlying GLAutoDrawable.
    
    Returns:
    
    pixel height
    
    See Also:
    
    GLDrawable.getSurfaceHeight()
  - getX
```
public int getX()
```
    Gets the x component of the origin of the underlying AWT component
    
    Returns:
    
    origin x component
    
    See Also:
    
    Component.getY()
  - getY
```
public int getY()
```
    Gets the y component of the origin of the underlying AWT component
    
    Returns:
    
    origin y component
    
    See Also:
    
    Component.getX()
  - getLocationOnScreen
```
public java.awt.Point getLocationOnScreen()
```
    Gets the top-left corner location of the component
    
    Returns:
    
    Point object representing top-left corner
    
    See Also:
    
    Component.getLocationOnScreen()
  - setCursor
```
public void setCursor(java.awt.Cursor cursor)
```
    Sets the cursor image for the underlying AWT component
    
    Parameters:
    
    cursor - cursor constant
    
    See Also:
    
    Component.setCursor(Cursor)
  - getCursor
```
public java.awt.Cursor getCursor()
```
    Get the cursor image for the underlying AWT component
    
    Returns:
    
    cursor image
    
    See Also:
    
    Component.getCursor()
  - addGLEventListener
```
public void addGLEventListener(com.jogamp.opengl.GLEventListener listener)
```
    Adds a listener to the end of the underlying drawable's queue
    
    Parameters:
    
    listener - event listener to add
    
    See Also:
    
    GLAutoDrawable.addGLEventListener(GLEventListener)
  - removeGLEventListener
```
public com.jogamp.opengl.GLEventListener removeGLEventListener(com.jogamp.opengl.GLEventListener listener)
```
    Removes a listener from the underlying drawable's queue
    
    Parameters:
    
    listener - event listener to remove
    
    Returns:
    
    the removed listener, or null if not present in queue
    
    See Also:
    
    GLAutoDrawable.removeGLEventListener(GLEventListener)
  - addMouseListener
```
public void addMouseListener(java.awt.event.MouseListener l)
```
    Adds a mouse listener to the end of the underlying component's queue
    
    Parameters:
    
    l - mouse listener to add
    
    See Also:
    
    Component.addMouseListener(MouseListener)
  - removeMouseListener
```
public void removeMouseListener(java.awt.event.MouseListener l)
```
    Removes a mouse listener from the underlying component
    
    Parameters:
    
    l - mouse listener to remove
    
    See Also:
    
    Component.removeMouseListener(MouseListener)
  - addMouseMotionListener
```
public void addMouseMotionListener(java.awt.event.MouseMotionListener l)
```
    Adds a mouse motion listener to the underlying component
    
    Parameters:
    
    l - mouse motion listener
    
    See Also:
    
    Component.addMouseMotionListener(MouseMotionListener)
  - removeMouseMotionListener
```
public void removeMouseMotionListener(java.awt.event.MouseMotionListener l)
```
    Removes a mouse motion listener from the underlying component
    
    Parameters:
    
    l - mouse motion listener to remove
    
    See Also:
    
    Component.removeMouseMotionListener(MouseMotionListener)
  - addMouseWheelListener
```
public void addMouseWheelListener(java.awt.event.MouseWheelListener l)
```
    Adds a mouse wheel listener to the underlying component
    
    Parameters:
    
    l - mouse wheel listener to add
    
    See Also:
    
    Component.addMouseWheelListener(MouseWheelListener)
  - removeMouseWheelListener
```
public void removeMouseWheelListener(java.awt.event.MouseWheelListener l)
```
    Removes a mouse wheel listener from the underlying component
    
    Parameters:
    
    l - mouse wheel listener to remove
    
    See Also:
    
    Component.removeMouseWheelListener(MouseWheelListener)
  - addKeyListener
```
public void addKeyListener(java.awt.event.KeyListener l)
```
    Adds a key listener to the underlying component
    
    Parameters:
    
    l - key listener to add
    
    See Also:
    
    Component.addKeyListener(KeyListener)
  - removeKeyListener
```
public void removeKeyListener(java.awt.event.KeyListener l)
```
    Removes a key listener from the underlying component
    
    Parameters:
    
    l - key listener to remove
    
    See Also:
    
    Component.removeKeyListener(KeyListener)
  - getKeyListeners
```
public java.awt.event.KeyListener[] getKeyListeners()
```
    Returns an array of all key listeners registered with the underlying component
    
    Returns:
    
    array of key listeners
    
    See Also:
    
    Component.getKeyListeners()
  - setAutoSwapBufferMode
```
public void setAutoSwapBufferMode(boolean enable)
```
    Enables or disables automatic buffer swapping
    
    See Also:
    
    GLAutoDrawable.setAutoSwapBufferMode(boolean)
  - getAutoSwapBufferMode
```
public boolean getAutoSwapBufferMode()
```
    Indicates whether automatic buffer swapping is enabled
    
    Returns:
    
    true if enabled
    
    See Also:
    
    GLAutoDrawable.getAutoSwapBufferMode()
  - destroy
```
public void destroy()
```
    Destroys all resources associated with the underlying drawable
    
    See Also:
    
    GLAutoDrawable.destroy()
  - create
```
public static GLDrawableComponent create(GLJPanel panel)
```
    Creates a GLAutoDrawable and Component wrapper for a GLJPanel
    
    Parameters:
    
    panel - panel to wrap
    
    Returns:
    
    wrapped component
  - create
```
public static GLDrawableComponent create(com.jogamp.opengl.awt.GLCanvas canvas)
```
    Creates a GLAutoDrawable and Component wrapper for a GLCanvas
    
    Parameters:
    
    canvas - canvas to wrap
    
    Returns:
    
    wrapped component
  - setSurfaceScale
```
public abstract void setSurfaceScale(float[] scale)
```

Class GLDrawableComponent

Nested Class Summary

Method Summary

Methods inherited from class java.lang.Object

Method Detail

isVisible

getDrawable

getComponent

repaint

display

paint

getGraphics

setPreferredSize

getPreferredSize

setMinimumSize

getMinimumSize

setMaximumSize

getMaximumSize

setSize

setSize

getWidth

getHeight

getSize

getSurfaceWidth

getSurfaceHeight

getX

getY

getLocationOnScreen

setCursor

getCursor

addGLEventListener

removeGLEventListener

addMouseListener

removeMouseListener

addMouseMotionListener

removeMouseMotionListener

addMouseWheelListener

removeMouseWheelListener

addKeyListener

removeKeyListener

getKeyListeners

setAutoSwapBufferMode

getAutoSwapBufferMode

destroy

create

create

setSurfaceScale