Java Client¶
VisIt’s Java API allows Java applications to control VisIt’s viewer. Java applications can launch VisIt’s viewer window and control it programmatically, even replacing VisIt’s GUI with a custom Java GUI.
Disclaimers:
The Java client for a particular version of VisIt is available as separate tarball on our downloads page.
Look for jvisit<version>.tar.gz, e.g. jvisit3.3.0.tar.gz.
Simply untar to the directory of your choosing to use it.
Note that the tarball untars its contents to . and not its own directory.
Its best to make a directory (e.g. mkdir visit_java), copy the tarball into that directory and untar it there.
Java Client API Docs¶
Building from source¶
To build the java client from a source build of VisIt, you must set the VISIT_JAVA CMake bool variable to true when configuring VisIt with CMake.
Once the CMake configure step is complete, cd to the java subdirectory of the build directory and type make.
This will compile the core parts of the Java interface.
There are two other targets that can be built from the java directory: main and pack.
The main target will build the class files for all the examples.
The pack target causes a JAR file to be created and then packaged up with the Java source code, docs and example programs into a TAR file that can be shared.
The created visit.jar file will be present in the build directory.
The pack target will also build the example class files if not already built.
Examples¶
What follows are examples of how VisIt’s Java client can be used.
Source code for each example is available in the java subdirectory of the source code repository.
There are several arguments that are common to all the examples:
-stay:tells the program to continue running after the
work()method has completed instead of exiting.-path:path to VisIt’s bin directory, eg,
/usr/local/visit/3.3.0/bin-datapath:path to directory holding VisIt’s silo example data (used by many of the examples) eg:
/usr/local/visit/3.3.0/data/. Note: the trailing slash is required.-dv:A shorthand for
-path ../bin.-nopty:Is forwarded to VisIt launcher to make VisIt prompt for passwords in the console/terminal from which Java was run.
All of the examples are available from the top (.) directory of the untarred jvisit<version>.tar.gz.
Java Classes Documentation¶
There is a docs subdirectory from the untarred jvisit<version>.tar.gz with a bunch of .html files.
If you point a web browser at index.html there, you can find a lot of documentation on the various Java classes available and used in these examples.
Running the Examples¶
Assuming the current working directory is the directory where jvisit<version>.tar.gz was untarred, to run an example named Example.class, do the following…
java -cp .:visit.jar Example -stay -path /path/to/visit/bin -datapath /path/to/silo/data/dir/
Note
The Java program to run, here Example, does not include the .class extension when it is specified on the command line to java.
The trailing slash for the -datapath argument is required.
All arguments before the name of the Java program to run are arguments to java.
All arguments after the name of the Java program to run are arguments to the program, or to VisIt. Any arguments not consumed by the Java program are forwarded to VisIt.
In client/server scenarios, if the above command line does not work or if the viewer seems to stall when connecting to the remote computer, try adding the -nopty argument to make VisIt prompt for passwords in the console from which Java was run.
This should rarely be necessary.
Basic example¶
This program defines the RunViewer class, which serves as the base class for some of the other example Java programs.
The RunViewer program does much of its initialization of the ViewerProxy, the main class for controlling VisIt’s viewer, in its run() method.
The actual VisIt-related work, however, is defined in the work() method and is overridden in subclasses to perform different VisIt functionality.
This program’s work() method opens the VisIt globe.silo database, sets some annotation properties, and makes a Pseudocolor plot and a Mesh plot.
After the plots are drawn, the program changes the plot variables a couple of times and saves out images for each of the plotted variables.
Show/Hide Code for RunViewer
// Copyright (c) Lawrence Livermore National Security, LLC and other VisIt
// Project developers. See the top-level LICENSE file for dates and other
// details. No copyright assignment is required to contribute to VisIt.
import llnl.visit.Axes3D;
import llnl.visit.EventLoop;
import llnl.visit.ViewerProxy;
import llnl.visit.ColorAttribute;
import llnl.visit.AnnotationAttributes;
// ****************************************************************************
// Class: RunViewer
//
// Purpose:
// This class implements an example program that shows how to use the
// ViewerProxy class and control VisIt's viewer from Java.
//
// Notes:
//
// Programmer: Brad Whitlock
// Creation: Thu Aug 8 12:47:31 PDT 2002
//
// Modifications:
// Brad Whitlock, Fri Nov 22 12:33:00 PDT 2002
// Updated because of changes to AnnotationAttributes.
//
// Brad Whitlock, Thu Dec 12 10:43:50 PDT 2002
// Updated because of changes to color tables.
//
// Brad Whitlock, Thu Mar 20 10:53:39 PDT 2003
// I made it use port 5600.
//
// Brad Whitlock, Mon Jun 6 10:18:10 PDT 2005
// I added a little code to reduce CPU usage. I also made it use
// GetDataPath to locate the data.
//
// Brad Whitlock, Thu Jul 26 15:44:08 PST 2007
// Added support for -dv instead of -vob.
//
// Brad Whitlock, Mon Feb 25 11:07:24 PDT 2008
// Changed to new ViewerProxy interface.
//
// Kathleen Biagas, Tue Jan 14 08:45:32 MST 2014
// Updated usage: changed -vob to -dv, added -datapath.
//
// Justin Privitera, Wed May 18 11:25:46 PDT 2022
// Changed *active* to *default* for everything related to color tables.
//
// ****************************************************************************
public class RunViewer
{
public RunViewer()
{
viewer = new ViewerProxy();
}
public void run(String[] args)
{
// Pass command line options to the viewer viewer
boolean stay = false;
boolean sync = true;
boolean verbose = false;
for(int i = 0; i < args.length; ++i)
{
if(args[i].equals("-stay"))
stay = true;
else if(args[i].equals("-dv"))
viewer.SetBinPath("../bin");
else if(args[i].equals("-sync"))
sync = true;
else if(args[i].equals("-async"))
sync = false;
else if(args[i].equals("-verbose"))
verbose = true;
else if(args[i].equals("-quiet"))
verbose = false;
else if(args[i].equals("-path") && ((i + 1) < args.length))
{
viewer.SetBinPath(args[i + 1]);
++i;
}
else if(args[i].equals("-datapath") && ((i + 1) < args.length))
{
viewer.SetDataPath(args[i + 1]);
++i;
}
else if(args[i].equals("-help"))
{
printUsage();
return;
}
else
viewer.AddArgument(args[i]);
}
// Set the viewer proxy's verbose flag.
viewer.SetVerbose(verbose);
// Try and open the viewer using the viewer proxy.
if(viewer.Create(5600))
{
System.out.println("ViewerProxy opened the viewer.");
// Set some viewer properties based on command line args.
viewer.SetSynchronous(sync);
// Show the windows.
viewer.GetViewerMethods().ShowAllWindows();
work(args);
// If we have the -stay argument on the command line, keep the
// viewer around so we can do stuff with it.
if(stay)
viewer.GetEventLoop().Execute();
viewer.Close();
}
else
System.out.println("ViewerProxy could not open the viewer.");
}
protected void printUsage()
{
System.out.println("Options:");
System.out.println(" -stay Keeps the viewer around after it is done processing commands.");
System.out.println(" -dv Runs the viewer located in ../bin.");
System.out.println(" -sync Runs the viewer in synchronous mode. This is the default.");
System.out.println(" -async Runs the viewer in asynchronous mode.");
System.out.println(" -verbose Prints information to the console.");
System.out.println(" -quiet Prevents information from being printed to the console.");
System.out.println(" -path dir Sets the directory that is searched for the visit script.");
System.out.println(" -datapath dir Sets the directory that is searched for the data files.");
System.out.println(" -help Displays options and exits program.");
}
protected void work(String[] args)
{
// Do a plot
if(viewer.GetViewerMethods().OpenDatabase(viewer.GetDataPath() + "globe.silo"))
{
viewer.GetViewerMethods().AddPlot("Pseudocolor", "u");
viewer.GetViewerMethods().AddPlot("Mesh", "mesh1");
viewer.GetViewerMethods().DrawPlots();
viewer.GetViewerMethods().SaveWindow();
// Change some annotation attributes.
AnnotationAttributes a = viewer.GetViewerState().GetAnnotationAttributes();
a.SetBackgroundMode(AnnotationAttributes.BACKGROUNDMODE_GRADIENT);
a.SetGradientBackgroundStyle(AnnotationAttributes.GRADIENTSTYLE_RADIAL);
a.SetGradientColor1(new ColorAttribute(0,0,255));
a.SetGradientColor2(new ColorAttribute(0,0,0));
a.SetForegroundColor(new ColorAttribute(255,255,255));
Axes3D a3d = new Axes3D(a.GetAxes3D());
a3d.SetAxesType(Axes3D.AXES_STATICEDGES);
a3d.SetVisible(true);
a.SetAxes3D(a3d);
a.Notify();
viewer.GetViewerMethods().SetAnnotationAttributes();
// Change the active color table
viewer.GetViewerMethods().SetDefaultContinuousColorTable("rainbow");
viewer.GetViewerMethods().SetActivePlot(0);
viewer.GetViewerMethods().ChangeActivePlotsVar("v");
viewer.GetViewerMethods().SaveWindow();
viewer.GetViewerMethods().ChangeActivePlotsVar("t");
viewer.GetViewerMethods().SaveWindow();
}
else
{
System.out.println("Could not open the database!");
}
}
public static void main(String args[])
{
RunViewer r = new RunViewer();
r.run(args);
}
protected ViewerProxy viewer;
}
Controlling lighting¶
This example program is based on the RunViewer example program and it shows how to modify lighting in VisIt.
The basic procedure is to obtain a handle to the state object that you want to modify, in this case, LightList and then modify the state object and call its Notify() method to send the changed object back to VisIt’s viewer.
Once the changed object has been sent back to VisIt’s viewer, you call a method from ViewerMethods that tells VisIt to apply the sent object to its internal state.
Show/Hide Code for TryLighting
// Copyright (c) Lawrence Livermore National Security, LLC and other VisIt
// Project developers. See the top-level LICENSE file for dates and other
// details. No copyright assignment is required to contribute to VisIt.
import java.lang.ArrayIndexOutOfBoundsException;
import llnl.visit.AttributeSubject;
import llnl.visit.ColorAttribute;
import llnl.visit.LightList;
import llnl.visit.LightAttributes;
import llnl.visit.SimpleObserver;
import llnl.visit.View3DAttributes;
import llnl.visit.plots.PseudocolorAttributes;
// ****************************************************************************
// Class: TryLighting
//
// Purpose:
// This example program sets the view and turns on some colored lights. It
// also shows how to observe the viewer's state objects so actions can be
// performed when new state arrives.
//
// Notes:
//
// Programmer: Brad Whitlock
// Creation: Thu Aug 15 16:10:44 PST 2002
//
// Modifications:
// Brad Whitlock, Tue Sep 24 09:08:51 PDT 2002
// I fixed the example so the lights work as intended.
//
// Brad Whitlock, Thu Dec 12 10:44:31 PDT 2002
// Updated because of changse to color table methods.
//
// Eric Brugger, Wed Aug 27 09:06:38 PDT 2003
// I modified it to use the new view interface.
//
// Brad Whitlock, Mon Jun 6 17:25:34 PST 2005
// I made it use GetDataPath to locate the data.
//
// Brad Whitlock, Thu Jul 14 12:08:42 PDT 2005
// I made it set the Pseudocolor plot atts's color table to "Default".
//
// Brad Whitlock, Fri Sep 22 15:15:02 PST 2006
// I fixed a problem with the brightness of lights 2,3 being set to 0.
//
// Brad Whitlock, Mon Feb 25 11:07:24 PDT 2008
// Changed to new ViewerProxy interface.
//
// Justin Privitera, Wed May 18 11:25:46 PDT 2022
// Changed *active* to *default* for everything related to color tables.
//
// ****************************************************************************
public class TryLighting extends RunViewer implements SimpleObserver
{
public TryLighting()
{
super();
doUpdate = true;
// Make this object observe the light attributes.
viewer.GetViewerState().GetLightList().Attach(this);
}
protected void work(String[] args)
{
// Try and open a database
if(viewer.GetViewerMethods().OpenDatabase(viewer.GetDataPath() + "globe.silo"))
{
viewer.GetViewerMethods().AddPlot("Pseudocolor", "w");
// Set the pseudocolor attributes
PseudocolorAttributes p = (PseudocolorAttributes)viewer.GetPlotAttributes("Pseudocolor");
p.SetColorTableName("Default");
p.SetOpacity(1.);
p.Notify();
viewer.GetViewerMethods().SetPlotOptions("Pseudocolor");
viewer.GetViewerMethods().DrawPlots();
// Set the colortable to one that has white at the bottom values.
viewer.GetViewerMethods().SetDefaultContinuousColorTable("calewhite");
// Set the view
View3DAttributes v = viewer.GetViewerState().GetView3DAttributes();
v.SetViewNormal(0.456808, 0.335583, 0.823839);
v.SetFocus(-0.927295, -1.22113, 1.01159);
v.SetViewUp(-0.184554, 0.941716, -0.281266);
v.SetParallelScale(15.7041);
v.SetNearPlane(-34.641);
v.SetFarPlane(34.641);
v.Notify();
viewer.GetViewerMethods().SetView3D();
LightList ll = viewer.GetViewerState().GetLightList();
ll.SetAllEnabled(false);
// Create a red light
System.out.println("Setting up red light.");
LightAttributes newLight1 = new LightAttributes();
newLight1.SetType(LightAttributes.LIGHTTYPE_OBJECT);
newLight1.SetDirection(0,0,-1);
newLight1.SetColor(new ColorAttribute(255,0,0));
newLight1.SetBrightness(1.);
newLight1.SetEnabledFlag(true);
ll.SetLight0(newLight1);
ll.Notify();
viewer.GetViewerMethods().SetLightList();
viewer.GetViewerMethods().SaveWindow();
// Create a green light
System.out.println("Setting up green light.");
LightAttributes newLight2 = new LightAttributes();
newLight2.SetType(LightAttributes.LIGHTTYPE_OBJECT);
newLight2.SetDirection(-1,0,0);
newLight2.SetColor(new ColorAttribute(0,255,0));
newLight2.SetBrightness(1.);
newLight2.SetEnabledFlag(true);
ll.SetLight1(newLight2);
ll.Notify();
viewer.GetViewerMethods().SetLightList();
viewer.GetViewerMethods().SaveWindow();
// Create a blue light
System.out.println("Setting up blue light.");
LightAttributes newLight3 = new LightAttributes();
newLight3.SetType(LightAttributes.LIGHTTYPE_OBJECT);
newLight3.SetDirection(0,-1,0);
newLight3.SetColor(new ColorAttribute(0,0,255));
newLight3.SetBrightness(1.);
newLight3.SetEnabledFlag(true);
ll.SetLight2(newLight3);
ll.Notify();
viewer.GetViewerMethods().SetLightList();
viewer.GetViewerMethods().SaveWindow();
}
else
System.out.println("Could not open the database!");
}
public void Update(AttributeSubject s)
{
LightList ll = (LightList)s;
printLights(ll);
}
public void SetUpdate(boolean val) { doUpdate = val; }
public boolean GetUpdate() { return doUpdate; }
protected void printLights(LightList ll)
{
printLight(0, ll.GetLight0());
printLight(1, ll.GetLight1());
printLight(2, ll.GetLight2());
printLight(3, ll.GetLight3());
printLight(4, ll.GetLight4());
printLight(5, ll.GetLight5());
printLight(6, ll.GetLight6());
printLight(7, ll.GetLight7());
System.out.println("");
}
protected void printLight(int index, LightAttributes l)
{
System.out.println("Light["+index+"] = {");
System.out.println(" enabled = "+l.GetEnabledFlag());
int t = l.GetType();
double[] d = l.GetDirection();
switch(t)
{
case LightAttributes.LIGHTTYPE_AMBIENT:
System.out.println(" type = AMBIENT");
break;
case LightAttributes.LIGHTTYPE_OBJECT:
System.out.println(" type = OBJECT");
System.out.println(" direction = {"+d[0]+", "+d[1]+", "+d[2]+"}");
break;
case LightAttributes.LIGHTTYPE_CAMERA:
System.out.println(" type = CAMERA");
System.out.println(" direction = {"+d[0]+", "+d[1]+", "+d[2]+"}");
}
ColorAttribute c = l.GetColor();
System.out.println(" color = {"+c.Red()+", "+c.Green()+", "+c.Blue()+"}");
System.out.println(" brightness = "+l.GetBrightness());
System.out.println("}");
}
public static void main(String args[])
{
TryLighting r = new TryLighting();
r.run(args);
}
private boolean doUpdate;
}
Performing queries¶
This example program shows how to use some of VisIt’s query capabilities to perform picks and lineouts.
Show/Hide Code for TryQuery
// Copyright (c) Lawrence Livermore National Security, LLC and other VisIt
// Project developers. See the top-level LICENSE file for dates and other
// details. No copyright assignment is required to contribute to VisIt.
import java.lang.ArrayIndexOutOfBoundsException;
import java.util.Vector;
import llnl.visit.AttributeSubject;
import llnl.visit.SimpleObserver;
import llnl.visit.QueryAttributes;
// ****************************************************************************
// Class: TryQuery
//
// Purpose:
// This example program does a plot and queries some values in it.
//
// Notes:
//
// Programmer: Brad Whitlock
// Creation: Tue Oct 1 12:51:29 PDT 2002
//
// Modifications:
// Brad Whitlock, Thu Dec 12 10:44:31 PDT 2002
// Updated because of changse to color table methods.
//
// Brad Whitlock, Thu Jan 2 16:05:48 PST 2003
// Changed because of Lineout method interface change.
//
// Brad Whitlock, Mon Jun 6 17:25:34 PST 2005
// I made it use GetDataPath to locate the data.
//
// Brad Whitlock, Mon Feb 25 11:07:24 PDT 2008
// Changed to new ViewerProxy interface.
//
// Justin Privitera, Wed May 18 11:25:46 PDT 2022
// Changed *active* to *default* for everything related to color tables.
//
// ****************************************************************************
public class TryQuery extends RunViewer implements SimpleObserver
{
public TryQuery()
{
super();
doUpdate = true;
// Make this object observe the query and pick attributes.
viewer.GetViewerState().GetQueryAttributes().Attach(this);
viewer.GetViewerState().GetPickAttributes().Attach(this);
}
protected void work(String[] args)
{
// Try and open a database
if(viewer.GetViewerMethods().OpenDatabase(viewer.GetDataPath() + "curv2d.silo"))
{
viewer.GetViewerMethods().AddPlot("Mesh", "curvmesh2d");
viewer.GetViewerMethods().AddPlot("Pseudocolor", "d");
viewer.GetViewerMethods().DrawPlots();
// Set the colortable to one that has white at the bottom values.
viewer.GetViewerMethods().SetDefaultContinuousColorTable("calewhite");
// Create the variable list.
Vector vars = new Vector();
vars.addElement(new String("default"));
// Do some picks.
viewer.GetViewerMethods().Pick(300, 300, vars);
viewer.GetViewerMethods().Pick(450, 350, vars);
viewer.GetViewerMethods().Pick(600, 400, vars);
// Do some lineouts.
viewer.GetViewerMethods().Lineout(-4.01261, 1.91818, 2.52975, 3.78323, vars);
viewer.GetViewerMethods().SetActiveWindow(1);
viewer.GetViewerMethods().Lineout(-3.89903, 1.79309, 2.91593, 3.40794, vars);
// Change the window layout.
viewer.GetViewerMethods().SetWindowLayout(2);
}
else
System.out.println("Could not open the database!");
}
public void Update(AttributeSubject s)
{
System.out.println(s.toString(""));
}
public void SetUpdate(boolean val) { doUpdate = val; }
public boolean GetUpdate() { return doUpdate; }
public static void main(String args[])
{
TryQuery r = new TryQuery();
r.run(args);
}
private boolean doUpdate;
}
Getting metadata¶
This program shows how to query metadata for a database and print it to the console. In real applications, of course, you’d do something more constructive with the metadata object such as populate variable menus in a GUI.
Show/Hide Code for GetMetaData
// Copyright (c) Lawrence Livermore National Security, LLC and other VisIt
// Project developers. See the top-level LICENSE file for dates and other
// details. No copyright assignment is required to contribute to VisIt.
import java.lang.ArrayIndexOutOfBoundsException;
import llnl.visit.avtDatabaseMetaData;
// ****************************************************************************
// Class: GetMetaData
//
// Purpose:
// This example program opens a database and gets the metadata, printing
// it to the console.
//
// Notes:
//
// Programmer: Brad Whitlock
// Creation: Mon Feb 25 12:01:43 PDT 2008
//
// Modifications:
//
// ****************************************************************************
public class GetMetaData extends RunViewer
{
public GetMetaData()
{
super();
}
protected void work(String[] args)
{
// Try and open a database
if(viewer.GetViewerMethods().RequestMetaData(viewer.GetDataPath() + "noise.silo",0))
{
avtDatabaseMetaData md = viewer.GetViewerState().GetDatabaseMetaData();
System.out.print(md.toString());
}
else
System.out.println("Could not get the metadata for the database!");
}
public static void main(String args[])
{
GetMetaData r = new GetMetaData();
r.run(args);
}
}
Controlling annotations¶
This example program shows how to control various annotation objects via the Java API.
Show/Hide Code for TryAnnotations
// Copyright (c) Lawrence Livermore National Security, LLC and other VisIt
// Project developers. See the top-level LICENSE file for dates and other
// details. No copyright assignment is required to contribute to VisIt.
import java.lang.ArrayIndexOutOfBoundsException;
import java.util.Vector;
import llnl.visit.Axes3D;
import llnl.visit.View3DAttributes;
import llnl.visit.AnnotationAttributes;
import llnl.visit.AnnotationObject;
import llnl.visit.AnnotationObjectList;
import llnl.visit.ColorAttribute;
import llnl.visit.SaveWindowAttributes;
// ****************************************************************************
// Class: TryAnnotations
//
// Purpose:
// This example program shows how to create annotation objects and set
// their properties.
//
// Notes:
//
// Programmer: Brad Whitlock
// Creation: Wed Feb 27 09:38:43 PDT 2008
//
// Modifications:
// Brad Whitlock, Wed Jun 13 17:00:08 PDT 2012
// Set some legend options.
//
// ****************************************************************************
public class TryAnnotations extends RunViewer
{
public TryAnnotations()
{
super();
}
protected void SetCustomDefaultAnnotations()
{
// Change some annotation attributes.
AnnotationAttributes a = viewer.GetViewerState().GetAnnotationAttributes();
a.SetBackgroundMode(AnnotationAttributes.BACKGROUNDMODE_GRADIENT);
a.SetGradientBackgroundStyle(AnnotationAttributes.GRADIENTSTYLE_RADIAL);
a.SetGradientColor1(new ColorAttribute(0,0,255));
a.SetGradientColor2(new ColorAttribute(0,0,0));
a.SetForegroundColor(new ColorAttribute(255,255,255));
Axes3D a3d = new Axes3D(a.GetAxes3D());
a3d.SetAxesType(Axes3D.AXES_STATICEDGES);
a3d.SetVisible(true);
a.SetAxes3D(a3d);
a.Notify();
viewer.GetViewerMethods().SetAnnotationAttributes();
}
protected void work(String[] args)
{
// Try and open a database
if(viewer.GetViewerMethods().OpenDatabase(viewer.GetDataPath() + "wave*.silo database"))
{
viewer.GetViewerMethods().AddPlot("Pseudocolor", "pressure");
viewer.GetViewerMethods().AddPlot("Mesh", "quadmesh");
viewer.GetViewerMethods().DrawPlots();
// Set a 3D view.
View3DAttributes v = viewer.GetViewerState().GetView3DAttributes();
v.SetViewNormal(-0.705386, 0.57035, 0.42087);
v.SetFocus(5, 0.353448, 2.5);
v.SetViewUp(0.49514, 0.821357, -0.283213);
v.SetViewAngle(30.);
v.SetParallelScale(5.6009);
v.SetNearPlane(-11.2018);
v.SetFarPlane(11.2018);
v.SetImagePan(0.0300266, 0.0519825);
v.SetImageZoom(1.10796);
v.SetPerspective(true);
v.SetEyeAngle(2.);
v.SetCenterOfRotationSet(false);
v.SetCenterOfRotation(5, 0.353448, 2.5);
v.Notify();
viewer.GetViewerMethods().SetView3D();
SetCustomDefaultAnnotations();
AnnotationObjectList aol = viewer.GetViewerState().GetAnnotationObjectList();
//
// Set up a time slider annotation.
//
viewer.GetViewerMethods().AddAnnotationObject(AnnotationObject.ANNOTATIONTYPE_TIMESLIDER, "timeSlider");
aol.SetTimeSliderOptions("timeSlider",
0.675, 0.01, 0.3, 0.1,
"Wave time = $time", "%1.3f",
new ColorAttribute(255,0,0,255), new ColorAttribute(255,255,0,255),
new ColorAttribute(0,255,0,255), false,
0,
true, false, false);
aol.Notify();
viewer.GetViewerMethods().SetAnnotationObjectOptions();
// Advance through time to test the time slider.
viewer.GetViewerMethods().SetTimeSliderState(30);
System.out.println("After time slider: " + viewer.GetViewerState().GetAnnotationObjectList().toString());
//
// Create a 2D text annotation
//
viewer.GetViewerMethods().AddAnnotationObject(AnnotationObject.ANNOTATIONTYPE_TEXT2D, "text");
aol.SetText2DOptions("text", 0.4, 0.95, 0.05,
"Wave simulation",
new ColorAttribute(255,0,0,255), false,
2, true, true, true, true);
aol.Notify();
viewer.GetViewerMethods().SetAnnotationObjectOptions();
SaveImage("text2Dannot.png", 300, 300);
System.out.println("After 2D text: " + viewer.GetViewerState().GetAnnotationObjectList().toString());
//
// Create a 3D text annotation
//
viewer.GetViewerMethods().AddAnnotationObject(AnnotationObject.ANNOTATIONTYPE_TEXT3D, "text3D");
aol.SetText3DOptions("text3D",
0., 2.5, 1.5,
"Wave simulation, 3D text",
true, 0., 3,
true,
15., 0., 0.,
new ColorAttribute(255,255,0,255), false,
true);
aol.Notify();
viewer.GetViewerMethods().SetAnnotationObjectOptions();
SaveImage("text3D.png", 300, 300);
System.out.println("After 3D text: " + viewer.GetViewerState().GetAnnotationObjectList().toString());
// Create a line 2D/arrow annotation
//
viewer.GetViewerMethods().AddAnnotationObject(AnnotationObject.ANNOTATIONTYPE_LINE2D, "line");
aol.SetLine2DOptions("line",
0.5, 0.9495, 0.5, 0.6,
2,
0,
2,
new ColorAttribute(255,0,0,255), false,
true);
aol.Notify();
viewer.GetViewerMethods().SetAnnotationObjectOptions();
SaveImage("line2Dannot.png", 300, 300);
System.out.println("After line: " + viewer.GetViewerState().GetAnnotationObjectList().toString());
//
// Create a 3D line/arrow annotation
//
viewer.GetViewerMethods().AddAnnotationObject(AnnotationObject.ANNOTATIONTYPE_LINE3D, "line3d");
aol.SetLine3DOptions("line3d",
6.0, 0.0, 0.0, // startpoint
6.0, 3.0, 0.0, // endpoint
1, // lineWidth
1, // lineType 1=tube
1, //tubeQuality,
0.04, //tubeRadius,
false, // arrow1
16, // arrow1Resolution
0.120831, // arrow1Radius
0.338327, // arrow1Height
true, // arrow2
16, // arrow2Resolution
0.120831, // arrow2Radius
0.338327, // arrow2Height
new ColorAttribute(255,153,0,255), false,
true);
aol.Notify();
viewer.GetViewerMethods().SetAnnotationObjectOptions();
System.out.println("After 3D line: " + viewer.GetViewerState().GetAnnotationObjectList().toString());
SaveImage("line3Dannot.png", 300, 300);
//
// Save a small image to use for an annotation.
//
AnnotationAttributes annot = viewer.GetViewerState().GetAnnotationAttributes();
ColorAttribute transColor = new ColorAttribute(50,0,100,255);
annot.SetBackgroundColor(transColor);
annot.SetBackgroundMode(annot.BACKGROUNDMODE_SOLID);
annot.Notify();
viewer.GetViewerMethods().SetAnnotationAttributes();
SaveImage("imageannot.png", 300, 300);
annot.SetBackgroundColor(new ColorAttribute(0,0,0,255));
annot.Notify();
viewer.GetViewerMethods().SetAnnotationAttributes();
viewer.GetViewerMethods().AddAnnotationObject(AnnotationObject.ANNOTATIONTYPE_IMAGE, "image");
aol.SetImageOptions("image",
"imageannot.png",
0.02, 0.63,
1., 1., true,
transColor, true,
1.,
true);
aol.Notify();
viewer.GetViewerMethods().SetAnnotationObjectOptions();
System.out.println("After image: " + viewer.GetViewerState().GetAnnotationObjectList().toString());
// Set some legend attributes. You'd get the name from the PlotList object
// but here we're just hard-coding the plot name since the Pseudocolor is
// called Plot0000.
SetCustomDefaultAnnotations();
aol.SetLegendOptions("Plot0000",
false, // managePosition,
0.2, 0.1, // x,y
1.5, 0.5, // scaleX, scaleY
7, // numTicks
true, // drawBox
false, // drawLabels,
true, // horizontalLegend,
true, // alternateText, (false=normal text position, true=opposite position)
false, // drawTitle,
false, // drawMinMax,
true, // controlTicks,
true, // minMaxInclusive,
true, // drawValues
0.03, // fontheight
new ColorAttribute(100,255,100), false,
2, true, true, true,
true);
aol.Notify();
viewer.GetViewerMethods().SetAnnotationObjectOptions();
SaveImage("legendChange.png", 300, 300);
}
else
System.out.println("Could not open the database!");
}
private void SaveImage(String filename, int xres, int yres)
{
viewer.GetViewerMethods().SetAnnotationAttributes();
SaveWindowAttributes saveAtts = viewer.GetViewerState().GetSaveWindowAttributes();
saveAtts.SetFileName(filename);
saveAtts.SetWidth(xres);
saveAtts.SetHeight(yres);
saveAtts.SetFamily(false);
saveAtts.SetFormat(saveAtts.FILEFORMAT_PNG);
saveAtts.SetResConstraint(saveAtts.RESCONSTRAINT_NOCONSTRAINT);
saveAtts.Notify();
viewer.GetViewerMethods().SaveWindow();
}
public static void main(String args[])
{
TryAnnotations r = new TryAnnotations();
r.run(args);
}
}
Making host profiles¶
This program shows how to create a host profile, add it to the host profile list, and send it to the viewer. The program then goes on to access data on the remote computer, making use of the host profile that was created. Additional options such as how to launch the engine in parallel could be added to the host profile. Also, more profiles could be added to the host profile list before sending it to the viewer.
Show/Hide Code for MakeHostProfile
// Copyright (c) Lawrence Livermore National Security, LLC and other VisIt
// Project developers. See the top-level LICENSE file for dates and other
// details. No copyright assignment is required to contribute to VisIt.
import llnl.visit.ViewerProxy;
import llnl.visit.MachineProfile;
import llnl.visit.LaunchProfile;
import llnl.visit.HostProfileList;
import java.util.Vector;
// ****************************************************************************
// Class: MakeHostProfile
//
// Purpose:
// This class implements an example program that shows how to use the
// ViewerProxy class and control VisIt's viewer from Java.
//
// Notes:
//
// Programmer: Brad Whitlock
// Creation: Mon Aug 10 13:40:40 PDT 2009
//
// Modifications:
// Jeremy Meredith, Thu Feb 18 17:14:38 EST 2010
// Split host profile into machine profile and launch profile.
// Also, added directory argument.
//
// Kathleen Biagas, Wed Nov 9 14:30:32 PST 2016
// Update host name to a machine that still exists.
// ****************************************************************************
public class MakeHostProfile extends RunViewer
{
public MakeHostProfile()
{
super();
}
protected void work(String[] args)
{
// Change these for your remote system.
String host = new String("pascal.llnl.gov");
String user = new String("kbonnell");
String remotevisitPath = new String("/usr/gapps/visit");
// Basic, serial profile.
LaunchProfile example = new LaunchProfile();
example.SetProfileName("example");
example.SetActive(true);
// Create a new machine profile object and the serial launch profile.
MachineProfile profile = new MachineProfile();
profile.SetHost(host);
profile.SetUserName(user);
profile.SetClientHostDetermination(MachineProfile.CLIENTHOSTDETERMINATION_PARSEDFROMSSHCLIENT);
profile.SetTunnelSSH(true);
profile.SetDirectory(remotevisitPath);
profile.AddLaunchProfiles(example);
// Replace the list of host profiles and tell the viewer about the changes. We could
// have added to the list instead of clearing the list.
viewer.GetViewerState().GetHostProfileList().ClearMachines();
viewer.GetViewerState().GetHostProfileList().AddMachines(profile);
viewer.GetViewerState().GetHostProfileList().Notify();
System.out.println("HostProfileList = \n" +
viewer.GetViewerState().GetHostProfileList().toString(""));
// Do a plot of the remote data.
String remoteData = new String(host + ":" + remotevisitPath + "/data/globe.silo");
if(viewer.GetViewerMethods().OpenDatabase(remoteData))
{
viewer.GetViewerMethods().AddPlot("Pseudocolor", "u");
viewer.GetViewerMethods().AddPlot("Mesh", "mesh1");
viewer.GetViewerMethods().DrawPlots();
}
else
{
System.out.println("Could not open the database!");
}
}
public static void main(String args[])
{
MakeHostProfile r = new MakeHostProfile();
r.run(args);
}
}
Opening the VisIt GUI from Java¶
This program shows how to start the VisIt GUI from within your Java application.
By altering the arguments passed to the OpenClient() method, you could launch other VisIt clients too.
A VisIt client is a program that uses the ViewerProxy class to control the viewer.
Examples of VisIt clients are: VisIt’s GUI, VisIt’s Python interface (CLI), and any program that uses the VisIt Java interface.
The important part of this code is the call to the OpenClient() method.
The OpenClient method takes 3 arguments: clientName, clientProgram, clientArgs.
The clientName is the internal name that will be used to identify the client inside of VisIt.
You can pass any name that you want for this.
The clientProgram argument is a string that identifies the executable for your program.
The clientArgs argument lets you pass command line arguments to your program when it is started.
When you call OpenClient(), the VisIt viewer will attempt to launch the specified VisIt client and then the client will be attached to VisIt and can control the VisIt viewer.
Any number of VisIt clients can be connected to the VisIt viewer.
Show/Hide Code for OpenGUI
// Copyright (c) Lawrence Livermore National Security, LLC and other VisIt
// Project developers. See the top-level LICENSE file for dates and other
// details. No copyright assignment is required to contribute to VisIt.
import llnl.visit.ViewerProxy;
import java.util.Vector;
// ****************************************************************************
// Class: OpenGUI
//
// Purpose:
// This class implements an example program that shows how to use the
// ViewerProxy class and control VisIt's viewer from Java.
//
// Notes:
//
// Programmer: Brad Whitlock
// Creation: Mon Aug 17 13:40:40 PDT 2009
//
// Modifications:
//
// ****************************************************************************
public class OpenGUI extends RunViewer
{
public OpenGUI()
{
super();
}
protected void work(String[] args)
{
// Do a plot of the data.
String db = new String("globe.silo");
if(viewer.GetViewerMethods().OpenDatabase(viewer.GetDataPath() + db))
{
viewer.GetViewerMethods().AddPlot("Pseudocolor", "u");
viewer.GetViewerMethods().AddPlot("Mesh", "mesh1");
viewer.GetViewerMethods().DrawPlots();
}
else
{
System.out.println("Could not open the database!");
}
// Open the VisIt GUI.
String clientName = new String("GUI");
String clientProgram = new String("visit");
Vector clientArgs = new Vector();
clientArgs.add(new String("-gui"));
viewer.GetViewerMethods().OpenClient(clientName, clientProgram, clientArgs);
}
public static void main(String args[])
{
OpenGUI r = new OpenGUI();
r.run(args);
}
}
Determining which variables can be plotted¶
This program shows how to open a file and determine which plots can be used with the data from the file.
Each plot in VisIt responds to a certain set of variable types (scalar, vector, and so on). When you open a file, you get a list of variables in the metadata object. You must match up the variable types supported by a plot and the variables from the metadata in order to determine which plots can accept which variables from the database. This example program demonstrates a method for doing this comparison.
Note
The Java implementation does not offer a GetVariableTypes method in the plugin interface as it should.
This is an oversight that may be corrected in a future version of VisIt.
In the meantime, this program’s GetVariableTypes method can be used to fulfill the same purpose.
Show/Hide Code for PlotTypes
// Copyright (c) Lawrence Livermore National Security, LLC and other VisIt
// Project developers. See the top-level LICENSE file for dates and other
// details. No copyright assignment is required to contribute to VisIt.
import java.util.Hashtable;
import llnl.visit.avtDatabaseMetaData;
// ****************************************************************************
// Class: PlotTypes
//
// Purpose:
// This is an example program that shows how to determine which plots can
// accept variables from a file.
//
// Notes:
//
// Programmer: Brad Whitlock
// Creation: Fri Aug 28 09:21:06 PDT 2009
//
// Modifications:
//
// ****************************************************************************
public class PlotTypes extends RunViewer
{
public PlotTypes()
{
super();
savePlots = false;
}
public final static int MESH = 0x0001;
public final static int SCALAR = 0x0002;
public final static int MATERIAL = 0x0004;
public final static int VECTOR = 0x0008;
public final static int SUBSET = 0x0010;
public final static int SPECIES = 0x0020;
public final static int CURVE = 0x0040;
public final static int TENSOR = 0x0080;
public final static int SYMMETRICTENSOR = 0x0100;
public final static int LABEL = 0x0200;
public final static int ARRAY = 0x0400;
// The Plugin interface should have a GetVariableTypes method.
// For now, this will suffice.
public int GetVariableTypes(String plotName)
{
Hashtable namestovar = new Hashtable();
namestovar.put("Boundary", new Integer(MATERIAL));
namestovar.put("Contour", new Integer(SCALAR | SPECIES));
namestovar.put("Curve", new Integer(CURVE));
namestovar.put("FilledBoundary", new Integer(MATERIAL));
namestovar.put("Histogram", new Integer(SCALAR | ARRAY));
namestovar.put("Kerbel", new Integer(MESH));
namestovar.put("Label", new Integer(MESH | SCALAR | VECTOR | MATERIAL | SUBSET | TENSOR | SYMMETRICTENSOR | LABEL | ARRAY));
namestovar.put("Mesh", new Integer(MESH));
namestovar.put("Molecule", new Integer(SCALAR));
namestovar.put("MultiCurve", new Integer(CURVE));
namestovar.put("ParallelCoordinates", new Integer(0)); //SCALAR | ARRAY));
namestovar.put("Poincare", new Integer(VECTOR));
namestovar.put("Pseudocolor", new Integer(SCALAR | SPECIES));
namestovar.put("Scatter", new Integer(SCALAR));
namestovar.put("Spreadsheet", new Integer(SCALAR));
namestovar.put("Subset", new Integer(SUBSET | MESH));
namestovar.put("Surface", new Integer(SCALAR | SPECIES));
namestovar.put("Tensor", new Integer(TENSOR | SYMMETRICTENSOR));
namestovar.put("Topology", new Integer(SCALAR));
namestovar.put("Truecolor", new Integer(VECTOR));
namestovar.put("Vector", new Integer(VECTOR));
namestovar.put("Volume", new Integer(SCALAR | SPECIES));
namestovar.put("WellBore", new Integer(MESH));
return ((Integer)namestovar.get(plotName)).intValue();
}
protected void savePlot(String plotType, String var)
{
System.out.println(var);
if(savePlots)
{
viewer.GetViewerMethods().AddPlot(plotType, var);
viewer.GetViewerMethods().DrawPlots();
viewer.GetViewerMethods().ResetView();
viewer.GetViewerMethods().SaveWindow();
viewer.GetViewerMethods().DeleteActivePlots();
}
}
protected void work(String[] args)
{
System.out.println("Plots\n==================================================");
for(int i = 0; i < viewer.GetNumPlotPlugins(); ++i)
System.out.println("Plot "+i+": name="+viewer.GetPlotName(i)+", version="+viewer.GetPlotVersion(i));
System.out.println("Operators\n==================================================");
for(int i = 0; i < viewer.GetNumOperatorPlugins(); ++i)
System.out.println("Operator "+i+": name="+viewer.GetOperatorName(i)+", version="+viewer.GetOperatorVersion(i));
String db = new String(viewer.GetDataPath() + "noise.silo");
if(viewer.GetViewerMethods().RequestMetaData(db, 0))
{
if(savePlots)
viewer.GetViewerMethods().OpenDatabase(db);
avtDatabaseMetaData md = viewer.GetViewerState().GetDatabaseMetaData();
for(int i = 0; i < viewer.GetNumPlotPlugins(); ++i)
{
System.out.println("\n"+viewer.GetPlotName(i) + " can accept variables:\n=====================================");
int vartypes = GetVariableTypes(viewer.GetPlotName(i));
if((vartypes & MESH) > 0)
{
for(int j = 0; j < md.GetNumMeshes(); ++j)
savePlot(viewer.GetPlotName(i), md.GetMeshes(j).GetName());
}
if((vartypes & SCALAR) > 0)
{
for(int j = 0; j < md.GetNumScalars(); ++j)
savePlot(viewer.GetPlotName(i), md.GetScalars(j).GetName());
}
if((vartypes & MATERIAL) > 0)
{
for(int j = 0; j < md.GetNumMaterials(); ++j)
savePlot(viewer.GetPlotName(i), md.GetMaterials(j).GetName());
}
if((vartypes & VECTOR) > 0)
{
for(int j = 0; j < md.GetNumVectors(); ++j)
savePlot(viewer.GetPlotName(i), md.GetVectors(j).GetName());
}
if((vartypes & SPECIES) > 0)
{
for(int j = 0; j < md.GetNumSpecies(); ++j)
savePlot(viewer.GetPlotName(i), md.GetSpecies(j).GetName());
}
if((vartypes & CURVE) > 0)
{
for(int j = 0; j < md.GetNumCurves(); ++j)
savePlot(viewer.GetPlotName(i), md.GetCurves(j).GetName());
}
if((vartypes & TENSOR) > 0)
{
for(int j = 0; j < md.GetNumTensors(); ++j)
savePlot(viewer.GetPlotName(i), md.GetTensors(j).GetName());
}
if((vartypes & SYMMETRICTENSOR) > 0)
{
for(int j = 0; j < md.GetNumSymmTensors(); ++j)
savePlot(viewer.GetPlotName(i), md.GetSymmTensors(j).GetName());
}
if((vartypes & LABEL) > 0)
{
for(int j = 0; j < md.GetNumLabels(); ++j)
savePlot(viewer.GetPlotName(i), md.GetLabels(j).GetName());
}
if((vartypes & ARRAY) > 0)
{
for(int j = 0; j < md.GetNumArrays(); ++j)
savePlot(viewer.GetPlotName(i), md.GetArrays(j).GetName());
}
}
}
else
System.out.println("Could not open the database!");
}
public static void main(String args[])
{
PlotTypes r = new PlotTypes();
for(int i = 0; i < args.length; ++i)
{
if(args[i].equals("-plot"))
r.savePlots = true;
}
r.run(args);
}
private boolean savePlots;
}
Executing Python from Java¶
This code example shows how to create a Java program that launches VisIt’s Python CLI program and send Python command strings to it for interpretation. This example program also implements the SimpleObserver interface which lets us observe state objects. In this case, we observe the plot list and print it whenever we see it.
Show/Hide Code for DualClients
// Copyright (c) Lawrence Livermore National Security, LLC and other VisIt
// Project developers. See the top-level LICENSE file for dates and other
// details. No copyright assignment is required to contribute to VisIt.
import java.lang.ArrayIndexOutOfBoundsException;
import java.lang.String;
import java.util.Vector;
import llnl.visit.AttributeSubject;
import llnl.visit.ClientMethod;
import llnl.visit.ClientInformation;
import llnl.visit.ClientInformationList;
import llnl.visit.PlotList;
import llnl.visit.SimpleObserver;
// ****************************************************************************
// Class: DualClients
//
// Purpose:
// This example program shows how to launch the Python client from Java
// and send commands to it.
//
// Notes:
//
// Programmer: Brad Whitlock
// Creation: Tue Jan 11 09:30:41 PST 2011
//
// Modifications:
//
// ****************************************************************************
public class DualClients extends RunViewer implements SimpleObserver
{
public DualClients()
{
super();
doUpdate = true;
// Make this object observe the plot list
viewer.GetViewerState().GetPlotList().Attach(this);
}
//
// Main work method for the program
//
protected void work(String[] args)
{
// Try and open a database
if(viewer.GetViewerMethods().OpenDatabase(viewer.GetDataPath() + "noise.silo"))
{
// Interpret some Python using the VisIt CLI
InterpretPython("AddPlot('Pseudocolor', 'hardyglobal')");
InterpretPython("AddPlot('Mesh', 'Mesh')");
InterpretPython("DrawPlots()");
InterpretPython("SaveWindow()");
}
else
System.out.println("Could not open the database!");
}
//
// Check all of the client information until we find a client that
// supports the Interpret method with a string argument.
//
protected boolean NoInterpretingClient()
{
// Make a copy because the reader thread could be messing with it.
// Need to synchronize access.
ClientInformationList cL = new ClientInformationList(
viewer.GetViewerState().GetClientInformationList());
for(int i = 0; i < cL.GetNumClients(); ++i)
{
ClientInformation client = cL.GetClients(i);
for(int j = 0; j < client.GetMethodNames().size(); ++j)
{
String name = (String)client.GetMethodNames().elementAt(j);
if(name.equals("Interpret"))
{
String proto = (String)client.GetMethodPrototypes().elementAt(j);
if(proto.equals("s"))
{
// We have an interpreting client
return false;
}
}
}
}
return true;
}
//
// If we don't have a client that can "Interpret" then tell the viewer
// to launch a VisIt CLI.
//
protected boolean Initialize()
{
boolean launched = false;
if(NoInterpretingClient())
{
System.out.println("Tell the viewer to create a CLI so we can execute code.");
Vector args = new Vector();
args.addElement(new String("-cli"));
args.addElement(new String("-newconsole"));
viewer.GetViewerMethods().OpenClient("CLI",
"visit",
args);
launched = true;
viewer.Synchronize();
// HACK: Wait until we have an interpreting client.
while(NoInterpretingClient())
viewer.Synchronize();
}
return launched;
}
//
// Interpret a Python command string.
//
protected void InterpretPython(String cmd)
{
Initialize();
// Send the command to interpret as a client method.
ClientMethod method = viewer.GetViewerState().GetClientMethod();
method.SetIntArgs(new Vector());
method.SetDoubleArgs(new Vector());
Vector args = new Vector();
args.addElement(new String(cmd + "\n"));
method.SetStringArgs(args);
method.SetMethodName("Interpret");
method.Notify();
System.out.println("Interpret: " + cmd);
viewer.Synchronize();
}
//
// SimpleObserver interface methods
//
public void Update(AttributeSubject s)
{
// Do something with the plot list.
System.out.println(s.toString());
}
public void SetUpdate(boolean val) { doUpdate = val; }
public boolean GetUpdate() { return doUpdate; }
public static void main(String args[])
{
DualClients r = new DualClients();
r.run(args);
}
private boolean doUpdate;
}
Plotting vectors from Java¶
This example program shows how to create a vector expression and then plot a Vector plot of that expression. The Displace operator is also used to warp the coordinate system.
Show/Hide Code for PlotVector
// Copyright (c) Lawrence Livermore National Security, LLC and other VisIt
// Project developers. See the top-level LICENSE file for dates and other
// details. No copyright assignment is required to contribute to VisIt.
import llnl.visit.ViewerProxy;
import llnl.visit.Expression;
import llnl.visit.ExpressionList;
public class PlotVector extends RunViewer
{
public PlotVector()
{
super();
}
protected void work(String[] args)
{
if(viewer.GetViewerMethods().OpenDatabase(viewer.GetDataPath() + "globe.silo"))
{
ExpressionList explist = viewer.GetViewerState().GetExpressionList();
Expression e = new Expression();
e.SetName("disp");
e.SetType(Expression.EXPRTYPE_VECTORMESHVAR);
e.SetDefinition("{speed,u,v} - coord(mesh1)");
explist.AddExpressions(e);
explist.Notify();
viewer.GetViewerMethods().ProcessExpressions();
// Add a plot of the vector
viewer.GetViewerMethods().AddPlot("Vector", "disp");
viewer.GetViewerMethods().AddOperator("Displace");
viewer.GetViewerMethods().DrawPlots();
}
else
{
System.out.println("Could not open the database!");
}
}
public static void main(String args[])
{
PlotVector r = new PlotVector();
r.run(args);
}
}
Changing plot attributes¶
This example program shows how to set plot attributes. It changes a Pseudoocolor plot to be semi-transparent.
Show/Hide Code for PlotAtts
// Copyright (c) Lawrence Livermore National Security, LLC and other VisIt
// Project developers. See the top-level LICENSE file for dates and other
// details. No copyright assignment is required to contribute to VisIt.
import llnl.visit.View3DAttributes;
import llnl.visit.plots.PseudocolorAttributes;
// ****************************************************************************
// Class: PlotAtts
//
// Purpose:
// This is an example program that shows how to set plot attributes.
//
// Notes:
//
// Programmer: Brad Whitlock
// Creation: Thu Aug 15 16:09:03 PST 2002
//
// Modifications:
// Brad Whitlock, Tue Sep 24 08:05:51 PDT 2002
// I changed it so the view is set after the plot is drawn.
//
// Eric Brugger, Wed Aug 27 09:04:55 PDT 2003
// I modified it to use the new view interface.
//
// Brad Whitlock, Mon Jun 6 17:25:34 PST 2005
// I made it use GetDataPath to locate the data.
//
// Brad Whitlock, Thu Jul 14 12:15:42 PDT 2005
// Updated.
//
// Brad Whitlock, Mon Feb 25 11:07:24 PDT 2008
// Changed to new ViewerProxy interface.
//
// ****************************************************************************
public class PlotAtts extends RunViewer
{
public PlotAtts()
{
super();
}
protected void work(String[] args)
{
if(viewer.GetViewerMethods().OpenDatabase(viewer.GetDataPath() + "globe.silo"))
{
// Create a plot.
viewer.GetViewerMethods().AddPlot("Pseudocolor", "u");
// Set the pseudocolor attributes
PseudocolorAttributes p = (PseudocolorAttributes)viewer.GetPlotAttributes("Pseudocolor");
// set Pseudocolor's opacity type to constant
p.SetOpacityType(p.OPACITYTYPE_CONSTANT);
p.SetOpacity(0.3);
p.Notify();
viewer.GetViewerMethods().SetPlotOptions("Pseudocolor");
// Draw the plot
viewer.GetViewerMethods().DrawPlots();
// Set the view
View3DAttributes v = viewer.GetViewerState().GetView3DAttributes();
v.SetViewNormal(0.456808, 0.335583, 0.823839);
v.SetFocus(-0.927295, -1.22113, 1.01159);
v.SetViewUp(-0.184554, 0.941716, -0.281266);
v.SetParallelScale(15.7041);
v.SetNearPlane(-34.641);
v.SetFarPlane(34.641);
v.Notify();
viewer.GetViewerMethods().SetView3D();
}
else
System.out.println("Could not open the database!");
}
public static void main(String args[])
{
PlotAtts r = new PlotAtts();
r.run(args);
}
}
Changing points size and shape¶
This example program shows how to change point size/type for Point meshes.
Show/Hide Code for TryPointGlyphing
// Copyright (c) Lawrence Livermore National Security, LLC and other VisIt
// Project developers. See the top-level LICENSE file for dates and other
// details. No copyright assignment is required to contribute to VisIt.
import java.util.Vector;
import llnl.visit.ColorAttribute;
import llnl.visit.plots.MeshAttributes;
// ****************************************************************************
// Class: TryPointGlyphing
//
// Purpose:
// This example program sets up a Mesh plot of a point mesh and modifies
// the point size and shape (glyph) settings.
//
// Programmer: Kathleen Biagas
// Creation: March 31, 2017
//
// Modifications:
//
// ****************************************************************************
public class TryPointGlyphing extends RunViewer
{
public TryPointGlyphing()
{
super();
}
protected void work(String[] args)
{
// Try and open a database
if(viewer.GetViewerMethods().OpenDatabase(viewer.GetDataPath() + "noise.silo"))
{
viewer.GetViewerMethods().AddPlot("Mesh", "PointMesh");
viewer.GetViewerMethods().DrawPlots();
// Set the pseudocolor attributes
MeshAttributes m = (MeshAttributes)viewer.GetPlotAttributes("Mesh");
// Sets the size for 'Point' type
m.SetPointSizePixels(5);
// Sets the size for all other types
m.SetPointSize(1.0);
m.SetMeshColorSource(1);
m.SetMeshColor(new ColorAttribute(204,153,255,0));
// Run through all the point types
// 0 : Box
// 1 : Axis
// 2 : Icosahedron
// 3 : Octahedron
// 4 : Tetrahedron
// 5 : SphereGeometry
// 6 : Point
// 7 : Sphere
for (int i = 0; i < 8; ++i)
{
m.SetPointType(i);
m.Notify();
viewer.GetViewerMethods().SetPlotOptions("Mesh");
viewer.GetViewerMethods().SaveWindow();
}
}
else
System.out.println("Could not open the database!");
}
public static void main(String args[])
{
TryPointGlyphing r = new TryPointGlyphing();
r.run(args);
}
}
Using Threshold operator¶
This example program shows how to use a Threshold operator with a Pseudocolor plot.
ThresholdAttributes needs Vector to set ZonePortions, LowerBounds, and UpperBounds because more than one variable can be used with Threshold. If more than one variable is requested (not demonstrated in this example), the first entry in the Vector contains information for the first variable, second entry contains information for the second variable and so on.
Show/Hide Code for TryThreshold
// Copyright (c) Lawrence Livermore National Security, LLC and other VisIt
// Project developers. See the top-level LICENSE file for dates and other
// details. No copyright assignment is required to contribute to VisIt.
import java.util.Vector;
import llnl.visit.AttributeSubject;
import llnl.visit.View3DAttributes;
import llnl.visit.plots.PseudocolorAttributes;
import llnl.visit.operators.ThresholdAttributes;
// ****************************************************************************
// Class: TryThreshold
//
// Purpose:
// This example program sets up a Pseudocolor plot with threshold operator.
//
// Notes: Based on threshold.py of test-suite.
//
// Programmer: Kathleen Biagas
// Creation: March 31, 2017
//
// Modifications:
//
// ****************************************************************************
public class TryThreshold extends RunViewer
{
public TryThreshold()
{
super();
}
protected void work(String[] args)
{
// Try and open a database
if(viewer.GetViewerMethods().OpenDatabase(viewer.GetDataPath() + "globe.silo"))
{
viewer.GetViewerMethods().AddPlot("Pseudocolor", "u");
viewer.GetViewerMethods().AddOperator("Threshold");
// Set the pseudocolor attributes
ThresholdAttributes t = (ThresholdAttributes)viewer.GetOperatorAttributes("Threshold");
t.SetOutputMeshType(0);
Vector zp = new Vector();
zp.add(1);
t.SetZonePortions(zp);
Vector lb = new Vector();
lb.add(-4.0);
t.SetLowerBounds(lb);
Vector ub = new Vector();
ub.add(4.0);
t.SetUpperBounds(ub);
t.Notify();
viewer.GetViewerMethods().SetOperatorOptions("Threshold");
viewer.GetViewerMethods().DrawPlots();
// Set the view
View3DAttributes v = viewer.GetViewerState().GetView3DAttributes();
v.SetViewNormal(-0.528889, 0.367702, 0.7649);
v.SetViewUp(0.176641, 0.929226, -0.324558);
v.SetParallelScale(17.3205);
v.SetPerspective(true);
v.Notify();
viewer.GetViewerMethods().SetView3D();
viewer.GetViewerMethods().SaveWindow();
// Change zone inclusion criteria
zp.set(0, 0);
t.SetZonePortions(zp);
t.Notify();
viewer.GetViewerMethods().SetOperatorOptions("Threshold");
viewer.GetViewerMethods().SaveWindow();
// Threshold by a variable different than the PC coloring variable.
zp.set(0, 1);
t.SetZonePortions(zp);
lb.set(0, 140.0);
t.SetLowerBounds(lb);
ub.set(0, 340.0);
t.SetUpperBounds(ub);
Vector vn = new Vector();
vn.add("t");
t.SetListedVarNames(vn);
t.Notify();
viewer.GetViewerMethods().SetOperatorOptions("Threshold");
viewer.GetViewerMethods().SaveWindow();
}
else
System.out.println("Could not open the database!");
}
public static void main(String args[])
{
TryThreshold r = new TryThreshold();
r.run(args);
}
}
Acknowledgements¶
This document is primarily based on visitusers.org wiki pages written by Brad Whitlock. The Java client itself and most of the examples were also initially created by Brad in 2002.