org.j3d.geom.overlay
Class InteractiveOverlayBase

public abstract class InteractiveOverlayBase
extends org.j3d.geom.overlay.OverlayBase
implements org.j3d.geom.overlay.InteractiveOverlay
An implementation of the interactive overlay.

Version:
$Revision: 1.2 $
Author:
Justin Couch
Field Detail

requester

private org.j3d.geom.overlay.InputRequester requester
Input requester for input events

Constructor Detail

InteractiveOverlayBase

protected InteractiveOverlayBase(javax.media.j3d.Canvas3D canvas,
                                 java.awt.Dimension size)
Creates a new overlay covering the given canvas bounds. It has two buffers. Updates are managed automatically. This Overlay is not usable until you attach it to the view platform transform. If the bounds are null, then resize the overlay to fit the canvas and then track the size of the canvas.
Parameters:
canvas - Canvas being drawn onto
size - The size of the overlay in pixels

InteractiveOverlayBase

protected InteractiveOverlayBase(javax.media.j3d.Canvas3D canvas,
                                 java.awt.Dimension size,
                                 org.j3d.geom.overlay.UpdateManager manager)
Constructs an overlay window with an update manager. It has two buffers. This window will not be visible unless it is added to the scene under the view platform transform. If the bounds are null, then resize the overlay to fit the canvas and then track the size of the canvas.
Parameters:
canvas - The canvas the overlay is drawn on
size - The size of the overlay in pixels
updateManager - Responsible for allowing the Overlay to update between renders. If this is null a default manager is created

InteractiveOverlayBase

protected InteractiveOverlayBase(javax.media.j3d.Canvas3D canvas,
                                 java.awt.Dimension size,
                                 boolean clipAlpha,
                                 boolean blendAlpha)
Constructs an overlay window that can have alpha capabilities. This window will not be visible unless it is added to the scene under the view platform transform. If the bounds are null, then resize the overlay to fit the canvas and then track the size of the canvas.
Parameters:
canvas - The canvas the overlay is drawn on
size - The size of the overlay in pixels
clipAlpha - Should the polygon clip where alpha is zero
blendAlpha - Should we blend to background where alpha is < 1

InteractiveOverlayBase

protected InteractiveOverlayBase(javax.media.j3d.Canvas3D canvas,
                                 java.awt.Dimension size,
                                 boolean clipAlpha,
                                 boolean blendAlpha,
                                 org.j3d.geom.overlay.UpdateManager updateManager)
Constructs an overlay window. This window will not be visible unless it is added to the scene under the view platform transform If the bounds are null, then resize the overlay to fit the canvas and then track the size of the canvas.
Parameters:
canvas - The canvas the overlay is drawn on
size - The size of the overlay in pixels
clipAlpha - Should the polygon clip where alpha is zero
blendAlpha - Should we blend to background where alpha is <
updateManager - Responsible for allowing the Overlay to update between renders. If this is null a default manager is created

InteractiveOverlayBase

protected InteractiveOverlayBase(javax.media.j3d.Canvas3D canvas,
                                 java.awt.Dimension size,
                                 boolean clipAlpha,
                                 boolean blendAlpha,
                                 org.j3d.geom.overlay.UpdateManager updateManager,
                                 int numBuffers)
Constructs an overlay window. This window will not be visible unless it is added to the scene under the view platform transform If the bounds are null, then resize the overlay to fit the canvas and then track the size of the canvas.
Parameters:
canvas - The canvas the overlay is drawn on
size - The size of the overlay in pixels
clipAlpha - Should the polygon clip where alpha is zero
blendAlpha - Should we blend to background where alpha is <
updateManager - Responsible for allowing the Overlay to update between renders. If this is null a default manager is created
numBuffers - The number of buffers to generate, the default is two

Method Detail

setInputRequester

public void setInputRequester(org.j3d.geom.overlay.InputRequester req)
Set the input requestor so that the overlay may manage when it requires input events. If the system is shutting down or the overlay is being removed, the parameter value may be null to clear a previously held instance.
Parameters:
req - The requestor instance to use or null

requestFocus

public void requestFocus()
Request that keyboard focus be sent to this listener object now.
Parameters:
key - The key of the object requesting focus now

addMouseListener

public void addMouseListener(java.awt.event.MouseListener l)
Request that the given listener enable mouse events being sent. If the listener instance is null, this request is ignored.
Parameters:
l - The listener to manage events for
ovl - The overlay to base the mouse bounds handling on

removeMouseListener

public void removeMouseListener(java.awt.event.MouseListener l)
Request that the given listener disable mouse events being sent. If the listener instance is null, this request is ignored.
Parameters:
l - The listener to manage events for
ovl - The overlay to base the mouse bounds handling on

addMouseMotionListener

public void addMouseMotionListener(java.awt.event.MouseMotionListener l)
Request that the given listener enable mouse motion events being sent. If the listener instance is null, this request is ignored.
Parameters:
l - The listener to manage events for
ovl - The overlay to base the mouse bounds handling on

removeMouseMotionListener

public void removeMouseMotionListener(java.awt.event.MouseMotionListener l)
Request that the given listener disable mouse motion events being sent. If the listener instance is null, this request is ignored.
Parameters:
l - The listener to manage events for
ovl - The overlay to base the mouse bounds handling on

addKeyListener

public void addKeyListener(java.awt.event.KeyListener l)
Request that the given listener enable key events being sent. If the listener instance is null, this request is ignored.
Parameters:
l - The listener to manage events for
ovl - The overlay to base the mouse bounds handling on

removeKeyListener

public void removeKeyListener(java.awt.event.KeyListener l)
Request that the given listener disable key events being sent. If the listener instance is null, this request is ignored.
Parameters:
l - The listener to manage events for