This class is the crux of the ParaView application. More...
#include <pqApplicationCore.h>
Public Slots | |
void | prepareForQuit () |
Applications calls this to ensure that any cleanup is performed correctly. More... | |
void | quit () |
Calls QCoreApplication::quit(). More... | |
void | loadConfiguration (const QString &filename) |
Load configuration xml. More... | |
void | loadConfigurationXML (const char *xmldata) |
void | render () |
Renders all windows. More... | |
Signals | |
void | aboutToLoadState (vtkPVXMLElement *root) |
Fired before a state xml is being loaded. More... | |
void | stateLoaded (vtkPVXMLElement *root, vtkSMProxyLocator *locator) |
Fired when a state file is loaded successfully. More... | |
void | stateSaved (vtkPVXMLElement *root) |
Fired to save state xml. More... | |
void | undoStackChanged (pqUndoStack *) |
Fired when the undo stack is set. More... | |
void | loadXML (vtkPVXMLElement *) |
Fired on loadConfiguration(). More... | |
void | forceFilterMenuRefresh () |
Fired when the filter menu state needs to be manually updated. More... | |
void | updateMasterEnableState (bool) |
Fired when master changed. More... | |
void | clientEnvironmentDone () |
Fired when the ParaView Client infrastructure has completed setting up the environment. More... | |
Public Member Functions | |
pqApplicationCore (int &argc, char **argv, pqOptions *options=0, QObject *parent=0) | |
Preferred constructor. More... | |
pqOptions * | getOptions () const |
Provides access to the command line options object. More... | |
pqObjectBuilder * | getObjectBuilder () const |
Get the Object Builder. More... | |
void | setUndoStack (pqUndoStack *stack) |
Set/Get the application's central undo stack. More... | |
pqUndoStack * | getUndoStack () const |
void | registerManager (const QString &function, QObject *manager) |
Custom Applications may need use various "managers" All such manager can be registered with the pqApplicationCore so that that can be used by other components of the application. More... | |
QObject * | manager (const QString &function) |
Returns a manager for a particular function, if any. More... | |
void | unRegisterManager (const QString &function) |
Unregisters a manager for a particular function, if any. More... | |
void | registerDocumentation (const QString &filename) |
QHelpEngine doesn't like filenames in resource space. More... | |
pqServerManagerObserver * | getServerManagerObserver () |
ServerManagerObserver observer the vtkSMProxyManager for changes to the server manager and fires signals on certain actions such as registeration/unregistration of proxies etc. More... | |
pqServerManagerModel * | getServerManagerModel () const |
ServerManagerModel is the representation of the ServerManager using pqServerManagerModelItem subclasses. More... | |
pqInterfaceTracker * | interfaceTracker () const |
Locates the interface tracker for the application. More... | |
pqLinksModel * | getLinksModel () const |
pqLinksModel is the model used to keep track of proxy/property links maintained by vtkSMProxyManager. More... | |
pqMainWindowEventManager * | getMainWindowEventManager () const |
pqMainWindowManager manages signals called for main window events. More... | |
pqPluginManager * | getPluginManager () const |
pqPluginManager manages all functionality associated with loading plugins. More... | |
pqProgressManager * | getProgressManager () const |
ProgressManager is the manager that streamlines progress. More... | |
virtual pqTestUtility * | testUtility () |
Provides access to the test utility. More... | |
pqRecentlyUsedResourcesList & | recentlyUsedResources () |
Returns the set of recently-used resources i.e. More... | |
pqServerConfigurationCollection & | serverConfigurations () |
Returns the collection of server configurations known. More... | |
pqSettings * | settings () |
Get the application settings. More... | |
void | clearSettings () |
Clears the settings. More... | |
vtkPVXMLElement * | saveState () |
Save the ServerManager state to a XML element. More... | |
bool | saveState (const QString &filename) |
Save the ServerManager state to a file. More... | |
void | loadState (vtkPVXMLElement *root, pqServer *server, vtkSMStateLoader *loader=NULL) |
Loads the ServerManager state. More... | |
void | loadState (const char *filename, pqServer *server, vtkSMStateLoader *loader=NULL) |
Load state xml from a file. More... | |
void | loadStateFromString (const char *xmlcontents, pqServer *server, vtkSMStateLoader *loader=NULL) |
Loads state from an in-memory buffer. More... | |
void | clearViewsForLoadingState (pqServer *server) |
void | loadStateIncremental (vtkPVXMLElement *root, pqServer *server, vtkSMStateLoader *loader=NULL) |
Same as loadState() except that it doesn't clear the current visualization state. More... | |
void | loadStateIncremental (const QString &filename, pqServer *server, vtkSMStateLoader *loader=NULL) |
void | setLoadingState (bool value) |
Set the loading state flag. More... | |
bool | isLoadingState () |
Check to see if its in the process of loading a state Reliance on this flag is chimerical since we cannot set this ivar when state file is being loaded from python shell. More... | |
pqServer * | getActiveServer () const |
returns the active server is any. More... | |
~pqApplicationCore () override | |
Destructor. More... | |
void | _paraview_client_environment_complete () |
INTERNAL. More... | |
Static Public Member Functions | |
static pqApplicationCore * | instance () |
Protected Slots | |
void | onStateLoaded (vtkPVXMLElement *root, vtkSMProxyLocator *locator) |
void | onStateSaved (vtkPVXMLElement *root) |
void | onHelpEngineWarning (const QString &) |
This class is the crux of the ParaView application.
It creates and manages various managers which are necessary for the ParaView-based client to work with the ServerManager. For clients based of the pqCore library, simply instantiate this pqApplicationCore after QApplication initialization and then create your main window etc. like a standard Qt application. You can then use the facilities provided by pqCore such as the pqObjectBuilder, pqUndoStack etc. in your application. After that point.
Definition at line 76 of file pqApplicationCore.h.
pqApplicationCore::pqApplicationCore | ( | int & | argc, |
char ** | argv, | ||
pqOptions * | options = 0 , |
||
QObject * | parent = 0 |
||
) |
Preferred constructor.
Initializes the server-manager engine and sets up the core functionality. If application supports special command line options, pass an instance of pqOptions subclass to the constructor, otherwise a new instance of pqOptions with standard ParaView command line options will be created.
|
override |
Destructor.
|
static |
|
inline |
Provides access to the command line options object.
Definition at line 97 of file pqApplicationCore.h.
|
inline |
Get the Object Builder.
Object Buider must be used to create complex objects such as sources, filters, readers, views, displays etc.
Definition at line 104 of file pqApplicationCore.h.
void pqApplicationCore::setUndoStack | ( | pqUndoStack * | stack | ) |
Set/Get the application's central undo stack.
By default no undo stack is provided. Applications must set on up as required.
|
inline |
Definition at line 111 of file pqApplicationCore.h.
void pqApplicationCore::registerManager | ( | const QString & | function, |
QObject * | manager | ||
) |
Custom Applications may need use various "managers" All such manager can be registered with the pqApplicationCore so that that can be used by other components of the application.
Registering with pqApplicationCore gives easy access to these managers from the application code. Note that custom applications are not required to register managers. However certain optional components of the pqCore may expect some managers. Only one manager can be registered for a function
.
QObject* pqApplicationCore::manager | ( | const QString & | function | ) |
Returns a manager for a particular function, if any.
void pqApplicationCore::unRegisterManager | ( | const QString & | function | ) |
Unregisters a manager for a particular function, if any.
void pqApplicationCore::registerDocumentation | ( | const QString & | filename | ) |
QHelpEngine doesn't like filenames in resource space.
This method creates a temporary file for the resource and registers that with the QHelpEngine.
|
inline |
ServerManagerObserver observer the vtkSMProxyManager for changes to the server manager and fires signals on certain actions such as registeration/unregistration of proxies etc.
Returns the ServerManagerObserver used by the application.
Definition at line 157 of file pqApplicationCore.h.
|
inline |
ServerManagerModel is the representation of the ServerManager using pqServerManagerModelItem subclasses.
It makes it possible to explore the ServerManager with ease by separating proxies based on their functionality/type.
Definition at line 165 of file pqApplicationCore.h.
|
inline |
Locates the interface tracker for the application.
pqInterfaceTracker is used to locate all interface implementations typically loaded from plugins.
Definition at line 172 of file pqApplicationCore.h.
|
inline |
pqLinksModel is the model used to keep track of proxy/property links maintained by vtkSMProxyManager.
TODO: It may be worthwhile to investigate if we even need a global pqLinksModel. All the information is already available in vtkSMProxyManager.
Definition at line 181 of file pqApplicationCore.h.
|
inline |
pqMainWindowManager manages signals called for main window events.
Definition at line 186 of file pqApplicationCore.h.
|
inline |
pqPluginManager manages all functionality associated with loading plugins.
Definition at line 194 of file pqApplicationCore.h.
|
inline |
ProgressManager is the manager that streamlines progress.
Definition at line 199 of file pqApplicationCore.h.
|
virtual |
Provides access to the test utility.
Reimplemented in pqPVApplicationCore.
pqRecentlyUsedResourcesList& pqApplicationCore::recentlyUsedResources | ( | ) |
Returns the set of recently-used resources i.e.
data files and state files.
pqServerConfigurationCollection& pqApplicationCore::serverConfigurations | ( | ) |
Returns the collection of server configurations known.
Server configurations have information about connecting to different servers.
pqSettings* pqApplicationCore::settings | ( | ) |
Get the application settings.
void pqApplicationCore::clearSettings | ( | ) |
Clears the settings.
Since various UI components that only read settings at creation time may get out of sync, it's best to warn the user to restart the application.
Any changes made to pqSettings after calling this method will be lost and will not get restored. If that's not desired, see QSettings::clear
.
vtkPVXMLElement* pqApplicationCore::saveState | ( | ) |
Save the ServerManager state to a XML element.
bool pqApplicationCore::saveState | ( | const QString & | filename | ) |
Save the ServerManager state to a file.
Return true if the operation succeeded otherwise return false.
void pqApplicationCore::loadState | ( | vtkPVXMLElement * | root, |
pqServer * | server, | ||
vtkSMStateLoader * | loader = NULL |
||
) |
Loads the ServerManager state.
Emits the signal stateLoaded() on loading state successfully.
void pqApplicationCore::loadState | ( | const char * | filename, |
pqServer * | server, | ||
vtkSMStateLoader * | loader = NULL |
||
) |
Load state xml from a file.
The filename can be a Qt resource file, besides regular filesystem files (refer to QFile documentation for more information on Qt resource system).
void pqApplicationCore::loadStateFromString | ( | const char * | xmlcontents, |
pqServer * | server, | ||
vtkSMStateLoader * | loader = NULL |
||
) |
Loads state from an in-memory buffer.
void pqApplicationCore::clearViewsForLoadingState | ( | pqServer * | server | ) |
void pqApplicationCore::loadStateIncremental | ( | vtkPVXMLElement * | root, |
pqServer * | server, | ||
vtkSMStateLoader * | loader = NULL |
||
) |
Same as loadState() except that it doesn't clear the current visualization state.
void pqApplicationCore::loadStateIncremental | ( | const QString & | filename, |
pqServer * | server, | ||
vtkSMStateLoader * | loader = NULL |
||
) |
|
inline |
Set the loading state flag.
Definition at line 277 of file pqApplicationCore.h.
|
inline |
Check to see if its in the process of loading a state Reliance on this flag is chimerical since we cannot set this ivar when state file is being loaded from python shell.
Definition at line 284 of file pqApplicationCore.h.
pqServer* pqApplicationCore::getActiveServer | ( | ) | const |
returns the active server is any.
void pqApplicationCore::_paraview_client_environment_complete | ( | ) |
INTERNAL.
Do not use.
|
slot |
Applications calls this to ensure that any cleanup is performed correctly.
|
slot |
Calls QCoreApplication::quit().
|
slot |
Load configuration xml.
This results in firing of the loadXML() signal which different components that support configuration catch and process to update their behavior.
|
slot |
|
slot |
Renders all windows.
|
signal |
Fired before a state xml is being loaded.
One can add slots for this signal and modify the fired xml-element as part of pre-processing before attempting to load the state xml. Note that never attempt to connect to signal in a delayed fashion i.e using Qt::QueuedConnection etc. since the root
will be destroyed.
|
signal |
Fired when a state file is loaded successfully.
GUI components that may have state saved in the XML state file must listen to this signal and handle process the XML to update their state.
|
signal |
Fired to save state xml.
Components that need to save XML state should listen to this signal and add their XML elements to the root. DO NOT MODIFY THE ROOT besides adding new children.
|
signal |
Fired when the undo stack is set.
|
signal |
Fired on loadConfiguration().
|
signal |
Fired when the filter menu state needs to be manually updated.
|
signal |
Fired when master changed.
true if current user is master, false otherwise.
|
signal |
Fired when the ParaView Client infrastructure has completed setting up the environment.
|
protectedslot |
|
protectedslot |
|
protectedslot |
|
protected |
Definition at line 391 of file pqApplicationCore.h.
|
protected |
Definition at line 393 of file pqApplicationCore.h.
|
protected |
Definition at line 394 of file pqApplicationCore.h.
|
protected |
Definition at line 395 of file pqApplicationCore.h.
|
protected |
Definition at line 396 of file pqApplicationCore.h.
|
protected |
Definition at line 397 of file pqApplicationCore.h.
|
protected |
Definition at line 398 of file pqApplicationCore.h.
|
protected |
Definition at line 399 of file pqApplicationCore.h.
|
protected |
Definition at line 400 of file pqApplicationCore.h.
|
protected |
Definition at line 401 of file pqApplicationCore.h.
|
protected |
Definition at line 402 of file pqApplicationCore.h.
|
protected |
Definition at line 403 of file pqApplicationCore.h.
|
protected |
Definition at line 404 of file pqApplicationCore.h.
|
protected |
Definition at line 405 of file pqApplicationCore.h.
|
protected |
Definition at line 409 of file pqApplicationCore.h.