edu.mines.jtk.sgl.SimpleFrame Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of edu-mines-jtk Show documentation
Show all versions of edu-mines-jtk Show documentation
Java packages for science and engineering
/****************************************************************************
Copyright 2009, Colorado School of Mines and others.
Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
****************************************************************************/
package edu.mines.jtk.sgl;
import java.awt.*;
import java.awt.event.ActionEvent;
import javax.swing.*;
import edu.mines.jtk.awt.*;
import edu.mines.jtk.dsp.Sampling;
/**
* A simple frame for 3D graphics.
* @author Chris Engelsma and Dave Hale, Colorado School of Mines.
* @version 2010.12.09
*/
public class SimpleFrame extends JFrame {
/**
* Constructs a simple frame with default parameters.
* Axes orientation defaults to x-right, y-out and z-down.
*/
public SimpleFrame() {
this(null,null);
}
/**
* Constructs a simple frame with specified axes orientation.
* @param ao the axes orientation.
*/
public SimpleFrame(AxesOrientation ao) {
this(null,ao);
}
/**
* Constructs a simple frame with the specified world.
* @param world the world view.
*/
public SimpleFrame(World world) {
this(world,null);
}
/**
* Constructs a simple frame with the specified world and orientation.
* @param world the world view.
* @param ao the axes orientation.
*/
public SimpleFrame(World world, AxesOrientation ao) {
if (world==null) world = new World();
if (ao==null) ao = AxesOrientation.XRIGHT_YOUT_ZDOWN;
_world = world;
_view = new OrbitView(_world);
_view.setAxesOrientation(ao);
_canvas = new ViewCanvas();
_canvas.setView(_view);
_modeManager = new ModeManager();
_modeManager.add(_canvas);
OrbitViewMode ovm = new OrbitViewMode(_modeManager);
SelectDragMode sdm = new SelectDragMode(_modeManager);
JPopupMenu.setDefaultLightWeightPopupEnabled(false);
ToolTipManager.sharedInstance().setLightWeightPopupEnabled(false);
JMenu fileMenu = new JMenu("File");
fileMenu.setMnemonic('F');
Action exitAction = new AbstractAction("Exit") {
public void actionPerformed(ActionEvent event) {
System.exit(0);
}
};
JMenuItem exitItem = fileMenu.add(exitAction);
exitItem.setMnemonic('X');
JMenu modeMenu = new JMenu("Mode");
modeMenu.setMnemonic('M');
JMenuItem ovmItem = new JMenuItem(ovm);
modeMenu.add(ovmItem);
JMenuItem sdmItem = new JMenuItem(sdm);
modeMenu.add(sdmItem);
JMenuBar menuBar = new JMenuBar();
menuBar.add(fileMenu);
menuBar.add(modeMenu);
_toolBar = new JToolBar(SwingConstants.VERTICAL);
_toolBar.setRollover(true);
JToggleButton ovmButton = new ModeToggleButton(ovm);
_toolBar.add(ovmButton);
JToggleButton sdmButton = new ModeToggleButton(sdm);
_toolBar.add(sdmButton);
ovm.setActive(true);
this.setDefaultCloseOperation(JFrame.EXIT_ON_CLOSE);
this.setSize(new Dimension(SIZE,SIZE));
this.add(_canvas,BorderLayout.CENTER);
this.add(_toolBar,BorderLayout.WEST);
this.setJMenuBar(menuBar);
this.setVisible(true);
}
/**
* Gets the mode manager for this simple frame.
* @return the mode manager.
*/
public ModeManager getModeManager() {
return _modeManager;
}
/**
* Gets the JToolBar for this simple frame.
* @return the JToolBar.
*/
public JToolBar getJToolBar() {
return _toolBar;
}
/**
* Returns a new simple frame with a triangle group.
* Triangles will be constructed as vertex normals.
* @param xyz array of packed vertex coordinates.
* @return a simple frame.
*/
public static SimpleFrame asTriangles(float[] xyz) {
return asTriangles(true,xyz);
}
/**
* Returns a new simple frame with a triangle group.
* @param vn true, for vertex normals; false, for triangle normals.
* @param xyz array of packed vertex coordinates.
* @return the simple frame.
*/
public static SimpleFrame asTriangles(boolean vn, float[] xyz) {
return asTriangles(vn,xyz,null);
}
/**
* Returns a new simple frame with a triangle group.
* Triangles will be constructed as vertex normals.
* @param xyz array of packed vertex coordinates.
* @param rgb array of packed color coordinates.
* @return the simple frame.
*/
public static SimpleFrame asTriangles(float[] xyz, float[] rgb) {
return asTriangles(true,xyz,rgb);
}
/**
* Returns a new simple frame with a triangle group.
* @param vn true, for vertex normals; false, for triangle normals.
* @param sx sampling of x coordinates; may be non-uniform.
* @param sy sampling of y coordinates; may be non-uniform.
* @param z array[nx][ny] of z coordinates z = f(x,y).
*/
public static SimpleFrame asTriangles(
boolean vn, Sampling sx, Sampling sy, float[][] z)
{
return asTriangles(new TriangleGroup(vn,sx,sy,z));
}
/**
* Returns a new simple frame with a triangle group.
* @param vn true, for vertex normals; false, for triangle normals.
* @param sx sampling of x coordinates; may be non-uniform.
* @param sy sampling of y coordinates; may be non-uniform.
* @param z array[nx][ny] of z coordinates z = f(x,y).
* @param r array[nx][ny] of red color components.
* @param g array[nx][ny] of green color components.
* @param b array[nx][ny] of blue color components.
*/
public static SimpleFrame asTriangles(
boolean vn, Sampling sx, Sampling sy, float[][] z,
float[][] r, float[][] g, float[][] b)
{
return asTriangles(new TriangleGroup(vn,sx,sy,z,r,g,b));
}
/**
* Returns a new simple frame with a triangle group.
* @param vn true, for vertex normals; false, for triangle normals
* @param xyz array of packed vertex coordinates.
* @param rgb array of packed color coordinates.
* @return the simple frame.
*/
public static SimpleFrame asTriangles(boolean vn, float[] xyz, float[] rgb) {
return asTriangles(new TriangleGroup(vn,xyz,rgb));
}
/**
* Returns a new simple frame with a triangle group.
* @param tg a triangle group.
* @return the simple frame.
*/
public static SimpleFrame asTriangles(TriangleGroup tg) {
SimpleFrame sf = new SimpleFrame();
sf.addTriangles(tg);
sf.getOrbitView().setWorldSphere(tg.getBoundingSphere(true));
return sf;
}
/**
* Returns a new simple frame with an image panel group.
* @param f a 3D array.
* @return the simple frame.
*/
public static SimpleFrame asImagePanels(float[][][] f) {
return asImagePanels(new ImagePanelGroup(f));
}
/**
* Returns a new simple frame with an image panel group.
* @param s1 sampling in the 1st dimension (Z).
* @param s2 sampling in the 2nd dimension (Y).
* @param s3 sampling in the 3rd dimension (X).
* @param f a 3D array.
* @return the simple frame.
*/
public static SimpleFrame asImagePanels(
Sampling s1, Sampling s2, Sampling s3, float[][][] f) {
return asImagePanels(new ImagePanelGroup(s1,s2,s3,f));
}
/**
* Returns a new simple frame with an image panel group.
* @param ipg an image panel group.
* @return the simple frame.
*/
public static SimpleFrame asImagePanels(ImagePanelGroup ipg) {
SimpleFrame sf = new SimpleFrame();
sf.addImagePanels(ipg);
sf.getOrbitView().setWorldSphere(ipg.getBoundingSphere(true));
return sf;
}
/**
* Adds a triangle group with specified vertex coordinates.
* @param xyz array of packed vertex coordinates.
* @return the triangle group.
*/
public TriangleGroup addTriangles(float[] xyz) {
return addTriangles(new TriangleGroup(true,xyz,null));
}
/**
* Adds a triangle group with specified vertex coordinates and colors.
* @param xyz array of packed vertex coordinates.
* @param rgb array of packed color components.
* @return the triangle group.
*/
public TriangleGroup addTriangles(float[] xyz, float[] rgb) {
return addTriangles(new TriangleGroup(true,xyz,rgb));
}
/**
* Adds a triangle group for a sampled function z = f(x,y).
* @param sx sampling of x coordinates; may be non-uniform.
* @param sy sampling of y coordinates; may be non-uniform.
* @param z array[nx][ny] of z coordinates z = f(x,y).
*/
public TriangleGroup addTriangles(Sampling sx, Sampling sy, float[][] z) {
return addTriangles(new TriangleGroup(true,sx,sy,z));
}
/**
* Adds a triangle group to a simple frame from a given triangle group.
* @param tg a triangle group.
* @return the attached triangle group.
*/
public TriangleGroup addTriangles(TriangleGroup tg) {
_world.addChild(tg);
return tg;
}
/**
* Adds an image panel group to a simple frame from a given 3D array
* @param f a 3D array.
* @return the image panel group.
*/
public ImagePanelGroup addImagePanels(float[][][] f) {
return addImagePanels(new Sampling(f[0][0].length),
new Sampling(f[0].length),
new Sampling(f.length),
f);
}
/**
* Adds an image panel group to a simple frame from given samplings and
* a 3D array.
* @param s1 sampling in the 1st dimension (Z).
* @param s2 sampling in the 2nd dimension (Y).
* @param s3 sampling in the 3rd dimension (X).
* @param f a 3D array.
* @return the image panel group.
*/
public ImagePanelGroup addImagePanels(
Sampling s1, Sampling s2, Sampling s3, float[][][] f) {
return addImagePanels(new ImagePanelGroup(s1,s2,s3,f));
}
/**
* Adds an image panel group to a simple frame from a given image panel
* group.
* @param ipg an image panel group.
* @return the attached image panel group.
*/
public ImagePanelGroup addImagePanels(ImagePanelGroup ipg) {
_world.addChild(ipg);
return ipg;
}
/**
* Gets the view canvas for this frame.
* @return the view canvas.
*/
public ViewCanvas getViewCanvas() {
return _canvas;
}
/**
* Gets the orbit view for this frame.
* @return the orbit view.
*/
public OrbitView getOrbitView() {
return _view;
}
/**
* Gets the world for this frame.
* @return the world.
*/
public World getWorld() {
return _world;
}
/**
* Sets the bounding sphere of the frame with a given center point and
* radius.
* @param p the center point.
* @param r the radius.
*/
public void setWorldSphere(Point3 p, int r) {
setWorldSphere(new BoundingSphere(p,r));
}
/**
* Sets the bounding sphere of the frame with a given center x, y, z and
* radius.
* @param x the center X-coordinate.
* @param y the center Y-coordinate.
* @param z the center Z-coordinate.
* @param r the radius.
*/
public void setWorldSphere(double x, double y, double z, double r) {
setWorldSphere(new BoundingSphere(x,y,z,r));
}
/**
* Sets the bounding sphere of the frame.
* @param xmin the minimum x coordinate.
* @param ymin the minimum y coordinate.
* @param zmin the minimum z coordinate.
* @param xmax the maximum x coordinate.
* @param ymax the maximum y coordinate.
* @param zmax the maximum z coordinate.
*/
public void setWorldSphere(
double xmin, double ymin, double zmin,
double xmax, double ymax, double zmax)
{
setWorldSphere(
new BoundingSphere(
new BoundingBox(xmin,ymin,zmin,xmax,ymax,zmax)));
}
/**
* Sets the bounding sphere of the frame.
* @param bs the bounding sphere.
*/
public void setWorldSphere(BoundingSphere bs) {
_view.setWorldSphere(bs);
}
/**
* Paints the view canvas to an image in a file with specified name.
* Uses the file suffix to determine the format of the image.
* @param fileName name of the file to contain the image.
*/
public void paintToFile(String fileName) {
_canvas.paintToFile(fileName);
}
/////////////////////////////////////////////////////////////////////////////
// private
private ViewCanvas _canvas;
private OrbitView _view;
private World _world;
private ModeManager _modeManager;
private JToolBar _toolBar;
private static final int SIZE = 600;
}