PamGraph3D

Class PamPanel3D

java.lang.Object

java.awt.Component

java.awt.Container

javax.swing.JComponent

javax.swing.JPanel

PamView.PamPanel

PamGraph3D.PamPanel3D

All Implemented Interfaces:

java.awt.image.ImageObserver, java.awt.MenuContainer, java.io.Serializable, javax.accessibility.Accessible, ColorManaged

public class PamPanel3D
extends PamPanel

A class to create the basic foundations needed to make a Java3D panel in Pamguard. Without any alterations this will appear as a blank white canvas. Mouse interaction behaviour and 3D shapes can be added easily using various functions.

Author:

Jamie Macaulay

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
class	PamPanel3D.PamCanvas3D

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

javax.swing.JComponent.AccessibleJComponent

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

java.awt.Component.BaselineResizeBehavior

Field Summary

Fields

Modifier and Type	Field and Description
AxisVisualisation	axisVis
javax.media.j3d.BoundingSphere	bounds
javax.media.j3d.BranchGroup	graphGroup
javax.media.j3d.BranchGroup	graphicsGroup
javax.media.j3d.BranchGroup	rootGroup
javax.media.j3d.TransformGroup	rotateGroup

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
PamPanel3D(java.awt.Frame frame) Create a spectrogram
PamPanel3D(java.awt.Frame frame, boolean pickable)

Method Summary

Methods

Modifier and Type	Method and Description
void	addAxisVisulaisation(java.lang.String axisX, java.lang.String axisY, java.lang.String axisZ) Add a small icon to show the oreintation of the graph
void	addChildtoGraphicsGroup(javax.media.j3d.BranchGroup bg)
void	addChildtoGraphicsGroup(javax.media.j3d.TransformGroup tg)
void	addChildtoRotateGroup(javax.media.j3d.BranchGroup branchGroup) Add a branchgroup to the rotateGroup
void	addChildtoRotateGroup(javax.media.j3d.TransformGroup tg) Add a transform group to the rotateGroup
void	addLight(javax.media.j3d.DirectionalLight light1) Add lighting to the root group.
void	addMouseGetVirtualLocation(MouseGetVirtualLocation mouseGetVirtualLocation)
void	addMouseRightClickMenu(com.sun.j3d.utils.behaviors.mouse.MouseBehavior mouserightClick)
void	addMouseRotate() Add mouse rotate functionality.
void	addMouseTranslate() Add mouse translate functionality.
void	addMouseZoom() Add mouse zoom functionality.
void	clearGraphicsGroup()
void	clearRotateGroup()
static javax.media.j3d.Node	createPickableObject(javax.media.j3d.Node node) Makes a Java3D object suitable for pick reporting
javax.media.j3d.BranchGroup	createSpectroSceneGraph() Create the 3D components and 3D interaction components
java.awt.image.BufferedImage	getBufferedImage()
javax.media.j3d.Canvas3D	getCanvas3D()
javax.media.j3d.BranchGroup	getGraphicsGroup() Create the 3D graph axis.
MouseProportionalZoom	getMouseProportionalZoom()
com.sun.j3d.utils.picking.PickCanvas	getPickCanvas()
javax.media.j3d.BranchGroup	getRootGroup() Get the rootGroup.
javax.media.j3d.TransformGroup	getRotateGroup() Get the rotate group containing graphics and mouse interaction behaviours.
javax.media.j3d.View	getView()
void	init() Initialise the 3D Graph.
boolean	isOffscreen()
void	removeAxisVisulaisation()
void	removeLight() Remove lighting from root group.
void	removeMouseRotate() Remove the rotate functionality.
void	removeMouseTranslate() Remove the translate functionality.
void	removeMouseZoom() Remove the mouse zoom functionality.
void	resetPlot(double Z) Resets rotateGroup with Z axis translation of Z preserving the aspect ratio.
void	resetPlotRotation() Resets plot to default rotation, maintaining aspect ratio and translation components.
javax.media.j3d.Transform3D	rotate(double rotateAngle, javax.media.j3d.Transform3D trs2D)
void	rotatePlot(double angle) Rotate the plot by specified angle;
void	setAspectRatio() Set the aspect ratio of the graph to match the containing window aspect ratio.
void	setAspectRatioEnabled(boolean aspectRatio) Enable ore disable 3D scaling with window aspect ratio
void	setAxisVisTransform()
void	setBackground(java.awt.Color arg0)
void	setMouseTranslateFactor(double factor)
void	setMouseZoomFactor(double factor)
void	setOffscreen(boolean offscreen) Set an offscreen canvas.
void	transformAspectRatio(javax.vecmath.Vector3d v) Change the aspect ratio of the rotateGroup, preserving translation etc.
void	translateGraphics(javax.vecmath.Vector3d v) Move the graphics group by vector3d v;
void	translateRotGroup(javax.vecmath.Vector3d v) Move the rotateGroup by vector3d v, maintaining rotation components.;

Methods inherited from class PamView.PamPanel

addComponent, getColorId, getDefaultColor, getFrame, getPreferredBorderColours, layoutGrid, setDefaultColor, setPreferredBorderColour

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, 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, 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, hide, 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, toString, transferFocus, transferFocusBackward, transferFocusUpCycle

Methods inherited from class java.lang.Object

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

Field Detail

rootGroup

public javax.media.j3d.BranchGroup rootGroup

rotateGroup

public javax.media.j3d.TransformGroup rotateGroup

graphicsGroup

public javax.media.j3d.BranchGroup graphicsGroup

graphGroup

public javax.media.j3d.BranchGroup graphGroup

axisVis

public AxisVisualisation axisVis

bounds

public javax.media.j3d.BoundingSphere bounds

Constructor Detail

PamPanel3D

public PamPanel3D(java.awt.Frame frame)

Create a spectrogram

PamPanel3D

public PamPanel3D(java.awt.Frame frame,
          boolean pickable)

Method Detail

setBackground

public void setBackground(java.awt.Color arg0)

Overrides:

setBackground in class PamPanel

createSpectroSceneGraph

public javax.media.j3d.BranchGroup createSpectroSceneGraph()

Create the 3D components and 3D interaction components

Returns:

Java3D BranchGroup.

addAxisVisulaisation

public void addAxisVisulaisation(java.lang.String axisX,
                        java.lang.String axisY,
                        java.lang.String axisZ)

Add a small icon to show the oreintation of the graph

removeAxisVisulaisation

public void removeAxisVisulaisation()

setAxisVisTransform

public void setAxisVisTransform()

setAspectRatio

public void setAspectRatio()

Set the aspect ratio of the graph to match the containing window aspect ratio. Note that this only sets once. To follow window resizing use 'setAspectRatioEnable'

setAspectRatioEnabled

public void setAspectRatioEnabled(boolean aspectRatio)

Enable ore disable 3D scaling with window aspect ratio

Parameters:

aspectRatio -

removeLight

public void removeLight()

Remove lighting from root group.

addLight

public void addLight(javax.media.j3d.DirectionalLight light1)

Add lighting to the root group.

Parameters:

light1 -

getRootGroup

public javax.media.j3d.BranchGroup getRootGroup()

Get the rootGroup. This contains all other groups. Note this is no part of rottaeGroup and therefore any objects added directly will no have mouse functionality.

Returns:

getRotateGroup

public javax.media.j3d.TransformGroup getRotateGroup()

Get the rotate group containing graphics and mouse interaction behaviours.

addChildtoRotateGroup

public void addChildtoRotateGroup(javax.media.j3d.BranchGroup branchGroup)

Add a branchgroup to the rotateGroup

Parameters:

branchGroup -

addChildtoRotateGroup

public void addChildtoRotateGroup(javax.media.j3d.TransformGroup tg)

Add a transform group to the rotateGroup

Parameters:

tg -

addChildtoGraphicsGroup

public void addChildtoGraphicsGroup(javax.media.j3d.BranchGroup bg)

addChildtoGraphicsGroup

public void addChildtoGraphicsGroup(javax.media.j3d.TransformGroup tg)

clearGraphicsGroup

public void clearGraphicsGroup()

clearRotateGroup

public void clearRotateGroup()

addMouseRightClickMenu

public void addMouseRightClickMenu(com.sun.j3d.utils.behaviors.mouse.MouseBehavior mouserightClick)

addMouseGetVirtualLocation

public void addMouseGetVirtualLocation(MouseGetVirtualLocation mouseGetVirtualLocation)

addMouseRotate

public void addMouseRotate()

Add mouse rotate functionality.

addMouseTranslate

public void addMouseTranslate()

Add mouse translate functionality.

addMouseZoom

public void addMouseZoom()

Add mouse zoom functionality.

removeMouseRotate

public void removeMouseRotate()

Remove the rotate functionality.

removeMouseTranslate

public void removeMouseTranslate()

Remove the translate functionality.

removeMouseZoom

public void removeMouseZoom()

Remove the mouse zoom functionality.

setMouseZoomFactor

public void setMouseZoomFactor(double factor)

setMouseTranslateFactor

public void setMouseTranslateFactor(double factor)

transformAspectRatio

public void transformAspectRatio(javax.vecmath.Vector3d v)

Change the aspect ratio of the rotateGroup, preserving translation etc.

translateRotGroup

public void translateRotGroup(javax.vecmath.Vector3d v)

Move the rotateGroup by vector3d v, maintaining rotation components.;

translateGraphics

public void translateGraphics(javax.vecmath.Vector3d v)

Move the graphics group by vector3d v;

resetPlot

public void resetPlot(double Z)

Resets rotateGroup with Z axis translation of Z preserving the aspect ratio.

Parameters:

Z -

resetPlotRotation

public void resetPlotRotation()

Resets plot to default rotation, maintaining aspect ratio and translation components.

rotatePlot

public void rotatePlot(double angle)

Rotate the plot by specified angle;

Parameters:

angle - - radians

rotate

public javax.media.j3d.Transform3D rotate(double rotateAngle,
                                 javax.media.j3d.Transform3D trs2D)

getGraphicsGroup

public javax.media.j3d.BranchGroup getGraphicsGroup()

Create the 3D graph axis.

Returns:

createPickableObject

public static javax.media.j3d.Node createPickableObject(javax.media.j3d.Node node)

Makes a Java3D object suitable for pick reporting

Parameters:

node -

getCanvas3D

public javax.media.j3d.Canvas3D getCanvas3D()

getPickCanvas

public com.sun.j3d.utils.picking.PickCanvas getPickCanvas()

isOffscreen

public boolean isOffscreen()

setOffscreen

public void setOffscreen(boolean offscreen)

Set an offscreen canvas. This allows the 3D panel to be copied to a buferred image- usually for clipboards. Note: There appears to be a memory leak with the offScreenCanvas3D class which is why this is not enabled by default.

Parameters:

offscreen -

init

public void init()

Initialise the 3D Graph.

getView

public javax.media.j3d.View getView()

getMouseProportionalZoom

public MouseProportionalZoom getMouseProportionalZoom()

getBufferedImage

public java.awt.image.BufferedImage getBufferedImage()