edu.mines.jtk.sgl

Class SimpleFrame

java.lang.Object

java.awt.Component

java.awt.Container

java.awt.Window

java.awt.Frame

javax.swing.JFrame

edu.mines.jtk.sgl.SimpleFrame

All Implemented Interfaces:

java.awt.image.ImageObserver, java.awt.MenuContainer, java.io.Serializable, javax.accessibility.Accessible, javax.swing.RootPaneContainer, javax.swing.WindowConstants

public class SimpleFrame
extends javax.swing.JFrame

A simple frame for 3D graphics.

See Also:

Serialized Form

Nested Class Summary

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

javax.swing.JFrame.AccessibleJFrame

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

java.awt.Frame.AccessibleAWTFrame

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

java.awt.Window.AccessibleAWTWindow, java.awt.Window.Type

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

java.awt.Container.AccessibleAWTContainer

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

java.awt.Component.AccessibleAWTComponent, java.awt.Component.BaselineResizeBehavior, java.awt.Component.BltBufferStrategy, java.awt.Component.FlipBufferStrategy

Field Summary

Fields inherited from class javax.swing.JFrame

accessibleContext, EXIT_ON_CLOSE, rootPane, rootPaneCheckingEnabled

Fields inherited from class java.awt.Frame

CROSSHAIR_CURSOR, DEFAULT_CURSOR, E_RESIZE_CURSOR, HAND_CURSOR, ICONIFIED, MAXIMIZED_BOTH, MAXIMIZED_HORIZ, MAXIMIZED_VERT, MOVE_CURSOR, N_RESIZE_CURSOR, NE_RESIZE_CURSOR, NORMAL, NW_RESIZE_CURSOR, S_RESIZE_CURSOR, SE_RESIZE_CURSOR, SW_RESIZE_CURSOR, TEXT_CURSOR, W_RESIZE_CURSOR, WAIT_CURSOR

Fields inherited from class java.awt.Component

BOTTOM_ALIGNMENT, CENTER_ALIGNMENT, LEFT_ALIGNMENT, RIGHT_ALIGNMENT, TOP_ALIGNMENT

Fields inherited from interface javax.swing.WindowConstants

DISPOSE_ON_CLOSE, DO_NOTHING_ON_CLOSE, HIDE_ON_CLOSE

Fields inherited from interface java.awt.image.ImageObserver

ABORT, ALLBITS, ERROR, FRAMEBITS, HEIGHT, PROPERTIES, SOMEBITS, WIDTH

Constructor Summary

Constructors

Constructor and Description
SimpleFrame() Constructs a simple frame with default parameters.
SimpleFrame(AxesOrientation ao) Constructs a simple frame with specified axes orientation.
SimpleFrame(World world) Constructs a simple frame with the specified world.
SimpleFrame(World world, AxesOrientation ao) Constructs a simple frame with the specified world and orientation.

Method Summary

Methods

Modifier and Type	Method and Description
ImagePanelGroup	addImagePanels(float[][][] f) Adds an image panel group to a simple frame from a given 3D array
ImagePanelGroup	addImagePanels(ImagePanelGroup ipg) Adds an image panel group to a simple frame from a given image panel group.
ImagePanelGroup	addImagePanels(Sampling s1, Sampling s2, Sampling s3, float[][][] f) Adds an image panel group to a simple frame from given samplings and a 3D array.
TriangleGroup	addTriangles(float[] xyz) Adds a triangle group with specified vertex coordinates.
TriangleGroup	addTriangles(float[] xyz, float[] rgb) Adds a triangle group with specified vertex coordinates and colors.
TriangleGroup	addTriangles(Sampling sx, Sampling sy, float[][] z) Adds a triangle group for a sampled function z = f(x,y).
TriangleGroup	addTriangles(TriangleGroup tg) Adds a triangle group to a simple frame from a given triangle group.
static SimpleFrame	asImagePanels(float[][][] f) Returns a new simple frame with an image panel group.
static SimpleFrame	asImagePanels(ImagePanelGroup ipg) Returns a new simple frame with an image panel group.
static SimpleFrame	asImagePanels(Sampling s1, Sampling s2, Sampling s3, float[][][] f) Returns a new simple frame with an image panel group.
static SimpleFrame	asTriangles(boolean vn, float[] xyz) Returns a new simple frame with a triangle group.
static SimpleFrame	asTriangles(boolean vn, float[] xyz, float[] rgb) Returns a new simple frame with a triangle group.
SimpleFrame	asTriangles(boolean vn, Sampling sx, Sampling sy, float[][] z) Returns a new simple frame with a triangle group.
SimpleFrame	asTriangles(boolean vn, Sampling sx, Sampling sy, float[][] z, float[][] r, float[][] g, float[][] b) Returns a new simple frame with a triangle group.
static SimpleFrame	asTriangles(float[] xyz) Returns a new simple frame with a triangle group.
static SimpleFrame	asTriangles(float[] xyz, float[] rgb) Returns a new simple frame with a triangle group.
static SimpleFrame	asTriangles(TriangleGroup tg) Returns a new simple frame with a triangle group.
javax.swing.JToolBar	getJToolBar() Gets the JToolBar for this simple frame.
ModeManager	getModeManager() Gets the mode manager for this simple frame.
OrbitView	getOrbitView() Gets the orbit view for this frame.
ViewCanvas	getViewCanvas() Gets the view canvas for this frame.
World	getWorld() Gets the world for this frame.
void	paintToFile(java.lang.String fileName) Paints the view canvas to an image in a file with specified name.
void	setWorldSphere(BoundingSphere bs) Sets the bounding sphere of the frame.
void	setWorldSphere(double x, double y, double z, double r) Sets the bounding sphere of the frame with a given center x, y, z and radius.
void	setWorldSphere(double xmin, double ymin, double zmin, double xmax, double ymax, double zmax) Sets the bounding sphere of the frame.
void	setWorldSphere(Point3 p, int r) Sets the bounding sphere of the frame with a given center point and radius.

Methods inherited from class javax.swing.JFrame

addImpl, createRootPane, frameInit, getAccessibleContext, getContentPane, getDefaultCloseOperation, getGlassPane, getGraphics, getJMenuBar, getLayeredPane, getRootPane, getTransferHandler, isDefaultLookAndFeelDecorated, isRootPaneCheckingEnabled, paramString, processWindowEvent, remove, repaint, setContentPane, setDefaultCloseOperation, setDefaultLookAndFeelDecorated, setGlassPane, setIconImage, setJMenuBar, setLayeredPane, setLayout, setRootPane, setRootPaneCheckingEnabled, setTransferHandler, update

Methods inherited from class java.awt.Frame

addNotify, getCursorType, getExtendedState, getFrames, getIconImage, getMaximizedBounds, getMenuBar, getState, getTitle, isResizable, isUndecorated, remove, removeNotify, setBackground, setCursor, setExtendedState, setMaximizedBounds, setMenuBar, setOpacity, setResizable, setShape, setState, setTitle, setUndecorated

Methods inherited from class java.awt.Window

addPropertyChangeListener, addPropertyChangeListener, addWindowFocusListener, addWindowListener, addWindowStateListener, applyResourceBundle, applyResourceBundle, createBufferStrategy, createBufferStrategy, dispose, getBackground, getBufferStrategy, getFocusableWindowState, getFocusCycleRootAncestor, getFocusOwner, getFocusTraversalKeys, getIconImages, getInputContext, getListeners, getLocale, getModalExclusionType, getMostRecentFocusOwner, getOpacity, getOwnedWindows, getOwner, getOwnerlessWindows, getShape, getToolkit, getType, getWarningString, getWindowFocusListeners, getWindowListeners, getWindows, getWindowStateListeners, hide, isActive, isAlwaysOnTop, isAlwaysOnTopSupported, isAutoRequestFocus, isFocusableWindow, isFocusCycleRoot, isFocused, isLocationByPlatform, isOpaque, isShowing, isValidateRoot, pack, paint, postEvent, processEvent, processWindowFocusEvent, processWindowStateEvent, removeWindowFocusListener, removeWindowListener, removeWindowStateListener, reshape, setAlwaysOnTop, setAutoRequestFocus, setBounds, setBounds, setCursor, setFocusableWindowState, setFocusCycleRoot, setIconImages, setLocation, setLocation, setLocationByPlatform, setLocationRelativeTo, setMinimumSize, setModalExclusionType, setSize, setSize, setType, setVisible, show, toBack, toFront

Methods inherited from class java.awt.Container

add, add, add, add, add, addContainerListener, applyComponentOrientation, areFocusTraversalKeysSet, countComponents, deliverEvent, doLayout, findComponentAt, findComponentAt, getAlignmentX, getAlignmentY, getComponent, getComponentAt, getComponentAt, getComponentCount, getComponents, getComponentZOrder, getContainerListeners, getFocusTraversalPolicy, getInsets, getLayout, getMaximumSize, getMinimumSize, getMousePosition, getPreferredSize, insets, invalidate, isAncestorOf, isFocusCycleRoot, isFocusTraversalPolicyProvider, isFocusTraversalPolicySet, layout, list, list, locate, minimumSize, paintComponents, preferredSize, print, printComponents, processContainerEvent, remove, removeAll, removeContainerListener, setComponentZOrder, setFocusTraversalKeys, setFocusTraversalPolicy, setFocusTraversalPolicyProvider, setFont, transferFocusDownCycle, validate, validateTree

Methods inherited from class java.awt.Component

action, add, addComponentListener, addFocusListener, addHierarchyBoundsListener, addHierarchyListener, addInputMethodListener, addKeyListener, addMouseListener, addMouseMotionListener, addMouseWheelListener, bounds, checkImage, checkImage, coalesceEvents, contains, contains, createImage, createImage, createVolatileImage, createVolatileImage, disable, disableEvents, dispatchEvent, enable, enable, enableEvents, enableInputMethods, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, getBaseline, getBaselineResizeBehavior, getBounds, getBounds, getColorModel, getComponentListeners, getComponentOrientation, getCursor, getDropTarget, getFocusListeners, getFocusTraversalKeysEnabled, getFont, getFontMetrics, getForeground, getGraphicsConfiguration, getHeight, getHierarchyBoundsListeners, getHierarchyListeners, getIgnoreRepaint, getInputMethodListeners, getInputMethodRequests, getKeyListeners, getLocation, getLocation, getLocationOnScreen, getMouseListeners, getMouseMotionListeners, getMousePosition, getMouseWheelListeners, getName, getParent, getPeer, getPropertyChangeListeners, getPropertyChangeListeners, getSize, getSize, getTreeLock, getWidth, getX, getY, gotFocus, handleEvent, hasFocus, imageUpdate, inside, isBackgroundSet, isCursorSet, isDisplayable, isDoubleBuffered, isEnabled, isFocusable, isFocusOwner, isFocusTraversable, isFontSet, isForegroundSet, isLightweight, isMaximumSizeSet, isMinimumSizeSet, isPreferredSizeSet, isValid, isVisible, keyDown, keyUp, list, list, list, location, lostFocus, mouseDown, mouseDrag, mouseEnter, mouseExit, mouseMove, mouseUp, move, nextFocus, paintAll, prepareImage, prepareImage, printAll, processComponentEvent, processFocusEvent, processHierarchyBoundsEvent, processHierarchyEvent, processInputMethodEvent, processKeyEvent, processMouseEvent, processMouseMotionEvent, processMouseWheelEvent, removeComponentListener, removeFocusListener, removeHierarchyBoundsListener, removeHierarchyListener, removeInputMethodListener, removeKeyListener, removeMouseListener, removeMouseMotionListener, removeMouseWheelListener, removePropertyChangeListener, removePropertyChangeListener, repaint, repaint, repaint, requestFocus, requestFocus, requestFocusInWindow, requestFocusInWindow, resize, resize, revalidate, setComponentOrientation, setDropTarget, setEnabled, setFocusable, setFocusTraversalKeysEnabled, setForeground, setIgnoreRepaint, setLocale, setMaximumSize, setName, setPreferredSize, show, size, toString, transferFocus, transferFocusBackward, transferFocusUpCycle

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.awt.MenuContainer

getFont, postEvent

Constructor Detail

SimpleFrame

public SimpleFrame()

Constructs a simple frame with default parameters. Axes orientation defaults to x-right, y-out and z-down.

SimpleFrame

public SimpleFrame(AxesOrientation ao)

Constructs a simple frame with specified axes orientation.

Parameters:

ao - the axes orientation.

SimpleFrame

public SimpleFrame(World world)

Constructs a simple frame with the specified world.

Parameters:

world - the world view.

SimpleFrame

public SimpleFrame(World world,
           AxesOrientation ao)

Constructs a simple frame with the specified world and orientation.

Parameters:

world - the world view.

ao - the axes orientation.

Method Detail

getModeManager

public ModeManager getModeManager()

Gets the mode manager for this simple frame.

Returns:

the mode manager.

getJToolBar

public javax.swing.JToolBar getJToolBar()

Gets the JToolBar for this simple frame.

Returns:

the JToolBar.

asTriangles

public static SimpleFrame asTriangles(float[] xyz)

Returns a new simple frame with a triangle group. Triangles will be constructed as vertex normals.

Parameters:

xyz - array of packed vertex coordinates.

Returns:

a simple frame.

asTriangles

public static SimpleFrame asTriangles(boolean vn,
                      float[] xyz)

Returns a new simple frame with a triangle group.

Parameters:

vn - true, for vertex normals; false, for triangle normals.

xyz - array of packed vertex coordinates.

Returns:

the simple frame.

asTriangles

public static SimpleFrame asTriangles(float[] xyz,
                      float[] rgb)

Returns a new simple frame with a triangle group. Triangles will be constructed as vertex normals.

Parameters:

xyz - array of packed vertex coordinates.

rgb - array of packed color coordinates.

Returns:

the simple frame.

asTriangles

public SimpleFrame asTriangles(boolean vn,
                      Sampling sx,
                      Sampling sy,
                      float[][] z)

Returns a new simple frame with a triangle group.

Parameters:

vn - true, for vertex normals; false, for triangle normals.

sx - sampling of x coordinates; may be non-uniform.

sy - sampling of y coordinates; may be non-uniform.

z - array[nx][ny] of z coordinates z = f(x,y).

asTriangles

public SimpleFrame asTriangles(boolean vn,
                      Sampling sx,
                      Sampling sy,
                      float[][] z,
                      float[][] r,
                      float[][] g,
                      float[][] b)

Returns a new simple frame with a triangle group.

Parameters:

vn - true, for vertex normals; false, for triangle normals.

sx - sampling of x coordinates; may be non-uniform.

sy - sampling of y coordinates; may be non-uniform.

z - array[nx][ny] of z coordinates z = f(x,y).

r - array[nx][ny] of red color components.

g - array[nx][ny] of green color components.

b - array[nx][ny] of blue color components.

asTriangles

public static SimpleFrame asTriangles(boolean vn,
                      float[] xyz,
                      float[] rgb)

Returns a new simple frame with a triangle group.

Parameters:

vn - true, for vertex normals; false, for triangle normals

xyz - array of packed vertex coordinates.

rgb - array of packed color coordinates.

Returns:

the simple frame.

asTriangles

public static SimpleFrame asTriangles(TriangleGroup tg)

Returns a new simple frame with a triangle group.

Parameters:

tg - a triangle group.

Returns:

the simple frame.

asImagePanels

public static SimpleFrame asImagePanels(float[][][] f)

Returns a new simple frame with an image panel group.

Parameters:

f - a 3D array.

Returns:

the simple frame.

asImagePanels

public static SimpleFrame asImagePanels(Sampling s1,
                        Sampling s2,
                        Sampling s3,
                        float[][][] f)

Returns a new simple frame with an image panel group.

Parameters:

s1 - sampling in the 1st dimension (Z).

s2 - sampling in the 2nd dimension (Y).

s3 - sampling in the 3rd dimension (X).

f - a 3D array.

Returns:

the simple frame.

asImagePanels

public static SimpleFrame asImagePanels(ImagePanelGroup ipg)

Returns a new simple frame with an image panel group.

Parameters:

ipg - an image panel group.

Returns:

the simple frame.

addTriangles

public TriangleGroup addTriangles(float[] xyz)

Adds a triangle group with specified vertex coordinates.

Parameters:

xyz - array of packed vertex coordinates.

Returns:

the triangle group.

addTriangles

public TriangleGroup addTriangles(float[] xyz,
                         float[] rgb)

Adds a triangle group with specified vertex coordinates and colors.

Parameters:

xyz - array of packed vertex coordinates.

rgb - array of packed color components.

Returns:

the triangle group.

addTriangles

public TriangleGroup addTriangles(Sampling sx,
                         Sampling sy,
                         float[][] z)

Adds a triangle group for a sampled function z = f(x,y).

Parameters:

sx - sampling of x coordinates; may be non-uniform.

sy - sampling of y coordinates; may be non-uniform.

z - array[nx][ny] of z coordinates z = f(x,y).

addTriangles

public TriangleGroup addTriangles(TriangleGroup tg)

Adds a triangle group to a simple frame from a given triangle group.

Parameters:

tg - a triangle group.

Returns:

the attached triangle group.

addImagePanels

public ImagePanelGroup addImagePanels(float[][][] f)

Adds an image panel group to a simple frame from a given 3D array

Parameters:

f - a 3D array.

Returns:

the image panel group.

addImagePanels

public ImagePanelGroup addImagePanels(Sampling s1,
                             Sampling s2,
                             Sampling s3,
                             float[][][] f)

Adds an image panel group to a simple frame from given samplings and a 3D array.

Parameters:

s1 - sampling in the 1st dimension (Z).

s2 - sampling in the 2nd dimension (Y).

s3 - sampling in the 3rd dimension (X).

f - a 3D array.

Returns:

the image panel group.

addImagePanels

public ImagePanelGroup addImagePanels(ImagePanelGroup ipg)

Adds an image panel group to a simple frame from a given image panel group.

Parameters:

ipg - an image panel group.

Returns:

the attached image panel group.

getViewCanvas

public ViewCanvas getViewCanvas()

Gets the view canvas for this frame.

Returns:

the view canvas.

getOrbitView

public OrbitView getOrbitView()

Gets the orbit view for this frame.

Returns:

the orbit view.

getWorld

public World getWorld()

Gets the world for this frame.

Returns:

the world.

setWorldSphere

public void setWorldSphere(Point3 p,
                  int r)

Sets the bounding sphere of the frame with a given center point and radius.

Parameters:

p - the center point.

r - the radius.

setWorldSphere

public void setWorldSphere(double x,
                  double y,
                  double z,
                  double r)

Sets the bounding sphere of the frame with a given center x, y, z and radius.

Parameters:

x - the center X-coordinate.

y - the center Y-coordinate.

z - the center Z-coordinate.

r - the radius.

setWorldSphere

public void setWorldSphere(double xmin,
                  double ymin,
                  double zmin,
                  double xmax,
                  double ymax,
                  double zmax)

Sets the bounding sphere of the frame.

Parameters:

xmin - the minimum x coordinate.

ymin - the minimum y coordinate.

zmin - the minimum z coordinate.

xmax - the maximum x coordinate.

ymax - the maximum y coordinate.

zmax - the maximum z coordinate.

setWorldSphere

public void setWorldSphere(BoundingSphere bs)

Sets the bounding sphere of the frame.

Parameters:

bs - the bounding sphere.

paintToFile

public void paintToFile(java.lang.String fileName)

Paints the view canvas to an image in a file with specified name. Uses the file suffix to determine the format of the image.

Parameters:

fileName - name of the file to contain the image.