llnl.visit
Class ViewerMethods

java.lang.Object
  extended by llnl.visit.ViewerMethods

public class ViewerMethods
extends java.lang.Object

ViewerMethods contains all of the methods that are mapped into VieweRPC requests, which control VisIt's viewer. The order of methods matches the order of methods in ViewerMethods.C, the C++ implementation so it will be easier to reconcile the two implementations during future maintenance.


Constructor Summary
ViewerMethods(ProxyInterface p)
          Constructor for the ViewerMethods class.
 
Method Summary
 boolean ActivateDatabase(java.lang.String database)
          Makes the named database be the active database, which is the database that can be used to create plots and is the database whose variables are shown in the plot menus.
 boolean AddAnnotationObject(int annotType, java.lang.String annotName)
          Create a new annotation object and add it to the visualization.
 boolean AddInitializedOperator(int oper)
          Adds an operator to the active plots.
 boolean AddOperator(int oper)
          Adds an operator to the active plots.
 boolean AddOperator(int oper, boolean fromDefault)
          Adds an operator to the active plots.
 boolean AddOperator(java.lang.String type)
          Adds an operator to the active plots.
 boolean AddPlot(int type, java.lang.String var)
          Adds a new plot.
 boolean AddPlot(java.lang.String plotName, java.lang.String var)
          Adds a new plot.
 boolean AddWindow()
          Adds a new visualization window
 boolean AlterDatabaseCorrelation(java.lang.String name, java.util.Vector dbs, int method, int nStates)
          Alters an existing database correlation.
 boolean AnimationPlay()
          Animate through the time states for the visualization of a time-varying database.
 boolean AnimationReversePlay()
          Animate through the time states for the visualization of a time-varying database in reverse order.
 boolean AnimationSetNFrames(int nFrames)
          Sets the number of animation frames for a keyframe animation.
 boolean AnimationStop()
          Stop animation.
 boolean ApplyNamedSelection(java.lang.String selName)
          Applies a named selection to the active plots.
 boolean ChangeActivePlotsVar(java.lang.String var)
          Changes the plotted variable for the active plots.
 boolean CheckForNewStates(java.lang.String database)
          If the database is a virtual database (collection of single related files that have been grouped into a time-varying database) then this method checks to see if there are any new files that need to be added to the database.
 boolean ChooseCenterOfRotation()
          Lets the user interactively choose a center of rotation using pick.
 boolean ChooseCenterOfRotation(double sx, double sy)
          Sets the center of rotation as the 3D point that is under the 2D screen coordinate that specifies a location within the visualization window.
 boolean ClearAllWindows()
          Clear the plots in all visualization windows.
 boolean ClearCache(java.lang.String hostName, java.lang.String simName)
          Tell VisIt to clear its cache for the compute engine on the specified host.
 boolean ClearCacheForAllEngines()
          Tell VisIt to clear its cache for all compute engines.
 boolean ClearPickPoints()
          Clear all pick points from the visualization window.
 boolean ClearReferenceLines()
          Clear all reference lines from the visualization window.
 boolean ClearViewKeyframes()
           
 boolean ClearWindow(boolean clearAllPlots)
          Clear the plots from a visualization window.
 boolean CloneWindow()
          Adds a new visualization window, copying all settings and plots from the currently active visualization window.
 boolean Close()
          Tells the viewer to close.
 boolean CloseComputeEngine(java.lang.String hostName, java.lang.String simName)
          Tells VisIt's viewer to close the compute engine on the specified host.
 boolean CloseDatabase(java.lang.String database)
          Closes the named database -- if it is not being used.
 boolean ConnectToMetaDataServer(java.lang.String hostName, java.util.Vector args)
          Tells the viewer to tell the metadata server to connect back to this client.
 boolean ConstructDataBinning()
          Tell VisIt to construct a data binning, which is often a statistical variable derived from your data after binning.
 boolean CopyActivePlots()
          Creates identical copies of the active plots and puts them into the new state so their plot attributes can be changed.
 boolean CopyAnnotationsToWindow(int from, int to)
          Copies the annotations from one visualization window to another.
 boolean CopyLightingToWindow(int from, int to)
          Copies the lighting from one visualization window to another.
 boolean CopyPlotsToWindow(int from, int to)
          Copies the plots from one visualization window to another.
 boolean CopyViewToWindow(int from, int to)
          Copies the view from one visualization window to another.
 boolean CreateDatabaseCorrelation(java.lang.String name, java.util.Vector dbs, int method, int nStates)
          Create a database correlation, which is a mapping that relates several time-varying databases so they can be controlled by a single time slider.
 boolean CreateNamedSelection(java.lang.String selName)
          Creates a named selection based on the active plots.
 boolean CreateNamedSelection(java.lang.String selName, SelectionProperties props, boolean useCurrentPlot)
          Creates a named selection based on the active plots.
 boolean DeIconifyAllWindows()
          Brings all viewer windows back from an iconified state.
 boolean DeleteActiveAnnotationObjects()
          Deletes the selected annotation objects.
 boolean DeleteActivePlots()
          Deletes the active plots, freeing all of their data, and removing them from the plot list.
 boolean DeleteColorTable(java.lang.String colorTableName)
          Delete the named color table.
 boolean DeleteDatabaseCorrelation(java.lang.String name)
          Deletes an existing database correlation.
 boolean DeleteNamedSelection(java.lang.String selName)
          Deletes a named selection.
 boolean DeletePlotDatabaseKeyframe(int plotId, int frame)
           
 boolean DeletePlotKeyframe(int plotId, int frame)
           
 boolean DeleteViewKeyframe(int frame)
           
 boolean DeleteWindow()
          Tells the viewer to close the active visualization window and delete it.
 boolean DemoteOperator(int operatorId)
          Demotes an operator within the list of operators applied to the active plots.
 boolean Detach()
          Tells the viewer to detach this client.
 boolean DisableRedraw()
          Disables the viewer's ability to redraw its plots when you make changes.
 boolean DrawPlots()
          Causes VisIt to process any plots that are new or in the error state so they get computed in the compute engine and shown in the visualization window.
 boolean DrawPlots(boolean drawAllPlots)
          Causes VisIt to process any plots that are new or in the error state so they get computed in the compute engine and shown in the visualization window.
 boolean EnableTool(int tool, boolean enabled)
          Enables or disables an interactive tool in the active visualization window.
 boolean ExportColorTable(java.lang.String colorTableName)
          Exports the specified color table to a file in the user's .visit directory.
 boolean ExportDatabase()
          Tell the viewer to export the data for the current plot as a database file.
 boolean ExportEntireState(java.lang.String filename)
          Saves a session file containing all of the default settings for the viewer as well as all information needed to recreate the plots in all visualization windows in future VisIt sessions.
 boolean GetQueryParams(java.lang.String queryName)
          Tell the viewer to retrieve the default parameters for the named query.
 boolean HideActiveAnnotationObjects()
          Hides the selected annotation objects.
 boolean HideActivePlots()
          Toggles the hidden flag on the visible plots.
 boolean HideAllWindows()
          Hides all of the visualization windows (unmap them).
 boolean HideToolbars(boolean forAllWindows)
          Hide the toolbars in a visualization window.
 boolean IconifyAllWindows()
          Iconifies all of the viewer windows.
 boolean ImportEntireState(java.lang.String filename, boolean inVisItDir)
          Restores a session file, which causes VisIt to delete all plots and recreate the plots described in the session file.
 boolean ImportEntireStateWithDifferentSources(java.lang.String filename, boolean inVisItDir, java.util.Vector sources)
          Restores a session file, which causes VisIt to delete all plots and recreate the plots described in the session file but different databases will be used instead of the databases saved in the session file.
 boolean InitializeNamedSelectionVariables(java.lang.String selName)
          Initializes a named selection's variables.
 void InterruptComputeEngine()
          Interrupt the compute engine that is processing data for a plot.
 boolean InvertBackgroundColor()
          Reverses the visualization window's foreground and background colors.
 boolean Lineout(double x0, double y0, double x1, double y1, java.util.Vector vars)
          Perform a screen pick
 boolean LoadNamedSelection(java.lang.String selName, java.lang.String hostName, java.lang.String simName)
          Loads a named selection.
 boolean LowerActiveAnnotationObjects()
          Lowers the selected annotation objects above the others so they are drawn below others.
 boolean MoveAndResizeWindow(int win, int x, int y, int w, int h)
          Move the specified visualization window to a location on the screen and also resize it.
 boolean MovePlotDatabaseKeyframe(int plotId, int oldFrame, int newFrame)
           
 boolean MovePlotKeyframe(int plotId, int oldFrame, int newFrame)
           
 boolean MovePlotOrderTowardFirst(int index)
          Move a plot toward the first slot in the plot list
 boolean MovePlotOrderTowardLast(int index)
          Move a plot toward the last slot in the plot list
 boolean MoveViewKeyframe(int oldFrame, int newFrame)
           
 boolean MoveWindow(int win, int x, int y)
          Move the specified visualization window to a location on the screen.
 boolean OpenClient(java.lang.String clientName, java.lang.String program, java.util.Vector args)
          Opens another VisIt client such as the GUI or CLI.
 boolean OpenComputeEngine(java.lang.String hostName, java.util.Vector argv)
          Tells VisIt's viewer to launch a compute engine on the specified host using the designated command line arguments that affect how the compute engine is launched.
 boolean OpenDatabase(java.lang.String database)
          Opens a database
 boolean OpenDatabase(java.lang.String database, int timeState)
          Opens a database at a given time state
 boolean OpenDatabase(java.lang.String database, int timeState, boolean addDefaultPlots, java.lang.String forcedFileType)
          Opens a database at a given time state, with the opportunity for setting additional options related to the addition of default plots or a forced file type.
 boolean OpenMDServer(java.lang.String hostName, java.util.Vector argv)
          Tells VisIt's viewer to launch a metadata server on the specified host using the designated command line arguments that affect how the metadata server is launched.
 boolean OverlayDatabase(java.lang.String database, int timeState)
          Opens the specified database and creates duplicates of all of the existing plots using the new database.
 boolean Pick(int x, int y, java.util.Vector vars)
          Perform a screen pick
 boolean PrintWindow()
          Prints the active visualization window.
 boolean ProcessExpressions()
          Applies the expression list that was previously sent.
 boolean PromoteOperator(int operatorId)
          Promotes an operator within the list of operators applied to the active plots.
 boolean Query(MapNode queryParams)
          Performs a query
 boolean QueryProcessAttributes(int id, java.lang.String engineHostName, java.lang.String engineDBName)
          Returns process information related to a particular VisIt component
 boolean RaiseActiveAnnotationObjects()
          Raises the selected annotation objects above the others so they are drawn on top.
 boolean ReadHostProfilesFromDirectory(java.lang.String dir, boolean clear)
          Tells the viewer to read host profiles from a specific directory.
 boolean RecenterView()
          Recenters the objects so they fit in the visualization window.
 boolean RedoView()
          Redo the last view undo.
 boolean RedrawWindow()
          Force the viewer to redraw the plots in the active visualization window.
 boolean RemoveAllOperators()
          Removes all operators from the operators applied to the active plots.
 boolean RemoveLastOperator()
          Removes last operator from the operators applied to the active plots.
 boolean RemoveOperator(int operatorId)
          Removes the i'th operator from the operators applied to the active plots.
 boolean RenamePickLabel(java.lang.String oldLabel, java.lang.String newLabel)
          Rename Pick Label
 boolean ReOpenDatabase(java.lang.String database, boolean forceClose)
          Reopens a database that has been opened before, adding new time states if they exist and causing all plots to be regenerated using the new data.
 boolean ReplaceDatabase(java.lang.String database, int timeState)
          Replaces the database in the current plots with the specified database.
 boolean RequestMetaData(java.lang.String database, int timeState)
          Requests metadata for the specified database at a particular time state.
 boolean ResetAnnotationAttributes()
          Restore the annotation attributes to the default settings.
 boolean ResetAnnotationObjectList()
          Restore the annotation object list to the default settings.
 boolean ResetInteractorAttributes()
          Resets the interactor attributes to their defaults.
 boolean ResetLightList()
          Reset the light list to the default light list.
 boolean ResetLineoutColor()
          Resets the lineout color the initial lineout color.
 boolean ResetMaterialAttributes()
          Reset the material attributes to the default material attributes.
 boolean ResetMeshManagementAttributes()
          Reset the mesh management attributes to the default mesh management attributes.
 boolean ResetOperatorOptions(int type)
          Resets the operator attributes for the active plot to the default settings for the operator's type.
 boolean ResetPickAttributes()
          Reset the pick attributes to the defaults.
 boolean ResetPickLetter()
          Reset the pick letter so the next pick letter will be 'A'.
 boolean ResetPlotOptions(int type)
          Resets the active plot's attributes to the default settings for the plot's type.
 boolean ResetQueryOverTimeAttributes()
          Resets the query over time attributes to their default values.
 boolean ResetView()
          Recalculates a suitable default view for the visualization window and applies that view.
 boolean ResizeWindow(int win, int w, int h)
          Resize the specified visualization window.
 boolean SaveNamedSelection(java.lang.String selName)
          Saves a named selection.
 boolean SaveWindow()
          Save the active visualization window as an image file or in some cases as a geometry file.
 boolean SendSimulationCommand(java.lang.String hostName, java.lang.String simName, java.lang.String command)
          Sends a command to a connected simulation.
 boolean SendSimulationCommand(java.lang.String hostName, java.lang.String simName, java.lang.String command, java.lang.String argument)
          Sends a command to a connected simulation.
 boolean SetActiveContinuousColorTable(java.lang.String colorTableName)
          Set the active continuous color table, which is the color table to be used in plots such as Pseudocolor and Surface when their plot attributes are set to use the "default" color table.
 boolean SetActiveDiscreteColorTable(java.lang.String colorTableName)
          Set the active discrete color table, which is the color table to be used in plots such as Subset and FilledBoundary when their plot attributes are set to use the "default" color table.
 boolean SetActivePlot(int index)
          Makes a single plot in the plot list active.
 boolean SetActivePlots(int[] ids)
          Makes a list of plots in the plot list active.
 boolean SetActivePlots(java.util.Vector ids)
          Makes a list of plots in the plot list active.
 boolean SetActivePlots(java.util.Vector activePlots, java.util.Vector activeOperators, java.util.Vector expandedPlots)
          Makes a list of plots in the plot list active while also setting the active operators for each plot and also setting which plots are expanded.
 boolean SetActiveTimeSlider(java.lang.String ts)
          Set the name of the active time slider.
 boolean SetActiveWindow(int windowId)
          Sets the active visualization window.
 boolean SetAnimationAttributes()
          Tell VisIt to apply the animation attributes that were previously sent.
 boolean SetAnnotationAttributes()
          Apply the annotation attributes that were previously sent.
 boolean SetAnnotationObjectOptions()
          Tell VisIt to apply the annotation object attributes that were previously sent.
 boolean SetAppearanceAttributes()
          Applies the appearance attributes that were previously sent.
 boolean SetBackendType(int flag)
          Sets the backend type used in the pipeline.
 boolean SetCenterOfRotation(double x, double y, double z)
          Sets the center of rotation, which is the point about which VisIt rotates plots when you interactively rotate using the mouse.
 boolean SetCreateMeshQualityExpressions(boolean flag)
          Sets whether VisIt will automatically create mesh quality expressions.
 boolean SetCreateTimeDerivativeExpressions(boolean flag)
          Sets whether VisIt will automatically create time-derivative expressions.
 boolean SetCreateVectorMagnitudeExpressions(boolean flag)
          Sets whether VisIt will automatically create vector magnitude expressions.
 boolean SetDefaultAnnotationAttributes()
          Tell VisIt to use the current annotation attributes as the default annotation attributes, which will be the defaults for new visualization windows or the saved defaults when settings are saved.
 boolean SetDefaultAnnotationObjectList()
          Tell VisIt to apply the annotation object attributes that were previously sent as the default annotation object list, which will be used for future visualization windows and for saving settings.
 boolean SetDefaultFileOptions()
          Applies the default file opening options which were previously sent.
 boolean SetDefaultInteractorAttributes()
          Set the default interactor attributes.
 boolean SetDefaultLightList()
          Apply the light list that was previously sent as the default light list, which will be used for new visualization windows and for when saving settings.
 boolean SetDefaultMaterialAttributes()
          Tell VisIt to apply the material attributes that were previously sent as the default material options, which will be used when saving settings.
 boolean SetDefaultMeshManagementAttributes()
          Tell VisIt to apply the mesh management attributes that were previously sent as the default mesh management options, which will be used when saving settings.
 boolean SetDefaultOperatorOptions(int type)
          Sets the default operator options for the specified operator type.
 boolean SetDefaultPickAttributes()
          Makes the pick attributes be the default pick attributes to be used for new visualization windows and in the saved settings.
 boolean SetDefaultPlotOptions(int type)
          Sets the default plot options for the specified plot type.
 boolean SetDefaultQueryOverTimeAttributes()
          Makes the query over time attributes be the default query over time attributes to be used for saved settings.
 boolean SetGlobalLineoutAttributes()
          Applies the global lineout attributes that were previously sent.
 boolean SetInteractorAttributes()
          Applies the interactor attributes that were previously sent.
 boolean SetKeyframeAttributes()
          Apply the keyframe attributes that were previously sent.
 boolean SetLightList()
          Apply the light list that were previously sent.
 boolean SetMaterialAttributes()
          Tell VisIt to apply the material attributes that were previously sent.
 boolean SetMeshManagementAttributes()
          Tell VisIt to apply the mesh management attributes that were previously sent.
 boolean SetNamedSelectionAutoApply(boolean val)
          Set the auto apply mode for named selections.
 boolean SetOperatorOptions(int type)
          Sets the operator options for the specified operator type.
 boolean SetOperatorOptions(java.lang.String type)
          Sets the operator options for the specified operator type.
 boolean SetPickAttributes()
          Applies the pick attributes that were previously sent.
 boolean SetPlotDatabaseState(int plotId, int frame, int ts)
           
 boolean SetPlotDescription(int index, java.lang.String description)
          Sets the description string for the plot
 boolean SetPlotFollowsTime(boolean val)
          Sets a flag on the active plots indicating whether they follow time or not.
 boolean SetPlotFrameRange(int plotID, int frame0, int frame1)
           
 boolean SetPlotOptions(int type)
          Sets the plot options for the specified plot type.
 boolean SetPlotOptions(java.lang.String type)
          Sets the plot options for the specified plot type.
 boolean SetPlotOrderToFirst(int index)
          Make the plot be first in the plot list
 boolean SetPlotOrderToLast(int index)
          Make the plot be last in the plot list
 boolean SetPlotSILRestriction()
          Sets the SIL restriction that was previously sent.
 boolean SetPrecisionType(int flag)
          Sets the precision type used in the pipeline.
 boolean SetQueryFloatFormat(java.lang.String format)
          Sets the format string used for floating point numbers when creating query output strings.
 boolean SetQueryOverTimeAttributes()
          Applies the query over time attributes that were previously sent.
 boolean SetRemoveDuplciateNodes(boolean flag)
          Sets whether VisIt will automatically remove duplicate nodes from fully disconnected unstructured grids.
 boolean SetRenderingAttributes()
          Applies the rendering attributes that were previously sent.
 boolean SetSuppressMessages(boolean flag)
          Sets whether VisIt will will suppress messages that would ordinarily be sent to clients.
 boolean SetTimeSliderState(int state)
          Go to the specified time state for the active time slider.
 boolean SetTreatAllDBsAsTimeVarying(int flag)
          Sets whether VisIt should treat all time-varying databases as having dynamic metadata.
 boolean SetTryHarderCyclesTimes(int flag)
          Sets whether VisIt should invest in the extra effort needed to return valid cycles and times from virtual databases composed of many single time step files.
 boolean SetView2D()
          Applies the 2D view object which was previously sent.
 boolean SetView3D()
          Applies the 3D view object which was previously sent.
 boolean SetViewAxisArray()
          Applies the view axis array view object which was previously sent.
 boolean SetViewCurve()
          Applies the curve view object which was previously sent.
 boolean SetViewExtentsType(int t)
          Sets whether the view is calculated using actual or original spatial extents.
 boolean SetViewKeyframe()
           
 void SetWindowArea(int x, int y, int w, int h)
          Set the area of the screen that will be used for visualization windows.
 boolean SetWindowLayout(int layout)
          Tells the viewer to set the window layout, which is the number of windows on the screen in a particular arrangement.
 boolean SetWindowMode(int mode)
          Sets the window mode for the active visualization window.
 void ShowAllWindows()
          Show the viewer windows.
 boolean ShowToolbars(boolean forAllWindows)
          Show the toolbars in a visualization window.
 boolean SuppressQueryOutput(boolean onOff)
          Turns off query output so it does not get printed.
 boolean TimeSliderNextState()
          Go to the next time state for the active time slider.
 boolean TimeSliderPreviousState()
          Go to the previous time state for the active time slider.
 boolean ToggleAllowPopup()
          Toggles the Right-click popup menu.
 boolean ToggleBoundingBoxMode()
          Toggles bounding box mode for the active visualization window.
 boolean ToggleCameraViewMode()
          Toggles camera view mode, which indicates that the camera should be copied into the view during keyframe animations.
 boolean ToggleFullFrameMode()
          Toggles full frame mode, which is a 1D/2D window mode that exagerrates scale in one or more dimensions to ensure that plots take up most of the visualization window viewport.
 boolean ToggleLockTime()
          Toggles the lock time mode.
 boolean ToggleLockTools()
          Toggles the lock tools mode.
 boolean ToggleLockViewMode()
          Toggles the lock view mode.
 boolean ToggleMaintainViewMode()
          Toggles the maintain view mode, which ensures that the view remains constant (when turned on).
 boolean ToggleSpinMode()
          Toggles spin mode in the active visualization window.
 boolean TurnOffAllLocks()
          Turns off all forms of locking in all windows.
 boolean UndoView()
          Undo the last view change, returning to the previous view.
 boolean UpdateColorTable(java.lang.String colorTableName)
          Applies the ColorTableAttributes that were previously sent and updates any plots that use the color table that was modified.
 boolean UpdateDBPluginInfo(java.lang.String hostName)
          Tell VisIt to send the database plugin information for the specified host.
 boolean UpdateNamedSelection(java.lang.String selName, boolean updatePlots)
          Updates a named selection.
 boolean UpdateNamedSelection(java.lang.String selName, SelectionProperties props, boolean updatePlots, boolean allowCaching)
          Updates a named selection.
 boolean WriteConfigFile()
          Saves the viewer's settings file, which is called ~/.visit/config and contains default values for state objects.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

ViewerMethods

public ViewerMethods(ProxyInterface p)
Constructor for the ViewerMethods class.

Parameters:
p - The ViewerProxy that contains this object.
Method Detail

Close

public boolean Close()
Tells the viewer to close.

Returns:
true on success; false otherwise.

Detach

public boolean Detach()
Tells the viewer to detach this client. This can be useful when you have multiple clients attached to the same viewer and this one wants to detach itself while not disturbing the other clients.

Returns:
true on success; false otherwise.

AddWindow

public boolean AddWindow()
Adds a new visualization window

Returns:
true on success; false otherwise.

CloneWindow

public boolean CloneWindow()
Adds a new visualization window, copying all settings and plots from the currently active visualization window.

Returns:
true on success; false otherwise.

DeleteWindow

public boolean DeleteWindow()
Tells the viewer to close the active visualization window and delete it.

Returns:
true on success; false otherwise.

SetWindowLayout

public boolean SetWindowLayout(int layout)
Tells the viewer to set the window layout, which is the number of windows on the screen in a particular arrangement.

Parameters:
layout - The layout value. Valid values are: 1,2,4,9,16.
Returns:
true on success; false otherwise.

SetActiveWindow

public boolean SetActiveWindow(int windowId)
Sets the active visualization window.

Parameters:
windowId - The number of the visualization window >= 1.
Returns:
true on success; false otherwise.

IconifyAllWindows

public boolean IconifyAllWindows()
Iconifies all of the viewer windows.

Returns:
true on success; false otherwise.

DeIconifyAllWindows

public boolean DeIconifyAllWindows()
Brings all viewer windows back from an iconified state.

Returns:
true on success; false otherwise.

ShowAllWindows

public void ShowAllWindows()
Show the viewer windows. You must call this method to make the viewer show its windows after being launched or no windows will be shown.


HideAllWindows

public boolean HideAllWindows()
Hides all of the visualization windows (unmap them).

Returns:
true on success; false otherwise.

ClearWindow

public boolean ClearWindow(boolean clearAllPlots)
Clear the plots from a visualization window. This does not delete plots; rather their resources are freed and they are put back into the new state so they can be regenerated.

Parameters:
clearAllPlots - True to clear all plots in the plot list. If false, only the active plots are cleared.
Returns:
true on success; false otherwise.

ClearAllWindows

public boolean ClearAllWindows()
Clear the plots in all visualization windows.

Returns:
true on success; false otherwise.

ConnectToMetaDataServer

public boolean ConnectToMetaDataServer(java.lang.String hostName,
                                       java.util.Vector args)
Tells the viewer to tell the metadata server to connect back to this client. A Metadata server browses remote file systems and opens files to get their metadata. NOTE: This method is not fully supported since the Java client has no MDServerProxy.

Parameters:
hostName - The name of the host computer on which to launch the metadata server.
args - A vector of strings containing command line arguments that the metadata server would use to connect back to this client.
Returns:
true on success; false otherwise.

OpenDatabase

public boolean OpenDatabase(java.lang.String database)
Opens a database

Parameters:
database - The name of the database to open -- a filename. If the file exists on a remote computer, then you can supply a name of the form: host:/path/file.ext
Returns:
true on success; false otherwise.

OpenDatabase

public boolean OpenDatabase(java.lang.String database,
                            int timeState)
Opens a database at a given time state

Parameters:
database - The name of the database to open -- a filename. If the file exists on a remote computer, then you can supply a name of the form: host:/path/file.ext
timeState - The time state at which we're opening the database (>=0). Pass 0 if you don't prefer a later time state.
Returns:
true on success; false otherwise.

OpenDatabase

public boolean OpenDatabase(java.lang.String database,
                            int timeState,
                            boolean addDefaultPlots,
                            java.lang.String forcedFileType)
Opens a database at a given time state, with the opportunity for setting additional options related to the addition of default plots or a forced file type.

Parameters:
database - The name of the database to open -- a filename. If the file exists on a remote computer, then you can supply a name of the form: host:/path/file.ext
timeState - The time state at which we're opening the database (>=0). Pass 0 if you don't prefer a later time state.
addDefaultPlots - True to add default plots if the database supports them or false to prevent default plots from being added.
forcedFileType - The name of a database plugin that should be used to open the database (e.g. "Silo_1.0"). If you don't care which plugin opens the database, pass "".
Returns:
true on success; false otherwise.

CloseDatabase

public boolean CloseDatabase(java.lang.String database)
Closes the named database -- if it is not being used.

Parameters:
database - The name of the database to open -- a filename. If the file exists on a remote computer, then you can supply a name of the form: host:/path/file.ext
Returns:
true on success; false otherwise.

ActivateDatabase

public boolean ActivateDatabase(java.lang.String database)
Makes the named database be the active database, which is the database that can be used to create plots and is the database whose variables are shown in the plot menus. A database can only be made active if it has been previously opened via OpenDatabase().

Parameters:
database - The name of the database to open -- a filename. If the file exists on a remote computer, then you can supply a name of the form: host:/path/file.ext
Returns:
true on success; false otherwise.

CheckForNewStates

public boolean CheckForNewStates(java.lang.String database)
If the database is a virtual database (collection of single related files that have been grouped into a time-varying database) then this method checks to see if there are any new files that need to be added to the database. This method is cheaper than ReOpenDatabase since it adds new files to a database without causing plots to be regenerated. This method is used when you are monitoring the progress of a simulation that keeps writing out files that you want to plot.

Parameters:
database - The name of the database to open -- a filename. If the file exists on a remote computer, then you can supply a name of the form: host:/path/file.ext
Returns:
true on success; false otherwise.

ReOpenDatabase

public boolean ReOpenDatabase(java.lang.String database,
                              boolean forceClose)
Reopens a database that has been opened before, adding new time states if they exist and causing all plots to be regenerated using the new data. This method can be useful when you overwrite a database that VisIt was plotting and you want to plot the new data.

Parameters:
database - The name of the database to open -- a filename. If the file exists on a remote computer, then you can supply a name of the form: host:/path/file.ext
Returns:
true on success; false otherwise.

ReplaceDatabase

public boolean ReplaceDatabase(java.lang.String database,
                               int timeState)
Replaces the database in the current plots with the specified database. Note that if the new database does not contain the variables for a plot then the plot will not have its database changed to the database provided by this method. ReplaceDatabase can be useful in the situation where you have set up a visualization using results from one simulation and then you want to replace the plots' database with the results of a related but different simulation.

Parameters:
database - The name of the database to open -- a filename. If the file exists on a remote computer, then you can supply a name of the form: host:/path/file.ext
timeState - The time state at which to open the database (>=0). Pass 0 if you don't prefer a later time state.
Returns:
true on success; false otherwise.

OverlayDatabase

public boolean OverlayDatabase(java.lang.String database,
                               int timeState)
Opens the specified database and creates duplicates of all of the existing plots using the new database.

Parameters:
database - The name of the database to open -- a filename. If the file exists on a remote computer, then you can supply a name of the form: host:/path/file.ext
timeState - The time state at which to open the database (>=0). Pass 0 if you don't prefer a later time state.
Returns:
true on success; false otherwise.

RequestMetaData

public boolean RequestMetaData(java.lang.String database,
                               int timeState)
Requests metadata for the specified database at a particular time state. You can use the metadata to determine information such as which variables are in the database. The metadata comes back in the avtDatabaseMetaData object in ViewerState.This method does not disrupt the active database.

Parameters:
database - The name of the database to open -- a filename. If the file exists on a remote computer, then you can supply a name of the form: host:/path/file.ext
timeState - The time state at which to open the database (>=0). You can provide a time state since some databases can provide different metadata depending on the time state. If you don't know or don't care about the time state then pass 0.
Returns:
true on success; false otherwise.

ApplyNamedSelection

public boolean ApplyNamedSelection(java.lang.String selName)
Applies a named selection to the active plots.

Parameters:
selName - The name of the named selection to use.
Returns:
true on success; false otherwise.

CreateNamedSelection

public boolean CreateNamedSelection(java.lang.String selName)
Creates a named selection based on the active plots.

Parameters:
selName - The name of the named selection to create.
Returns:
true on success; false otherwise.

CreateNamedSelection

public boolean CreateNamedSelection(java.lang.String selName,
                                    SelectionProperties props,
                                    boolean useCurrentPlot)
Creates a named selection based on the active plots.

Parameters:
selName - The name of the named selection to create.
props - The SelectionProperties to Apply.
useCurrentPlot - Whether or not to use the current plot.
Returns:
true on success; false otherwise.

DeleteNamedSelection

public boolean DeleteNamedSelection(java.lang.String selName)
Deletes a named selection.

Parameters:
selName - The name of the named selection to delete.
Returns:
true on success; false otherwise.

LoadNamedSelection

public boolean LoadNamedSelection(java.lang.String selName,
                                  java.lang.String hostName,
                                  java.lang.String simName)
Loads a named selection.

Parameters:
selName - The name of the named selection to load.
hostName - The host that has the named selection
simName - The name of the simulation.
Returns:
true on success; false otherwise.

SaveNamedSelection

public boolean SaveNamedSelection(java.lang.String selName)
Saves a named selection.

Parameters:
selName - The name of the named selection to save.
Returns:
true on success; false otherwise.

SetNamedSelectionAutoApply

public boolean SetNamedSelectionAutoApply(boolean val)
Set the auto apply mode for named selections.

Parameters:
val - True to make updating named selections automatically update plots; False otherwise.
Returns:
true on success; false otherwise.

UpdateNamedSelection

public boolean UpdateNamedSelection(java.lang.String selName,
                                    boolean updatePlots)
Updates a named selection.

Parameters:
selName - The name of the named selection to update.
updatePlots - Whether to also update the plots when doing the selection.
Returns:
true on success; false otherwise.

UpdateNamedSelection

public boolean UpdateNamedSelection(java.lang.String selName,
                                    SelectionProperties props,
                                    boolean updatePlots,
                                    boolean allowCaching)
Updates a named selection.

Parameters:
selName - The name of the named selection to update.
props - The SelectionProperties to use.
updatePlots - Whether to also update the plots when doing the selection.
allowCaching - Whether to allow caching if we recalculate the selection.
Returns:
true on success; false otherwise.

InitializeNamedSelectionVariables

public boolean InitializeNamedSelectionVariables(java.lang.String selName)
Initializes a named selection's variables.

Parameters:
selName - The name of the named selection to update.
Returns:
true on success; false otherwise.

ExportDatabase

public boolean ExportDatabase()
Tell the viewer to export the data for the current plot as a database file. You should first set the options in the ExportDBAttributes in ViewerState before calling this method. Example:

ExportDBAttributes atts = proxy.GetViewerState().GetExportDBAttributes();
// Modify the atts here... (not shown)
atts.Notify();
proxy.GetViewerMethods().ExportDatabase();

Returns:
true on success; false otherwise.

ConstructDataBinning

public boolean ConstructDataBinning()
Tell VisIt to construct a data binning, which is often a statistical variable derived from your data after binning. You should first set the options in the ConstructDataBinningAttributes in ViewerState before calling this method. Example:

ConstructDataBinningAttributes atts = proxy.GetViewerState().GetConstructDataBinningAttributes();
// Modify the atts here... (not shown)
atts.Notify();
proxy.GetViewerMethods().ConstructDataBinning();

Returns:
true on success; false otherwise.

ClearCache

public boolean ClearCache(java.lang.String hostName,
                          java.lang.String simName)
Tell VisIt to clear its cache for the compute engine on the specified host. This method can free up considerable memory resources for compute engines that have processed many complex requests.

Parameters:
hostName - The name of the computer where the compute engine is running.
simName - The name of the simulation. If you're not running a simulation, pass "".
Returns:
true on success; false otherwise.

ClearCacheForAllEngines

public boolean ClearCacheForAllEngines()
Tell VisIt to clear its cache for all compute engines. This method can free up considerable memory resources for compute engines that have processed many complex requests.

Returns:
true on success; false otherwise.

UpdateDBPluginInfo

public boolean UpdateDBPluginInfo(java.lang.String hostName)
Tell VisIt to send the database plugin information for the specified host. This method lets us determine which database plugins are available various computers.

Parameters:
hostName - The name of the computer for which we want database plugin information.
Returns:
true on success; false otherwise.

CreateDatabaseCorrelation

public boolean CreateDatabaseCorrelation(java.lang.String name,
                                         java.util.Vector dbs,
                                         int method,
                                         int nStates)
Create a database correlation, which is a mapping that relates several time-varying databases so they can be controlled by a single time slider. Creating a database correlation causes a new time slider to be created.

Parameters:
name - The name of the new database correlation.
dbs - A vector of String objects containing the names of the databases to include in the database correlation.
method - See correlation methods in DatabaseCorrelation class.
nStates - The number of time states that the new database correlation should have.
Returns:
true on success; false otherwise.

AlterDatabaseCorrelation

public boolean AlterDatabaseCorrelation(java.lang.String name,
                                        java.util.Vector dbs,
                                        int method,
                                        int nStates)
Alters an existing database correlation.

Parameters:
name - The name of the database correlation.
dbs - A vector of String objects containing the names of the databases to include in the database correlation.
method - See correlation methods in DatabaseCorrelation class.
nStates - The number of time states that the new database correlation should have.
Returns:
true on success; false otherwise.

DeleteDatabaseCorrelation

public boolean DeleteDatabaseCorrelation(java.lang.String name)
Deletes an existing database correlation.

Parameters:
name - The name of the database correlation to delete.
Returns:
true on success; false otherwise.

OpenComputeEngine

public boolean OpenComputeEngine(java.lang.String hostName,
                                 java.util.Vector argv)
Tells VisIt's viewer to launch a compute engine on the specified host using the designated command line arguments that affect how the compute engine is launched.

Parameters:
hostName - The name of the host computer where the compute engine will be launched. Note that only one compute engine may be launched per host.
argv - Command line arguments for the compute engine that affect how it will be launched.
Returns:
true on success; false otherwise.

CloseComputeEngine

public boolean CloseComputeEngine(java.lang.String hostName,
                                  java.lang.String simName)
Tells VisIt's viewer to close the compute engine on the specified host.

Parameters:
hostName - The name of the host computer where the compute engine is running.
simName - The name of the simulation on the host. If you're not closing a simulation, pass "".
Returns:
true on success; false otherwise.

InterruptComputeEngine

public void InterruptComputeEngine()
Interrupt the compute engine that is processing data for a plot. This stops the compute engine from completing its work and the plot is put into the error state. DrawPlots() must be called for the plot to be processed again.


OpenMDServer

public boolean OpenMDServer(java.lang.String hostName,
                            java.util.Vector argv)
Tells VisIt's viewer to launch a metadata server on the specified host using the designated command line arguments that affect how the metadata server is launched. A metadata server is used to browse file systems and return file metadata.

Parameters:
hostName - The name of the host computer where the compute engine will be launched. Note that only one compute engine may be launched per host.
argv - Command line arguments for the compute engine that affect how it will be launched.
Returns:
true on success; false otherwise.

AnimationSetNFrames

public boolean AnimationSetNFrames(int nFrames)
Sets the number of animation frames for a keyframe animation. Note that keyframing must be enabled for this method to have an effect.

Parameters:
nFrames - The number of animation frames to create for the visualization.
Returns:
true on success; false otherwise.

AnimationPlay

public boolean AnimationPlay()
Animate through the time states for the visualization of a time-varying database. Only plots that are affected by the active time slider are animated.

Returns:
true on success; false otherwise.

AnimationReversePlay

public boolean AnimationReversePlay()
Animate through the time states for the visualization of a time-varying database in reverse order. Only plots that are affected by the active time slider are animated.

Returns:
true on success; false otherwise.

AnimationStop

public boolean AnimationStop()
Stop animation.

Returns:
true on success; false otherwise.

TimeSliderNextState

public boolean TimeSliderNextState()
Go to the next time state for the active time slider. This causes plots that are affected by the active time slider to go to the next time state as determined by their database correlation.

Returns:
true on success; false otherwise.

TimeSliderPreviousState

public boolean TimeSliderPreviousState()
Go to the previous time state for the active time slider. This causes plots that are affected by the active time slider to go to the previous time state as determined by their database correlation.

Returns:
true on success; false otherwise.

SetTimeSliderState

public boolean SetTimeSliderState(int state)
Go to the specified time state for the active time slider. This will cause plots that use the active time slider to be updated to a time state determined by their database correlation.

Returns:
true on success; false otherwise.

SetActiveTimeSlider

public boolean SetActiveTimeSlider(java.lang.String ts)
Set the name of the active time slider. This is the name of a database correlation, which is often a host&path qualified database name. The valid time slider names for a visualization window are given in the timeSliders member in the WindowInformation state object in ViewerState.

Parameters:
ts - The name of the new active time slider.
Returns:
true on success; false otherwise.

SaveWindow

public boolean SaveWindow()
Save the active visualization window as an image file or in some cases as a geometry file. You can set window-saving options by calling SetSaveWindowAttributes() before calling SaveWindow().

Returns:
true on success; false otherwise.

PrintWindow

public boolean PrintWindow()
Prints the active visualization window. You can set printer options beforehand like this: PrinterAttributes atts = proxy.GetViewerState().GetPrinterAttributes(); // Set printer options here ... (not shown) atts.Notify(); PrintWindow();

Returns:
true on success; false otherwise.

DisableRedraw

public boolean DisableRedraw()
Disables the viewer's ability to redraw its plots when you make changes. This can be a useful option when you plan to make several updates that each would have caused the viewer to redraw its plots. Disabling the intermediate updates causes the visualization to be completed more quickly.

Returns:
true on success; false otherwise.

RedrawWindow

public boolean RedrawWindow()
Force the viewer to redraw the plots in the active visualization window.

Returns:
true on success; false otherwise.

ResizeWindow

public boolean ResizeWindow(int win,
                            int w,
                            int h)
Resize the specified visualization window. The provided width and height are in pixels and usually correspond to the dimensions of the window's exterior bounds, which includes the window decorations.

Parameters:
win - The window id of the window to resize (>=1).
w - The new window width in pixels.
h - The new window height in pixels.
Returns:
true on success; false otherwise.

MoveWindow

public boolean MoveWindow(int win,
                          int x,
                          int y)
Move the specified visualization window to a location on the screen.

Parameters:
win - The window id of the window to resize (>=1).
x - The new x location on the screen.
y - The new y location on the screen.
Returns:
true on success; false otherwise.

MoveAndResizeWindow

public boolean MoveAndResizeWindow(int win,
                                   int x,
                                   int y,
                                   int w,
                                   int h)
Move the specified visualization window to a location on the screen and also resize it.

Parameters:
win - The window id of the window to resize (>=1).
x - The new x location on the screen.
y - The new y location on the screen.
w - The new window width in pixels.
h - The new window height in pixels.
Returns:
true on success; false otherwise.

HideToolbars

public boolean HideToolbars(boolean forAllWindows)
Hide the toolbars in a visualization window.

Parameters:
forAllWindows - True to hide the toolbars in all visualization windows. false to hide the toolbars only in the active visualization window.
Returns:
true on success; false otherwise.

ShowToolbars

public boolean ShowToolbars(boolean forAllWindows)
Show the toolbars in a visualization window.

Parameters:
forAllWindows - True to show the toolbars in all visualization windows. false to show the toolbars only in the active visualization window.
Returns:
true on success; false otherwise.

AddPlot

public boolean AddPlot(int type,
                       java.lang.String var)
Adds a new plot.

Parameters:
type - The index of the plot type to be created.
var - The variable to be plotted. The variable must exist in the active database and it must be a type that is compatible with the plot type (i.e. Pseudocolor plots get scalar variables -- not mesh variables).
Returns:
true on success; false otherwise.

AddPlot

public boolean AddPlot(java.lang.String plotName,
                       java.lang.String var)
Adds a new plot.

Parameters:
plotName - The name of the plot type to be created.
var - The variable to be plotted. The variable must exist in the active database and it must be a type that is compatible with the plot type (i.e. Pseudocolor plots get scalar variables -- not mesh variables).
Returns:
true on success; false otherwise.

CopyActivePlots

public boolean CopyActivePlots()
Creates identical copies of the active plots and puts them into the new state so their plot attributes can be changed.

Returns:
true on success; false otherwise.

SetPlotFrameRange

public boolean SetPlotFrameRange(int plotID,
                                 int frame0,
                                 int frame1)

DeletePlotKeyframe

public boolean DeletePlotKeyframe(int plotId,
                                  int frame)

MovePlotKeyframe

public boolean MovePlotKeyframe(int plotId,
                                int oldFrame,
                                int newFrame)

SetPlotDatabaseState

public boolean SetPlotDatabaseState(int plotId,
                                    int frame,
                                    int ts)

DeletePlotDatabaseKeyframe

public boolean DeletePlotDatabaseKeyframe(int plotId,
                                          int frame)

MovePlotDatabaseKeyframe

public boolean MovePlotDatabaseKeyframe(int plotId,
                                        int oldFrame,
                                        int newFrame)

DeleteActivePlots

public boolean DeleteActivePlots()
Deletes the active plots, freeing all of their data, and removing them from the plot list.

Returns:
true on success; false otherwise.

HideActivePlots

public boolean HideActivePlots()
Toggles the hidden flag on the visible plots. Hiding a hidden plot shows it.

Returns:
true on success; false otherwise.

SetPlotFollowsTime

public boolean SetPlotFollowsTime(boolean val)
Sets a flag on the active plots indicating whether they follow time or not. If a plot does not follow time then it is disconnected from its time slider and updating the time slider will not have any effect on the plot.

Parameters:
val - Whether the plot should follow the time slider.
Returns:
true on success; false otherwise.

DrawPlots

public boolean DrawPlots()
Causes VisIt to process any plots that are new or in the error state so they get computed in the compute engine and shown in the visualization window.

Returns:
true on success; false otherwise.

DrawPlots

public boolean DrawPlots(boolean drawAllPlots)
Causes VisIt to process any plots that are new or in the error state so they get computed in the compute engine and shown in the visualization window.

Parameters:
drawAllPlots - True is the default behavior and draws all plots. If you only want to draw the active plots then pass false.
Returns:
true on success; false otherwise.

SetActivePlots

public boolean SetActivePlots(java.util.Vector ids)
Makes a list of plots in the plot list active.

Parameters:
ids - Vector of Integer objects containing the ids of the new active plots in the plot list. Plot list indices begin at 0.
Returns:
true on success; false otherwise.

SetActivePlots

public boolean SetActivePlots(java.util.Vector activePlots,
                              java.util.Vector activeOperators,
                              java.util.Vector expandedPlots)
Makes a list of plots in the plot list active while also setting the active operators for each plot and also setting which plots are expanded.

Parameters:
activePlots - Vector of Integer objects containing the ids of the new active plots in the plot list. Plot list indices begin at 0.
activeOperators - Vector of Integer objects containing the ids of the active operators for all plots in the plot list.
expandedPlots - Vector of Bool objects (1 for each plot in the plot list) each containing a flag indicating whether a plot is expanded.
Returns:
true on success; false otherwise.

SetActivePlots

public boolean SetActivePlots(int[] ids)
Makes a list of plots in the plot list active.

Parameters:
ids - Array of new active plots in the plot list. Plot list indices begin at 0.
Returns:
true on success; false otherwise.

SetActivePlot

public boolean SetActivePlot(int index)
Makes a single plot in the plot list active.

Parameters:
index - Index of the new active plot in the plot list. Plot list indices begin at 0.
Returns:
true on success; false otherwise.

ChangeActivePlotsVar

public boolean ChangeActivePlotsVar(java.lang.String var)
Changes the plotted variable for the active plots.

Parameters:
var - The name of the new variable to use in the active plots. The variable must exist in the active database.
Returns:
true on success; false otherwise.

SetPlotDescription

public boolean SetPlotDescription(int index,
                                  java.lang.String description)
Sets the description string for the plot

Parameters:
index - The index of the plot in the plot list.
description - The description string to display for the plot
Returns:
true on success; false otherwise.

MovePlotOrderTowardFirst

public boolean MovePlotOrderTowardFirst(int index)
Move a plot toward the first slot in the plot list

Parameters:
index - The index of the plot in the plot list.
Returns:
true on success; false otherwise.

MovePlotOrderTowardLast

public boolean MovePlotOrderTowardLast(int index)
Move a plot toward the last slot in the plot list

Parameters:
index - The index of the plot in the plot list.
Returns:
true on success; false otherwise.

SetPlotOrderToFirst

public boolean SetPlotOrderToFirst(int index)
Make the plot be first in the plot list

Parameters:
index - The index of the plot in the plot list.
Returns:
true on success; false otherwise.

SetPlotOrderToLast

public boolean SetPlotOrderToLast(int index)
Make the plot be last in the plot list

Parameters:
index - The index of the plot in the plot list.
Returns:
true on success; false otherwise.

AddOperator

public boolean AddOperator(int oper)
Adds an operator to the active plots.

Parameters:
oper - Type of the operator to be added, which is an index in the operator plugin manager.
Returns:
true on success; false otherwise.

AddOperator

public boolean AddOperator(int oper,
                           boolean fromDefault)
Adds an operator to the active plots.

Parameters:
oper - Type of the operator to be added, which is an index in the operator plugin manager.
fromDefault - True to initilize the operator from the default operator attributes.
Returns:
true on success; false otherwise.

AddOperator

public boolean AddOperator(java.lang.String type)
Adds an operator to the active plots.

Parameters:
type - Name of the operator to be added.
Returns:
true on success; false otherwise.

AddInitializedOperator

public boolean AddInitializedOperator(int oper)
Adds an operator to the active plots.

Parameters:
oper - Type of the operator to be added, which is an index in the operator plugin manager.
Returns:
true on success; false otherwise.

PromoteOperator

public boolean PromoteOperator(int operatorId)
Promotes an operator within the list of operators applied to the active plots.

Parameters:
operatorId - The index of the operator to promote in the plot.
Returns:
true on success; false otherwise.

DemoteOperator

public boolean DemoteOperator(int operatorId)
Demotes an operator within the list of operators applied to the active plots.

Parameters:
operatorId - The index of the operator to demote in the plot.
Returns:
true on success; false otherwise.

RemoveOperator

public boolean RemoveOperator(int operatorId)
Removes the i'th operator from the operators applied to the active plots.

Parameters:
operatorId - The index of the operator to remove from the plot.
Returns:
true on success; false otherwise.

RemoveLastOperator

public boolean RemoveLastOperator()
Removes last operator from the operators applied to the active plots.

Returns:
true on success; false otherwise.

RemoveAllOperators

public boolean RemoveAllOperators()
Removes all operators from the operators applied to the active plots.

Returns:
true on success; false otherwise.

SetDefaultPlotOptions

public boolean SetDefaultPlotOptions(int type)
Sets the default plot options for the specified plot type. Future instances of that plot type will be initialized with the attributes that have been set for it. The plot attributes state object must have been set before calling this method. Example:

int type = proxy.GetPlotIndex("Pseudocolor");
PseudocolorAttributes atts = (PseudocolorAttributes)proxy.GetPlotAttributes(type);
// Modify atts ... (not shown)
atts.Notify();
proxy.GetViewerMethods().SetDefaultPlotOptions(type);

Parameters:
type - Type of the plot for which we're setting default options.
Returns:
true on success; false otherwise.

SetPlotOptions

public boolean SetPlotOptions(int type)
Sets the plot options for the specified plot type. The plot attributes state object must have been set before calling this method. Example:

int type = proxy.GetPlotIndex("Pseudocolor");
PseudocolorAttributes atts = (PseudocolorAttributes)proxy.GetPlotAttributes(type);
// Modify atts ... (not shown)
atts.Notify();
proxy.GetViewerMethods().SetPlotOptions(type);

Parameters:
type - Type of the plot for which we're setting default options (an index)
Returns:
true on success; false otherwise.

SetPlotOptions

public boolean SetPlotOptions(java.lang.String type)
Sets the plot options for the specified plot type. The plot attributes state object must have been set before calling this method. Example:

int type = proxy.GetPlotIndex("Pseudocolor");
PseudocolorAttributes atts = (PseudocolorAttributes)proxy.GetPlotAttributes(type);
// Modify atts ... (not shown)
atts.Notify();
proxy.GetViewerMethods().SetPlotOptions("Pseudocolor");

Parameters:
type - Type of the plot for which we're setting default options.
Returns:
true on success; false otherwise.

ResetPlotOptions

public boolean ResetPlotOptions(int type)
Resets the active plot's attributes to the default settings for the plot's type.

Parameters:
type - Type of the plot for which we're resetting plot options (an index)
Returns:
true on success; false otherwise.

SetDefaultOperatorOptions

public boolean SetDefaultOperatorOptions(int type)
Sets the default operator options for the specified operator type. Future instances of that operator type will be initialized with the attributes that have been set for it. The operator attributes state object must have been set before calling this method. Example:

int type = proxy.GetOperatorIndex("Slice");
SliceAttributes atts = (SliceAttributes)proxy.GetOperatorAttributes(type);
// Modify atts ... (not shown)
atts.Notify();
proxy.GetViewerMethods().SetDefaultOperatorOptions(type);

Parameters:
type - Type of the operator for which we're setting default options.
Returns:
true on success; false otherwise.

SetOperatorOptions

public boolean SetOperatorOptions(int type)
Sets the operator options for the specified operator type. The operator attributes state object must have been set before calling this method. Example:

int type = proxy.GetOperatorIndex("Slice");
SliceAttributes atts = (SliceAttributes)proxy.GetOperatorAttributes(type);
// Modify atts ... (not shown)
atts.Notify();
proxy.GetViewerMethods().SetOperatorOptions(type);

Parameters:
type - Type of the operator for which we're setting default options (an index)
Returns:
true on success; false otherwise.

SetOperatorOptions

public boolean SetOperatorOptions(java.lang.String type)
Sets the operator options for the specified operator type. The operator attributes state object must have been set before calling this method. Example:

int type = proxy.GetOperatorIndex("Slice");
SliceAttributes atts = (SliceAttributes)proxy.GetOperatorAttributes(type);
// Modify atts ... (not shown)
atts.Notify();
proxy.GetViewerMethods().SetOperatorOptions("Slice");

Parameters:
type - Type of the operator for which we're setting default options.
Returns:
true on success; false otherwise.

ResetOperatorOptions

public boolean ResetOperatorOptions(int type)
Resets the operator attributes for the active plot to the default settings for the operator's type.

Parameters:
type - Type of the operator for which we're resetting operator options (an index)
Returns:
true on success; false otherwise.

SetAnimationAttributes

public boolean SetAnimationAttributes()
Tell VisIt to apply the animation attributes that were previously sent. Example:

AnimationAttributes atts = proxy.GetViewerState().GetAnimationAttributes();
// Modify the atts here... (not shown)
atts.Notify();
proxy.GetViewerMethods().SetAnimationAttributes();

Returns:
true on success; false otherwise.

SetAnnotationAttributes

public boolean SetAnnotationAttributes()
Apply the annotation attributes that were previously sent. Annotation attributes control properties for stock annotations such as the 2D/3D axes. Example:

AnnotationAttributes atts = proxy.GetViewerState().GetAnnotationAttributes();
// Modify the atts here... (not shown)
atts.Notify();
proxy.GetViewerMethods().SetAnnotationAttributes();

Returns:
true on success; false otherwise.

SetDefaultAnnotationAttributes

public boolean SetDefaultAnnotationAttributes()
Tell VisIt to use the current annotation attributes as the default annotation attributes, which will be the defaults for new visualization windows or the saved defaults when settings are saved. Example:

AnnotationAttributes atts = proxy.GetViewerState().GetAnnotationAttributes();
// Modify the atts here... (not shown)
atts.Notify();
proxy.GetViewerMethods().SetDefaultAnnotationAttributes();

Returns:
true on success; false otherwise.

ResetAnnotationAttributes

public boolean ResetAnnotationAttributes()
Restore the annotation attributes to the default settings.

Returns:
true on success; false otherwise.

AddAnnotationObject

public boolean AddAnnotationObject(int annotType,
                                   java.lang.String annotName)
Create a new annotation object and add it to the visualization. Example:

proxy.GetViewerMethods().AddAnnotationObject(AnnotationObject.ANNOTATIONTYPE_TIMESLIDER, "mySlider");

Parameters:
annotType - One of the annotation types in AnnotationObject.java
annotName - The name of the new annotation object instance.
Returns:
true on success; false otherwise.

HideActiveAnnotationObjects

public boolean HideActiveAnnotationObjects()
Hides the selected annotation objects.

Returns:
true on success; false otherwise.

DeleteActiveAnnotationObjects

public boolean DeleteActiveAnnotationObjects()
Deletes the selected annotation objects.

Returns:
true on success; false otherwise.

RaiseActiveAnnotationObjects

public boolean RaiseActiveAnnotationObjects()
Raises the selected annotation objects above the others so they are drawn on top.

Returns:
true on success; false otherwise.

LowerActiveAnnotationObjects

public boolean LowerActiveAnnotationObjects()
Lowers the selected annotation objects above the others so they are drawn below others.

Returns:
true on success; false otherwise.

SetAnnotationObjectOptions

public boolean SetAnnotationObjectOptions()
Tell VisIt to apply the annotation object attributes that were previously sent. Annotation object options set properties for user-created annotations such as time sliders, text, etc. Example:

AnnotationObjectList atts = proxy.GetViewerState().GetAnnotationObjectList();
AnnotationObject obj = atts.GetAnnotation(0); // Modify obj here... (not shown)
atts.Notify();
proxy.GetViewerMethods().SetAnnotationObjectOptions();

Returns:
true on success; false otherwise.

SetDefaultAnnotationObjectList

public boolean SetDefaultAnnotationObjectList()
Tell VisIt to apply the annotation object attributes that were previously sent as the default annotation object list, which will be used for future visualization windows and for saving settings.

Returns:
true on success; false otherwise.

ResetAnnotationObjectList

public boolean ResetAnnotationObjectList()
Restore the annotation object list to the default settings.

Returns:
true on success; false otherwise.

SetMaterialAttributes

public boolean SetMaterialAttributes()
Tell VisIt to apply the material attributes that were previously sent. Material attributes control material interface reconstruction, which is the process of recreating material boundaries from material mass fractions that some databases provide. Example:

MaterialAttributes atts = proxy.GetViewerState().GetMaterialAttributes();
// Modify the atts here... (not shown)
atts.Notify();
proxy.GetViewerMethods().SetMaterialAttributes();

Returns:
true on success; false otherwise.

SetDefaultMaterialAttributes

public boolean SetDefaultMaterialAttributes()
Tell VisIt to apply the material attributes that were previously sent as the default material options, which will be used when saving settings.

Returns:
true on success; false otherwise.

ResetMaterialAttributes

public boolean ResetMaterialAttributes()
Reset the material attributes to the default material attributes.

Returns:
true on success; false otherwise.

SetMeshManagementAttributes

public boolean SetMeshManagementAttributes()
Tell VisIt to apply the mesh management attributes that were previously sent. Mesh management attributes control algorithms such as CSG discretization. Example:

MeshManagementAttributes atts = proxy.GetViewerState().GetMeshManagementAttributes();
// Modify the atts here... (not shown)
atts.Notify();
proxy.GetViewerMethods().SetMeshManagementAttributes();

Returns:
true on success; false otherwise.

SetDefaultMeshManagementAttributes

public boolean SetDefaultMeshManagementAttributes()
Tell VisIt to apply the mesh management attributes that were previously sent as the default mesh management options, which will be used when saving settings.

Returns:
true on success; false otherwise.

ResetMeshManagementAttributes

public boolean ResetMeshManagementAttributes()
Reset the mesh management attributes to the default mesh management attributes.

Returns:
true on success; false otherwise.

SetKeyframeAttributes

public boolean SetKeyframeAttributes()
Apply the keyframe attributes that were previously sent. Example:

KeyframeAttributes atts = proxy.GetViewerState().GetKeyframeAttributes();
// Modify the atts here... (not shown)
atts.Notify();
proxy.GetViewerMethods().SetKeyframeAttributes();

Returns:
true on success; false otherwise.

SetLightList

public boolean SetLightList()
Apply the light list that were previously sent. The light list controls lights in VisIt. There can be up to 8 lights and each can have different colors, types, and orientations. Multiple lights are often useful when making a presentation-quality visualization since you can brighten up areas of a visualization that are too dark and you can add more dramatic lighting. Example:

LightList atts = proxy.GetViewerState().GetLightList();
// Modify the atts here... (not shown)
atts.Notify();
proxy.GetViewerMethods().SetLightList();

Returns:
true on success; false otherwise.

SetDefaultLightList

public boolean SetDefaultLightList()
Apply the light list that was previously sent as the default light list, which will be used for new visualization windows and for when saving settings.

Returns:
true on success; false otherwise.

ResetLightList

public boolean ResetLightList()
Reset the light list to the default light list.

Returns:
true on success; false otherwise.

ResetPickLetter

public boolean ResetPickLetter()
Reset the pick letter so the next pick letter will be 'A'.

Returns:
true on success; false otherwise.

RenamePickLabel

public boolean RenamePickLabel(java.lang.String oldLabel,
                               java.lang.String newLabel)
Rename Pick Label

Parameters:
oldLabel - The old label.
newLabel - The new label.
Returns:
true on success; false otherwise.

ResetPickAttributes

public boolean ResetPickAttributes()
Reset the pick attributes to the defaults.

Returns:
true on success; false otherwise.

SetActiveContinuousColorTable

public boolean SetActiveContinuousColorTable(java.lang.String colorTableName)
Set the active continuous color table, which is the color table to be used in plots such as Pseudocolor and Surface when their plot attributes are set to use the "default" color table. A continuous color table is one that interpolates between the small set of colors that make up its definition to create smooth transitions between colors.

Parameters:
colorTableName - The name of the color table to use as the default continuous color table. The name must be present in the names stored in the ColorTableAttributes state object.
Returns:
true on success; false otherwise.

SetActiveDiscreteColorTable

public boolean SetActiveDiscreteColorTable(java.lang.String colorTableName)
Set the active discrete color table, which is the color table to be used in plots such as Subset and FilledBoundary when their plot attributes are set to use the "default" color table. A discrete color table is a set of colors that repeat mod the number of colors in the color table.

Parameters:
colorTableName - The name of the color table to use as the default discrete color table. The name must be present in the names stored in the ColorTableAttributes state object.
Returns:
true on success; false otherwise.

DeleteColorTable

public boolean DeleteColorTable(java.lang.String colorTableName)
Delete the named color table.

Parameters:
colorTableName - The name of the color table to delete. The name must be present in the names stored in the ColorTableAttributes state object.
Returns:
true on success; false otherwise.

UpdateColorTable

public boolean UpdateColorTable(java.lang.String colorTableName)
Applies the ColorTableAttributes that were previously sent and updates any plots that use the color table that was modified. Example:

ColorTableAttributes atts = proxy.GetViewerState().GetColorTableAttributes();
ColorControlPointList ct = atts.GetColorControlPoints("hot"); // Modify the ct here... (not shown)
atts.SelectAll(); atts.Notify();
proxy.GetViewerMethods().UpdateColorTable("hot");

Parameters:
colorTableName - The name of the color table to update. The name must be present in the names stored in the ColorTableAttributes state object.
Returns:
true on success; false otherwise.

ExportColorTable

public boolean ExportColorTable(java.lang.String colorTableName)
Exports the specified color table to a file in the user's .visit directory. This function exists to make it easy for users to exchange color tables. When color table (*.ct) files are located in the user's .visit directory, the color tables are loaded when VisIt starts up.

Parameters:
colorTableName - The name of the color table to update. The name must be present in the names stored in the ColorTableAttributes state object.
Returns:
true on success; false otherwise.

InvertBackgroundColor

public boolean InvertBackgroundColor()
Reverses the visualization window's foreground and background colors.

Returns:
true on success; false otherwise.

SetDefaultFileOptions

public boolean SetDefaultFileOptions()
Applies the default file opening options which were previously sent. The file opening options allow the user to provide options that are used by database plugins when opening files. Example:

FileOpenOptions atts = proxy.GetViewerState().GetFileOpenOptions();
// Modify the atts here... (not shown)
atts.Notify();
proxy.GetViewerMethods().SetDefaultFileOptions();

Returns:
true on success; false otherwise.

WriteConfigFile

public boolean WriteConfigFile()
Saves the viewer's settings file, which is called ~/.visit/config and contains default values for state objects.

Returns:
true on success; false otherwise.

ExportEntireState

public boolean ExportEntireState(java.lang.String filename)
Saves a session file containing all of the default settings for the viewer as well as all information needed to recreate the plots in all visualization windows in future VisIt sessions.

Parameters:
filename - The name of the local file to which the session information will be saved.
Returns:
true on success; false otherwise.

ImportEntireState

public boolean ImportEntireState(java.lang.String filename,
                                 boolean inVisItDir)
Restores a session file, which causes VisIt to delete all plots and recreate the plots described in the session file.

Parameters:
filename - The name of the local file from which the session information will be loaded.
inVisItDir - true if the session file exists in ~/.visit/; otherwise false and the filename must contain the entire path to the session file.
Returns:
true on success; false otherwise.

ImportEntireStateWithDifferentSources

public boolean ImportEntireStateWithDifferentSources(java.lang.String filename,
                                                     boolean inVisItDir,
                                                     java.util.Vector sources)
Restores a session file, which causes VisIt to delete all plots and recreate the plots described in the session file but different databases will be used instead of the databases saved in the session file.

Parameters:
filename - The name of the local file from which the session information will be loaded.
inVisItDir - true if the session file exists in ~/.visit/; otherwise false and the filename must contain the entire path to the session file.
sources - A vector of String objects containing the names of the databases that will be used to restore the session. The vector must contain the same number of sources as the session file for the session to be restored properly.
Returns:
true on success; false otherwise.

ReadHostProfilesFromDirectory

public boolean ReadHostProfilesFromDirectory(java.lang.String dir,
                                             boolean clear)
Tells the viewer to read host profiles from a specific directory.

Parameters:
dir - The directory from which host profiles will be read.
clear - Whether to clear the list prior to reading
Returns:
true on success; false otherwise.

SetCenterOfRotation

public boolean SetCenterOfRotation(double x,
                                   double y,
                                   double z)
Sets the center of rotation, which is the point about which VisIt rotates plots when you interactively rotate using the mouse. This option is especially useful when you have zoomed into a small area and want to rotate the plots.

Parameters:
x - The x location of the new center of rotation.
y - The y location of the new center of rotation.
z - The z location of the new center of rotation.
Returns:
true on success; false otherwise.

ChooseCenterOfRotation

public boolean ChooseCenterOfRotation()
Lets the user interactively choose a center of rotation using pick. The center of rotation is the point about which VisIt rotates plots when you interactively rotate using the mouse

Returns:
true on success; false otherwise.

ChooseCenterOfRotation

public boolean ChooseCenterOfRotation(double sx,
                                      double sy)
Sets the center of rotation as the 3D point that is under the 2D screen coordinate that specifies a location within the visualization window.

Parameters:
sx - The x location in the visualization window
sy - The y location in the visualization window
Returns:
true on success; false otherwise.

SetViewAxisArray

public boolean SetViewAxisArray()
Applies the view axis array view object which was previously sent. This type of view is strictly for controlling the view in the ParallelCoordinates plot. Example:

ViewAxisAttributes atts = proxy.GetViewerState().GetViewAxisAttributes();
// Modify the atts here... (not shown)
atts.Notify();
proxy.GetViewerMethods().SetViewAxisArray();

Returns:
true on success; false otherwise.

SetViewCurve

public boolean SetViewCurve()
Applies the curve view object which was previously sent. The ViewCurveAttributes object controls the view for Curve plots. Example:

ViewCurveAttributes atts = proxy.GetViewerState().GetViewCurveAttributes();
// Modify the atts here... (not shown)
atts.Notify();
proxy.GetViewerMethods().SetViewCurve();

Returns:
true on success; false otherwise.

SetView2D

public boolean SetView2D()
Applies the 2D view object which was previously sent. The View2DAttributes object controls the view for all 2D plots in a visualization window. Example:

View2DAttributes atts = proxy.GetViewerState().GetView2DAttributes();
// Modify the atts here... (not shown)
atts.Notify();
proxy.GetViewerMethods().SetView2D();

Returns:
true on success; false otherwise.

SetView3D

public boolean SetView3D()
Applies the 3D view object which was previously sent. The View2DAttributes object controls the view for all 3D plots in a visualization window. Example:

View3DAttributes atts = proxy.GetViewerState().GetView3DAttributes();
// Modify the atts here... (not shown)
atts.Notify();
proxy.GetViewerMethods().SetView3D();

Returns:
true on success; false otherwise.

ClearViewKeyframes

public boolean ClearViewKeyframes()

DeleteViewKeyframe

public boolean DeleteViewKeyframe(int frame)

MoveViewKeyframe

public boolean MoveViewKeyframe(int oldFrame,
                                int newFrame)

SetViewKeyframe

public boolean SetViewKeyframe()

ResetView

public boolean ResetView()
Recalculates a suitable default view for the visualization window and applies that view.

Returns:
true on success; false otherwise.

RecenterView

public boolean RecenterView()
Recenters the objects so they fit in the visualization window.

Returns:
true on success; false otherwise.

SetViewExtentsType

public boolean SetViewExtentsType(int t)
Sets whether the view is calculated using actual or original spatial extents.

Parameters:
t - 0=original extents, 1=actual extents
Returns:
true on success; false otherwise.

ToggleAllowPopup

public boolean ToggleAllowPopup()
Toggles the Right-click popup menu.

Returns:
true on success; false otherwise.

ToggleMaintainViewMode

public boolean ToggleMaintainViewMode()
Toggles the maintain view mode, which ensures that the view remains constant (when turned on).

Returns:
true on success; false otherwise.

ToggleFullFrameMode

public boolean ToggleFullFrameMode()
Toggles full frame mode, which is a 1D/2D window mode that exagerrates scale in one or more dimensions to ensure that plots take up most of the visualization window viewport.

Returns:
true on success; false otherwise.

UndoView

public boolean UndoView()
Undo the last view change, returning to the previous view.

Returns:
true on success; false otherwise.

RedoView

public boolean RedoView()
Redo the last view undo.

Returns:
true on success; false otherwise.

ToggleLockViewMode

public boolean ToggleLockViewMode()
Toggles the lock view mode. When visualization windows have their views locked, changes to the view in one window are also made in other visualization windows whose plot dimensions are equal to the window that originated the view change.

Returns:
true on success; false otherwise.

ToggleLockTime

public boolean ToggleLockTime()
Toggles the lock time mode. When visualization windows have their time sliders locked, changing the time slider in one window will cause other time-locked windows that have compatible database correlations to also update in time.

Returns:
true on success; false otherwise.

TurnOffAllLocks

public boolean TurnOffAllLocks()
Turns off all forms of locking in all windows.

Returns:
true on success; false otherwise.

ToggleLockTools

public boolean ToggleLockTools()
Toggles the lock tools mode. When visualization windows have their tools locked, interacting with a tool in one window will cause the tool attributes to be applied to other windows whose tools are locked. This setting is used for operations such as moving a 3D plane tool in one window to set the Slice operator attributes in another visualization window.

Returns:
true on success; false otherwise.

ToggleSpinMode

public boolean ToggleSpinMode()
Toggles spin mode in the active visualization window. Spin mode causes plots to keep spinning when you rotate them interactively.

Returns:
true on success; false otherwise.

ToggleCameraViewMode

public boolean ToggleCameraViewMode()
Toggles camera view mode, which indicates that the camera should be copied into the view during keyframe animations.

Returns:
true on success; false otherwise.

SetWindowMode

public boolean SetWindowMode(int mode)
Sets the window mode for the active visualization window.

Parameters:
mode - 0=navigate, 1=zone pick, 2=node pick, 3=zoom, 4=lineout
Returns:
true on success; false otherwise.

ToggleBoundingBoxMode

public boolean ToggleBoundingBoxMode()
Toggles bounding box mode for the active visualization window. When a window is in bounding box mode, its plots are replaced with a bounding box during rotation so rotations are much faster. This option is helpful with scalable rendering.

Returns:
true on success; false otherwise.

EnableTool

public boolean EnableTool(int tool,
                          boolean enabled)
Enables or disables an interactive tool in the active visualization window.

Parameters:
tool - 0=Box, 1=Line, 2=Plane, 3=Sphere, 4=Point, 5=Extents, 6=Axis restriction
enabled - true to enable the tool; false to disable.
Returns:
true on success; false otherwise.

CopyViewToWindow

public boolean CopyViewToWindow(int from,
                                int to)
Copies the view from one visualization window to another.

Parameters:
from - Source visualization window (>=1).
to - Destination visualization window (>=1), (from != to)
Returns:
true on success; false otherwise.

CopyLightingToWindow

public boolean CopyLightingToWindow(int from,
                                    int to)
Copies the lighting from one visualization window to another.

Parameters:
from - Source visualization window (>=1).
to - Destination visualization window (>=1), (from != to)
Returns:
true on success; false otherwise.

CopyAnnotationsToWindow

public boolean CopyAnnotationsToWindow(int from,
                                       int to)
Copies the annotations from one visualization window to another.

Parameters:
from - Source visualization window (>=1).
to - Destination visualization window (>=1), (from != to)
Returns:
true on success; false otherwise.

CopyPlotsToWindow

public boolean CopyPlotsToWindow(int from,
                                 int to)
Copies the plots from one visualization window to another.

Parameters:
from - Source visualization window (>=1).
to - Destination visualization window (>=1), (from != to)
Returns:
true on success; false otherwise.

SetPlotSILRestriction

public boolean SetPlotSILRestriction()
Sets the SIL restriction that was previously sent. A SIL is a data structure that describes how a dataset is put together, with sets as leaves, A SIL restriction is a SIL that is augmented with a list of boolean values indicating which sets are on and which are off. VisIt uses the SIL restriction to turn off domains, materials, etc. Note -- The SIL restriction would have to be sent to the viewer in its compacted form since no avtSILRestriction object yet exists in the Java API.

Returns:
true on success; false otherwise.

ProcessExpressions

public boolean ProcessExpressions()
Applies the expression list that was previously sent. This method is called after you make changes to the expression list, which is a list of expression definitions that VisIt can use for plotting.
Examples:

ExpressionList atts = proxy.GetViewerState().GetExpressionList();
// Modify the atts here... (not shown)
atts.Notify();
proxy.GetViewerMethods().ProcessExpressions();

Returns:
true on success; false otherwise.

SetAppearanceAttributes

public boolean SetAppearanceAttributes()
Applies the appearance attributes that were previously sent. This method is called after you make changes to the appearance attributes, an object that allows you to set GUI properties such as color and font.
Examples:

AppearanceAttributes atts = proxy.GetViewerState().GetAppearanceAttributes();
// Modify the atts here... (not shown)
atts.Notify();
proxy.GetViewerMethods().SetAppearanceAttributes();

Returns:
true on success; false otherwise.

ClearPickPoints

public boolean ClearPickPoints()
Clear all pick points from the visualization window.

Returns:
true on success; false otherwise.

ClearReferenceLines

public boolean ClearReferenceLines()
Clear all reference lines from the visualization window.

Returns:
true on success; false otherwise.

SetRenderingAttributes

public boolean SetRenderingAttributes()
Applies the rendering attributes that were previously sent.
Examples:

RenderingAttributes atts = proxy.GetViewerState().GetRenderingAttributes();
// Modify the atts here... (not shown)
atts.Notify();
proxy.GetViewerMethods().SetRenderingAttributes();

Returns:
true on success; false otherwise.

SetWindowArea

public void SetWindowArea(int x,
                          int y,
                          int w,
                          int h)
Set the area of the screen that will be used for visualization windows. Note - the size of visualization windows in the window area is determined by VisIt and the window layout. Use ResizeWindow if you want to resize the visualization windows yourself.

Parameters:
x - The x location of the upper left corner of the window area.
y - The y location of the upper left corner of the window area.
w - The width of the window area.
h - The height of the window area.

Query

public boolean Query(MapNode queryParams)
Performs a query

Parameters:
queryParams - The arguments to the query that we'll perform.
Returns:
true on success; false otherwise.

GetQueryParams

public boolean GetQueryParams(java.lang.String queryName)
Tell the viewer to retrieve the default parameters for the named query.

Returns:
true on success; false otherwise.

Pick

public boolean Pick(int x,
                    int y,
                    java.util.Vector vars)
Perform a screen pick

Parameters:
x - The screen X coordinate of the pixel on which to pick.
y - The screen Y coordinate of the pixel on which to pick.
vars - A vector of String containing the variables we'll pick.

Lineout

public boolean Lineout(double x0,
                       double y0,
                       double x1,
                       double y1,
                       java.util.Vector vars)
Perform a screen pick

Parameters:
x0 - The global X coordinate of the line start point.
y0 - The global Y coordinate of the line start point.
x1 - The global X coordinate of the line end point.
y1 - The global Y coordinate of the line end point.
vars - A vector of String containing the variables we'll pick.

SetGlobalLineoutAttributes

public boolean SetGlobalLineoutAttributes()
Applies the global lineout attributes that were previously sent.
Examples:

GlobalLineoutAttributes atts = proxy.GetViewerState().GetGlobalLineoutAttributes();
// Modify the atts here... (not shown)
atts.Notify();
proxy.GetViewerMethods().SetGlobalLineoutAttributes();

Returns:
true on success; false otherwise.

SetDefaultPickAttributes

public boolean SetDefaultPickAttributes()
Makes the pick attributes be the default pick attributes to be used for new visualization windows and in the saved settings.

Returns:
true on success; false otherwise.

SetPickAttributes

public boolean SetPickAttributes()
Applies the pick attributes that were previously sent. The pick attributes mainly control the formatting options for VisIt's pick capability.
Examples:

PickAttributes atts = proxy.GetViewerState().GetPickAttributes();
// Modify the atts here... (not shown)
atts.Notify();
proxy.GetViewerMethods().SetPickAttributes();

Returns:
true on success; false otherwise.

ResetQueryOverTimeAttributes

public boolean ResetQueryOverTimeAttributes()
Resets the query over time attributes to their default values.

Returns:
true on success; false otherwise.

SetDefaultQueryOverTimeAttributes

public boolean SetDefaultQueryOverTimeAttributes()
Makes the query over time attributes be the default query over time attributes to be used for saved settings.

Returns:
true on success; false otherwise.

SetQueryOverTimeAttributes

public boolean SetQueryOverTimeAttributes()
Applies the query over time attributes that were previously sent. The query over time attributes affect VisIt's behavior when performing queries that can be made over time to yield curves, etc.
Examples:

QueryOverTimeAttributes atts = proxy.GetViewerState().GetQueryOverTimeAttributes();
// Modify the atts here... (not shown)
atts.Notify();
proxy.GetViewerMethods().SetQueryOverTimeAttributes();

Returns:
true on success; false otherwise.

SetTryHarderCyclesTimes

public boolean SetTryHarderCyclesTimes(int flag)
Sets whether VisIt should invest in the extra effort needed to return valid cycles and times from virtual databases composed of many single time step files.

Parameters:
flag - true if VisIt should take the extra effort, which can be significant; false otherwise.
Returns:
true on success; false otherwise.

SetTreatAllDBsAsTimeVarying

public boolean SetTreatAllDBsAsTimeVarying(int flag)
Sets whether VisIt should treat all time-varying databases as having dynamic metadata. This option forces the variable lists to be refreshed each time the user changes the time state for the active database. This option can often have a negative performance impact but it allows you to acquire variables that appear later in the file sequence that makes up the database.

Parameters:
flag - true if VisIt should treat all databases as having dynamic metadata.
Returns:
true on success; false otherwise.

ResetLineoutColor

public boolean ResetLineoutColor()
Resets the lineout color the initial lineout color.

Returns:
true on success; false otherwise.

ResetInteractorAttributes

public boolean ResetInteractorAttributes()
Resets the interactor attributes to their defaults.

Returns:
true on success; false otherwise.

SetDefaultInteractorAttributes

public boolean SetDefaultInteractorAttributes()
Set the default interactor attributes.

Returns:
true on success; false otherwise.

SetInteractorAttributes

public boolean SetInteractorAttributes()
Applies the interactor attributes that were previously sent. The interactor attributes govern the behavior of VisIt's navigation and zoom window modes.
Examples:

InteractorAttributes atts = proxy.GetViewerState().GetInteractorAttributes();
// Modify the atts here... (not shown)
atts.Notify();
proxy.GetViewerMethods().SetInteractorAttributes();

Returns:
true on success; false otherwise.

QueryProcessAttributes

public boolean QueryProcessAttributes(int id,
                                      java.lang.String engineHostName,
                                      java.lang.String engineDBName)
Returns process information related to a particular VisIt component

Parameters:
id - ???
engineHostName - The name of the computer running the compute engine.
engineDBName - The name of the engine's active database.
Returns:
true on success; false otherwise.

SendSimulationCommand

public boolean SendSimulationCommand(java.lang.String hostName,
                                     java.lang.String simName,
                                     java.lang.String command,
                                     java.lang.String argument)
Sends a command to a connected simulation.

Parameters:
hostName - The name of the computer where the simulation is running.
simName - The name of the simulation.
command - The name of the command to send to the simulation.
argument - The arguments to the command encoded as a string.
Returns:
true on success; false otherwise.

SendSimulationCommand

public boolean SendSimulationCommand(java.lang.String hostName,
                                     java.lang.String simName,
                                     java.lang.String command)
Sends a command to a connected simulation.

Parameters:
hostName - The name of the computer where the simulation is running.
simName - The name of the simulation.
command - The name of the command to send to the simulation.
Returns:
true on success; false otherwise.

OpenClient

public boolean OpenClient(java.lang.String clientName,
                          java.lang.String program,
                          java.util.Vector args)
Opens another VisIt client such as the GUI or CLI. This method allows one VisIt client to open another by telling the viewer to reverse launch the client.

Parameters:
clientName - The name to use to identify the new client.
program - The program to execute
args - Additional command line arguments to be passed to the client.
Returns:
true on success; false otherwise.

SuppressQueryOutput

public boolean SuppressQueryOutput(boolean onOff)
Turns off query output so it does not get printed.

Parameters:
onOff - true turns off query output; false turns it on.
Returns:
true on success; false otherwise.

SetQueryFloatFormat

public boolean SetQueryFloatFormat(java.lang.String format)
Sets the format string used for floating point numbers when creating query output strings. This method allows you to control the precision.

Parameters:
format - A valid C-style format string for floating point numbers.
Returns:
true on success; false otherwise.

SetCreateMeshQualityExpressions

public boolean SetCreateMeshQualityExpressions(boolean flag)
Sets whether VisIt will automatically create mesh quality expressions.

Parameters:
flag - true means that the expressions will be created; false otherwise.
Returns:
true on success; false otherwise.

SetCreateTimeDerivativeExpressions

public boolean SetCreateTimeDerivativeExpressions(boolean flag)
Sets whether VisIt will automatically create time-derivative expressions.

Parameters:
flag - true means that the expressions will be created; false otherwise.
Returns:
true on success; false otherwise.

SetCreateVectorMagnitudeExpressions

public boolean SetCreateVectorMagnitudeExpressions(boolean flag)
Sets whether VisIt will automatically create vector magnitude expressions.

Parameters:
flag - true means that the expressions will be created; false otherwise.
Returns:
true on success; false otherwise.

SetPrecisionType

public boolean SetPrecisionType(int flag)
Sets the precision type used in the pipeline.

Parameters:
flag - The requested precision (0 = FLOAT, 1 = NATIVE, 2 = DOUBLE)
Returns:
true on success; false otherwise.

SetBackendType

public boolean SetBackendType(int flag)
Sets the backend type used in the pipeline.

Parameters:
flag - The requested backend type (0 = VTK, 1 = DAX, 2 = EAVL, 3 = PISTON)
Returns:
true on success; false otherwise.

SetRemoveDuplciateNodes

public boolean SetRemoveDuplciateNodes(boolean flag)
Sets whether VisIt will automatically remove duplicate nodes from fully disconnected unstructured grids.

Parameters:
flag - true means that duplicate nodes will be removed
Returns:
true on success; false otherwise.

SetSuppressMessages

public boolean SetSuppressMessages(boolean flag)
Sets whether VisIt will will suppress messages that would ordinarily be sent to clients.

Parameters:
flag - true means that the messages will be suppressed and remain suppressed until this method is called again with a value of false.
Returns:
true on success; false otherwise.