Commit d13e0ae9 authored by whitlocb's avatar whitlocb

Improved Java API and documented it some.


git-svn-id: http://visit.ilight.com/svn/visit/trunk/src@3341 18c085ea-50e0-402c-830e-de6fd14e8384
parent c8241e78
......@@ -48,7 +48,7 @@ package llnl.visit;
// Notes: Autogenerated by xml2java.
//
// Programmer: xml2java
// Creation: Wed Mar 14 17:54:39 PST 2007
// Creation: Mon Feb 25 15:14:55 PST 2008
//
// Modifications:
//
......@@ -145,6 +145,22 @@ public class AnimationAttributes extends AttributeSubject
}
}
public String toString(String indent)
{
String str = new String();
str = str + boolToString("pipelineCachingMode", pipelineCachingMode, indent) + "\n";
str = str + intToString("timeout", timeout, indent) + "\n";
str = str + indent + "playbackMode = ";
if(playbackMode == PLAYBACKMODE_LOOPING)
str = str + "PLAYBACKMODE_LOOPING";
if(playbackMode == PLAYBACKMODE_PLAYONCE)
str = str + "PLAYBACKMODE_PLAYONCE";
if(playbackMode == PLAYBACKMODE_SWING)
str = str + "PLAYBACKMODE_SWING";
str = str + "\n";
return str;
}
// Attributes
private boolean pipelineCachingMode;
......
......@@ -48,7 +48,7 @@ package llnl.visit;
// Notes: Autogenerated by xml2java.
//
// Programmer: xml2java
// Creation: Fri Jan 25 16:54:21 PST 2008
// Creation: Mon Feb 25 15:14:55 PST 2008
//
// Modifications:
//
......@@ -376,6 +376,60 @@ public class AnnotationAttributes extends AttributeSubject
}
}
public String toString(String indent)
{
String str = new String();
str = str + indent + "axes2D = {\n" + axes2D.toString(indent + " ") + indent + "}\n";
str = str + indent + "axes3D = {\n" + axes3D.toString(indent + " ") + indent + "}\n";
str = str + boolToString("userInfoFlag", userInfoFlag, indent) + "\n";
str = str + indent + "userInfoFont = {\n" + userInfoFont.toString(indent + " ") + indent + "}\n";
str = str + boolToString("databaseInfoFlag", databaseInfoFlag, indent) + "\n";
str = str + indent + "databaseInfoFont = {\n" + databaseInfoFont.toString(indent + " ") + indent + "}\n";
str = str + indent + "databaseInfoExpansionMode = ";
if(databaseInfoExpansionMode == PATHEXPANSIONMODE_FILE)
str = str + "PATHEXPANSIONMODE_FILE";
if(databaseInfoExpansionMode == PATHEXPANSIONMODE_DIRECTORY)
str = str + "PATHEXPANSIONMODE_DIRECTORY";
if(databaseInfoExpansionMode == PATHEXPANSIONMODE_FULL)
str = str + "PATHEXPANSIONMODE_FULL";
if(databaseInfoExpansionMode == PATHEXPANSIONMODE_SMART)
str = str + "PATHEXPANSIONMODE_SMART";
if(databaseInfoExpansionMode == PATHEXPANSIONMODE_SMARTDIRECTORY)
str = str + "PATHEXPANSIONMODE_SMARTDIRECTORY";
str = str + "\n";
str = str + boolToString("legendInfoFlag", legendInfoFlag, indent) + "\n";
str = str + indent + "backgroundColor = {" + backgroundColor.Red() + ", " + backgroundColor.Green() + ", " + backgroundColor.Blue() + ", " + backgroundColor.Alpha() + "}\n";
str = str + indent + "foregroundColor = {" + foregroundColor.Red() + ", " + foregroundColor.Green() + ", " + foregroundColor.Blue() + ", " + foregroundColor.Alpha() + "}\n";
str = str + indent + "gradientBackgroundStyle = ";
if(gradientBackgroundStyle == GRADIENTSTYLE_TOPTOBOTTOM)
str = str + "GRADIENTSTYLE_TOPTOBOTTOM";
if(gradientBackgroundStyle == GRADIENTSTYLE_BOTTOMTOTOP)
str = str + "GRADIENTSTYLE_BOTTOMTOTOP";
if(gradientBackgroundStyle == GRADIENTSTYLE_LEFTTORIGHT)
str = str + "GRADIENTSTYLE_LEFTTORIGHT";
if(gradientBackgroundStyle == GRADIENTSTYLE_RIGHTTOLEFT)
str = str + "GRADIENTSTYLE_RIGHTTOLEFT";
if(gradientBackgroundStyle == GRADIENTSTYLE_RADIAL)
str = str + "GRADIENTSTYLE_RADIAL";
str = str + "\n";
str = str + indent + "gradientColor1 = {" + gradientColor1.Red() + ", " + gradientColor1.Green() + ", " + gradientColor1.Blue() + ", " + gradientColor1.Alpha() + "}\n";
str = str + indent + "gradientColor2 = {" + gradientColor2.Red() + ", " + gradientColor2.Green() + ", " + gradientColor2.Blue() + ", " + gradientColor2.Alpha() + "}\n";
str = str + indent + "backgroundMode = ";
if(backgroundMode == BACKGROUNDMODE_SOLID)
str = str + "BACKGROUNDMODE_SOLID";
if(backgroundMode == BACKGROUNDMODE_GRADIENT)
str = str + "BACKGROUNDMODE_GRADIENT";
if(backgroundMode == BACKGROUNDMODE_IMAGE)
str = str + "BACKGROUNDMODE_IMAGE";
if(backgroundMode == BACKGROUNDMODE_IMAGESPHERE)
str = str + "BACKGROUNDMODE_IMAGESPHERE";
str = str + "\n";
str = str + stringToString("backgroundImage", backgroundImage, indent) + "\n";
str = str + intToString("imageRepeatX", imageRepeatX, indent) + "\n";
str = str + intToString("imageRepeatY", imageRepeatY, indent) + "\n";
return str;
}
// Attributes
private Axes2D axes2D;
......
......@@ -49,7 +49,7 @@ import java.util.Vector;
// Notes: Autogenerated by xml2java.
//
// Programmer: xml2java
// Creation: Tue Jan 15 14:07:42 PST 2008
// Creation: Mon Feb 25 15:14:55 PST 2008
//
// Modifications:
//
......@@ -421,6 +421,57 @@ public class AnnotationObject extends AttributeSubject
}
}
public String toString(String indent)
{
String str = new String();
str = str + stringToString("objectName", objectName, indent) + "\n";
str = str + indent + "objectType = ";
if(objectType == ANNOTATIONTYPE_TEXT2D)
str = str + "ANNOTATIONTYPE_TEXT2D";
if(objectType == ANNOTATIONTYPE_TEXT3D)
str = str + "ANNOTATIONTYPE_TEXT3D";
if(objectType == ANNOTATIONTYPE_TIMESLIDER)
str = str + "ANNOTATIONTYPE_TIMESLIDER";
if(objectType == ANNOTATIONTYPE_LINE2D)
str = str + "ANNOTATIONTYPE_LINE2D";
if(objectType == ANNOTATIONTYPE_ARROW2D)
str = str + "ANNOTATIONTYPE_ARROW2D";
if(objectType == ANNOTATIONTYPE_ARROW3D)
str = str + "ANNOTATIONTYPE_ARROW3D";
if(objectType == ANNOTATIONTYPE_BOX)
str = str + "ANNOTATIONTYPE_BOX";
if(objectType == ANNOTATIONTYPE_IMAGE)
str = str + "ANNOTATIONTYPE_IMAGE";
if(objectType == ANNOTATIONTYPE_LEGENDATTRIBUTES)
str = str + "ANNOTATIONTYPE_LEGENDATTRIBUTES";
if(objectType == ANNOTATIONTYPE_MAXANNOTATIONTYPE)
str = str + "ANNOTATIONTYPE_MAXANNOTATIONTYPE";
str = str + "\n";
str = str + boolToString("visible", visible, indent) + "\n";
str = str + boolToString("active", active, indent) + "\n";
str = str + doubleArrayToString("position", position, indent) + "\n";
str = str + doubleArrayToString("position2", position2, indent) + "\n";
str = str + indent + "textColor = {" + textColor.Red() + ", " + textColor.Green() + ", " + textColor.Blue() + ", " + textColor.Alpha() + "}\n";
str = str + boolToString("useForegroundForTextColor", useForegroundForTextColor, indent) + "\n";
str = str + indent + "color1 = {" + color1.Red() + ", " + color1.Green() + ", " + color1.Blue() + ", " + color1.Alpha() + "}\n";
str = str + indent + "color2 = {" + color2.Red() + ", " + color2.Green() + ", " + color2.Blue() + ", " + color2.Alpha() + "}\n";
str = str + stringVectorToString("text", text, indent) + "\n";
str = str + indent + "fontFamily = ";
if(fontFamily == FONTFAMILY_ARIAL)
str = str + "FONTFAMILY_ARIAL";
if(fontFamily == FONTFAMILY_COURIER)
str = str + "FONTFAMILY_COURIER";
if(fontFamily == FONTFAMILY_TIMES)
str = str + "FONTFAMILY_TIMES";
str = str + "\n";
str = str + boolToString("fontBold", fontBold, indent) + "\n";
str = str + boolToString("fontItalic", fontItalic, indent) + "\n";
str = str + boolToString("fontShadow", fontShadow, indent) + "\n";
str = str + doubleToString("doubleAttribute1", doubleAttribute1, indent) + "\n";
str = str + intToString("intAttribute1", intAttribute1, indent) + "\n";
return str;
}
// Attributes
private String objectName;
......
......@@ -49,7 +49,7 @@ import java.util.Vector;
// Notes: Autogenerated by xml2java.
//
// Programmer: xml2java
// Creation: Tue Mar 20 09:28:42 PDT 2007
// Creation: Mon Feb 25 15:14:55 PST 2008
//
// Modifications:
//
......@@ -133,6 +133,22 @@ public class AnnotationObjectList extends AttributeSubject
Select(0);
}
public String toString(String indent)
{
String str = new String();
str = str + indent + "annotation = {\n";
for(int i = 0; i < annotation.size(); ++i)
{
AttributeSubject s = (AttributeSubject)annotation.elementAt(i);
str = str + s.toString(indent + " ");
if(i < annotation.size()-1)
str = str + ", ";
str = str + "\n";
}
str = str + "}\n";
return str;
}
// Attributegroup convenience methods
public void AddAnnotation(AnnotationObject obj)
{
......
......@@ -48,7 +48,7 @@ package llnl.visit;
// Notes: Autogenerated by xml2java.
//
// Programmer: xml2java
// Creation: Tue Jan 15 14:07:42 PST 2008
// Creation: Mon Feb 25 15:14:55 PST 2008
//
// Modifications:
//
......@@ -169,6 +169,17 @@ public class AppearanceAttributes extends AttributeSubject
}
}
public String toString(String indent)
{
String str = new String();
str = str + stringToString("background", background, indent) + "\n";
str = str + stringToString("foreground", foreground, indent) + "\n";
str = str + stringToString("fontName", fontName, indent) + "\n";
str = str + stringToString("style", style, indent) + "\n";
str = str + intToString("orientation", orientation, indent) + "\n";
return str;
}
// Attributes
private String background;
......
This diff is collapsed.
......@@ -48,7 +48,7 @@ package llnl.visit;
// Notes: Autogenerated by xml2java.
//
// Programmer: xml2java
// Creation: Fri Jan 25 16:52:22 PST 2008
// Creation: Mon Feb 25 15:14:55 PST 2008
//
// Modifications:
//
......@@ -228,6 +228,38 @@ public class Axes2D extends AttributeSubject
}
}
public String toString(String indent)
{
String str = new String();
str = str + boolToString("visible", visible, indent) + "\n";
str = str + boolToString("autoSetTicks", autoSetTicks, indent) + "\n";
str = str + boolToString("autoSetScaling", autoSetScaling, indent) + "\n";
str = str + intToString("lineWidth", lineWidth, indent) + "\n";
str = str + indent + "tickLocation = ";
if(tickLocation == LOCATION_INSIDE)
str = str + "LOCATION_INSIDE";
if(tickLocation == LOCATION_OUTSIDE)
str = str + "LOCATION_OUTSIDE";
if(tickLocation == LOCATION_BOTH)
str = str + "LOCATION_BOTH";
str = str + "\n";
str = str + indent + "tickAxes = ";
if(tickAxes == TICKS_OFF)
str = str + "TICKS_OFF";
if(tickAxes == TICKS_BOTTOM)
str = str + "TICKS_BOTTOM";
if(tickAxes == TICKS_LEFT)
str = str + "TICKS_LEFT";
if(tickAxes == TICKS_BOTTOMLEFT)
str = str + "TICKS_BOTTOMLEFT";
if(tickAxes == TICKS_ALL)
str = str + "TICKS_ALL";
str = str + "\n";
str = str + indent + "xAxis = {\n" + xAxis.toString(indent + " ") + indent + "}\n";
str = str + indent + "yAxis = {\n" + yAxis.toString(indent + " ") + indent + "}\n";
return str;
}
// Attributes
private boolean visible;
......
......@@ -48,7 +48,7 @@ package llnl.visit;
// Notes: Autogenerated by xml2java.
//
// Programmer: xml2java
// Creation: Fri Jan 25 16:52:23 PST 2008
// Creation: Mon Feb 25 15:14:55 PST 2008
//
// Modifications:
//
......@@ -76,7 +76,7 @@ public class Axes3D extends AttributeSubject
autoSetTicks = true;
autoSetScaling = true;
lineWidth = 0;
tickLocation = LOCATION_OUTSIDE;
tickLocation = LOCATION_INSIDE;
axesType = AXES_CLOSESTTRIAD;
triadFlag = true;
bboxFlag = true;
......@@ -274,6 +274,41 @@ public class Axes3D extends AttributeSubject
}
}
public String toString(String indent)
{
String str = new String();
str = str + boolToString("visible", visible, indent) + "\n";
str = str + boolToString("autoSetTicks", autoSetTicks, indent) + "\n";
str = str + boolToString("autoSetScaling", autoSetScaling, indent) + "\n";
str = str + intToString("lineWidth", lineWidth, indent) + "\n";
str = str + indent + "tickLocation = ";
if(tickLocation == LOCATION_INSIDE)
str = str + "LOCATION_INSIDE";
if(tickLocation == LOCATION_OUTSIDE)
str = str + "LOCATION_OUTSIDE";
if(tickLocation == LOCATION_BOTH)
str = str + "LOCATION_BOTH";
str = str + "\n";
str = str + indent + "axesType = ";
if(axesType == AXES_CLOSESTTRIAD)
str = str + "AXES_CLOSESTTRIAD";
if(axesType == AXES_FURTHESTTRIAD)
str = str + "AXES_FURTHESTTRIAD";
if(axesType == AXES_OUTSIDEEDGES)
str = str + "AXES_OUTSIDEEDGES";
if(axesType == AXES_STATICTRIAD)
str = str + "AXES_STATICTRIAD";
if(axesType == AXES_STATICEDGES)
str = str + "AXES_STATICEDGES";
str = str + "\n";
str = str + boolToString("triadFlag", triadFlag, indent) + "\n";
str = str + boolToString("bboxFlag", bboxFlag, indent) + "\n";
str = str + indent + "xAxis = {\n" + xAxis.toString(indent + " ") + indent + "}\n";
str = str + indent + "yAxis = {\n" + yAxis.toString(indent + " ") + indent + "}\n";
str = str + indent + "zAxis = {\n" + zAxis.toString(indent + " ") + indent + "}\n";
return str;
}
// Attributes
private boolean visible;
......
......@@ -48,7 +48,7 @@ package llnl.visit;
// Notes: Autogenerated by xml2java.
//
// Programmer: xml2java
// Creation: Fri Jan 25 16:52:23 PST 2008
// Creation: Mon Feb 25 15:14:55 PST 2008
//
// Modifications:
//
......@@ -157,6 +157,16 @@ public class AxisAttributes extends AttributeSubject
}
}
public String toString(String indent)
{
String str = new String();
str = str + indent + "title = {\n" + title.toString(indent + " ") + indent + "}\n";
str = str + indent + "label = {\n" + label.toString(indent + " ") + indent + "}\n";
str = str + indent + "tickMarks = {\n" + tickMarks.toString(indent + " ") + indent + "}\n";
str = str + boolToString("grid", grid, indent) + "\n";
return str;
}
// Attributes
private AxisTitles title;
......
......@@ -48,7 +48,7 @@ package llnl.visit;
// Notes: Autogenerated by xml2java.
//
// Programmer: xml2java
// Creation: Fri Jan 25 16:52:24 PST 2008
// Creation: Mon Feb 25 15:14:55 PST 2008
//
// Modifications:
//
......@@ -140,6 +140,15 @@ public class AxisLabels extends AttributeSubject
}
}
public String toString(String indent)
{
String str = new String();
str = str + boolToString("visible", visible, indent) + "\n";
str = str + indent + "font = {\n" + font.toString(indent + " ") + indent + "}\n";
str = str + intToString("scaling", scaling, indent) + "\n";
return str;
}
// Attributes
private boolean visible;
......
......@@ -48,7 +48,7 @@ package llnl.visit;
// Notes: Autogenerated by xml2java.
//
// Programmer: xml2java
// Creation: Tue Jan 29 14:50:00 PST 2008
// Creation: Mon Feb 25 15:14:55 PST 2008
//
// Modifications:
//
......@@ -169,6 +169,17 @@ public class AxisTickMarks extends AttributeSubject
}
}
public String toString(String indent)
{
String str = new String();
str = str + boolToString("visible", visible, indent) + "\n";
str = str + doubleToString("majorMinimum", majorMinimum, indent) + "\n";
str = str + doubleToString("majorMaximum", majorMaximum, indent) + "\n";
str = str + doubleToString("minorSpacing", minorSpacing, indent) + "\n";
str = str + doubleToString("majorSpacing", majorSpacing, indent) + "\n";
return str;
}
// Attributes
private boolean visible;
......
......@@ -48,7 +48,7 @@ package llnl.visit;
// Notes: Autogenerated by xml2java.
//
// Programmer: xml2java
// Creation: Mon Jan 28 14:09:56 PST 2008
// Creation: Mon Feb 25 15:14:55 PST 2008
//
// Modifications:
//
......@@ -185,6 +185,18 @@ public class AxisTitles extends AttributeSubject
}
}
public String toString(String indent)
{
String str = new String();
str = str + boolToString("visible", visible, indent) + "\n";
str = str + indent + "font = {\n" + font.toString(indent + " ") + indent + "}\n";
str = str + boolToString("userTitle", userTitle, indent) + "\n";
str = str + boolToString("userUnits", userUnits, indent) + "\n";
str = str + stringToString("title", title, indent) + "\n";
str = str + stringToString("units", units, indent) + "\n";
return str;
}
// Attributes
private boolean visible;
......
......@@ -48,7 +48,7 @@ package llnl.visit;
// Notes: Autogenerated by xml2java.
//
// Programmer: xml2java
// Creation: Wed Mar 14 17:54:41 PST 2007
// Creation: Mon Feb 25 15:14:55 PST 2008
//
// Modifications:
//
......@@ -120,6 +120,13 @@ public class BoxExtents extends AttributeSubject
SetExtents(buf.ReadDoubleArray());
}
public String toString(String indent)
{
String str = new String();
str = str + doubleArrayToString("extents", extents, indent) + "\n";
return str;
}
// Attributes
private double[] extents;
......
......@@ -49,7 +49,7 @@ import java.util.Vector;
// Notes: Autogenerated by xml2java.
//
// Programmer: xml2java
// Creation: Wed Mar 14 17:54:42 PST 2007
// Creation: Mon Feb 25 15:14:55 PST 2008
//
// Modifications:
//
......@@ -150,6 +150,15 @@ public class ClientInformation extends AttributeSubject
}
}
public String toString(String indent)
{
String str = new String();
str = str + stringToString("clientName", clientName, indent) + "\n";
str = str + stringVectorToString("methodNames", methodNames, indent) + "\n";
str = str + stringVectorToString("methodPrototypes", methodPrototypes, indent) + "\n";
return str;
}
// Attributes
private String clientName;
......
......@@ -49,7 +49,7 @@ import java.util.Vector;
// Notes: Autogenerated by xml2java.
//
// Programmer: xml2java
// Creation: Wed Mar 14 17:54:42 PST 2007
// Creation: Mon Feb 25 15:14:55 PST 2008
//
// Modifications:
//
......@@ -133,6 +133,22 @@ public class ClientInformationList extends AttributeSubject
Select(0);
}
public String toString(String indent)
{
String str = new String();
str = str + indent + "clients = {\n";
for(int i = 0; i < clients.size(); ++i)
{
AttributeSubject s = (AttributeSubject)clients.elementAt(i);
str = str + s.toString(indent + " ");
if(i < clients.size()-1)
str = str + ", ";
str = str + "\n";
}
str = str + "}\n";
return str;
}
// Attributegroup convenience methods
public void AddClients(ClientInformation obj)
{
......
......@@ -51,7 +51,7 @@ import java.lang.Double;
// Notes: Autogenerated by xml2java.
//
// Programmer: xml2java
// Creation: Wed Mar 14 17:54:43 PST 2007
// Creation: Mon Feb 25 15:14:55 PST 2008
//
// Modifications:
//
......@@ -175,6 +175,16 @@ public class ClientMethod extends AttributeSubject
}
}
public String toString(String indent)
{
String str = new String();
str = str + stringToString("methodName", methodName, indent) + "\n";
str = str + intVectorToString("intArgs", intArgs, indent) + "\n";
str = str + doubleVectorToString("doubleArgs", doubleArgs, indent) + "\n";
str = str + stringVectorToString("stringArgs", stringArgs, indent) + "\n";
return str;
}
// Attributes
private String methodName;
......
......@@ -49,7 +49,7 @@ import java.util.Vector;
// Notes: Autogenerated by xml2java.
//
// Programmer: xml2java
// Creation: Wed Mar 14 17:54:44 PST 2007
// Creation: Mon Feb 25 15:14:55 PST 2008
//
// Modifications:
//
......@@ -133,6 +133,22 @@ public class ColorAttributeList extends AttributeSubject
Select(0);
}
public String toString(String indent)
{
String str = new String();
str = str + indent + "colors = {\n";
for(int i = 0; i < colors.size(); ++i)
{
AttributeSubject s = (AttributeSubject)colors.elementAt(i);
str = str + s.toString(indent + " ");
if(i < colors.size()-1)
str = str + ", ";
str = str + "\n";
}
str = str + "}\n";
return str;
}
// Attributegroup convenience methods
public void AddColors(ColorAttribute obj)
{
......
......@@ -51,7 +51,9 @@ package llnl.visit;
// Creation: Mon Aug 12 12:17:09 PDT 2002
//
// Modifications:
//
// Brad Whitlock, Mon Feb 25 15:20:00 PST 2008
// Added toString implementation.
//
// ****************************************************************************
public class ColorControlPoint extends AttributeSubject
......@@ -165,6 +167,13 @@ public class ColorControlPoint extends AttributeSubject
}
}
public String toString(String indent)
{
String str = new String();
str = str + intArrayToString("colors", colors, indent) + "\n";
str = str + floatToString("position", position, indent) + "\n";
return str;
}
// Attributes
private int[] colors;
......
......@@ -49,7 +49,7 @@ import java.util.Vector;
// Notes: Autogenerated by xml2java.
//
// Programmer: xml2java
// Creation: Wed Mar 14 17:54:45 PST 2007
// Creation: Mon Feb 25 15:14:55 PST 2008
//
// Modifications:
//
......@@ -201,6 +201,26 @@ public class ColorControlPointList extends AttributeSubject
}
}
public String toString(String indent)
{
String str = new String();
str = str + indent + "controlPoints = {\n";
for(int i = 0; i < controlPoints.size(); ++i)
{
AttributeSubject s = (AttributeSubject)controlPoints.elementAt(i);
str = str + s.toString(indent + " ");
if(i < controlPoints.size()-1)
str = str + ", ";
str = str + "\n";
}
str = str + "}\n";
str = str + boolToString("smoothingFlag", smoothingFlag, indent) + "\n";
str = str + boolToString("equalSpacingFlag", equalSpacingFlag, indent) + "\n";
str = str + boolToString("discreteFlag", discreteFlag, indent) + "\n";
str = str + boolToString("externalFlag", externalFlag, indent) + "\n";
return str;
}
// Attributegroup convenience methods
public void AddControlPoints(ColorControlPoint obj)
{
......
......@@ -192,6 +192,25 @@ public class ColorTableAttributes extends AttributeSubject