This class is the crux of the ParaView application. More...

#include <pqApplicationCore.h>

Inheritance diagram for pqApplicationCore:

Collaboration diagram for pqApplicationCore:

Public Slots
void	prepareForQuit ()
	Applications calls this to ensure that any cleanup is performed correctly.
void	quit ()
	Calls QCoreApplication::quit().
void	showOutputWindow ()
	Causes the output window to be shown.
void	loadConfiguration (const QString &filename)
	Load configuration xml.
void	render ()
	Renders all windows.
Signals
void	aboutToLoadState (vtkPVXMLElement *root)
	Fired before a state xml is being loaded.
void	stateLoaded (vtkPVXMLElement root, vtkSMProxyLocator locator)
	Fired when a state file is loaded successfully.
void	stateSaved (vtkPVXMLElement *root)
	Fired to save state xml.
void	undoStackChanged (pqUndoStack *)
	Fired when the undo stack is set.
void	loadXML (vtkPVXMLElement *)
	Fired on loadConfiguration().
void	forceFilterMenuRefresh ()
	Fired when the filter menu state needs to be manually updated.
void	updateMasterEnableState (bool)
	Fired when master changed. true if current user is master, false otherwise.
Public Member Functions
	pqApplicationCore (int &argc, char *argv, pqOptions options=0, QObject *parent=0)
	Preferred constructor.
void	disableOutputWindow ()
	Dangerous option that disables the debug output window, intended for demo purposes only.
pqOptions *	getOptions () const
	Provides access to the command line options object.
pqObjectBuilder *	getObjectBuilder () const
	Get the Object Builder.
void	setUndoStack (pqUndoStack *stack)
	Set/Get the application's central undo stack.
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.
QObject *	manager (const QString &function)
	Returns a manager for a particular function, if any.
void	unRegisterManager (const QString &function)
	Unregisters a manager for a particular function, if any.
QHelpEngine *	helpEngine ()
	provides access to the help engine.
void	registerDocumentation (const QString &filename)
	QHelpEngine doesn't like filenames in resource space.
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.
pqServerManagerModel *	getServerManagerModel () const
	ServerManagerModel is the representation of the ServerManager using pqServerManagerModelItem subclasses.
pq3DWidgetFactory *	get3DWidgetFactory () const
pqInterfaceTracker *	interfaceTracker () const
	Locates the interface tracker for the application.
pqLinksModel *	getLinksModel () const
	pqLinksModel is the model used to keep track of proxy/property links maintained by vtkSMProxyManager.
pqPluginManager *	getPluginManager () const
	pqPluginManager manages all functionality associated with loading plugins.
pqProgressManager *	getProgressManager () const
	ProgressManager is the manager that streamlines progress.
pqDisplayPolicy *	getDisplayPolicy () const
void	setDisplayPolicy (pqDisplayPolicy *dp)
	It is possible to change the display policy used by the application.
virtual pqTestUtility *	testUtility ()
	Provides access to the test utility.
void	setLookupTableManager (pqLookupTableManager *)
	Set/Get the lookup table manager.
pqLookupTableManager *	getLookupTableManager () const
vtkSMGlobalPropertiesManager *	getGlobalPropertiesManager ()
	Returns the manager for the global properties such as ForegroundColor etc.
pqRecentlyUsedResourcesList &	recentlyUsedResources ()
	Returns the set of recently-used resources i.e.
pqServerConfigurationCollection &	serverConfigurations ()
	Returns the collection of server configurations known.
pqSettings *	settings ()
	Get the application settings.
vtkPVXMLElement *	saveState ()
	Save the ServerManager state.
void	saveState (const QString &filename)
void	loadState (vtkPVXMLElement root, pqServer server)
	Loads the ServerManager state.
void	loadState (const char filename, pqServer server)
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.
void	loadGlobalPropertiesFromSettings ()
	Loads global properties values from settings.
void	loadPalette (const QString &name)
	loads palette i.e. global property values given the name of the palette.
void	loadPalette (vtkPVXMLElement *xml)
	loads palette i.e.
vtkPVXMLElement *	getCurrrentPalette ()
	save the current palette as XML.
pqServer *	getActiveServer () const
	returns the active server is any.
void	loadDistributedPlugins (const char *filename=0)
	Called to load the configuration xml bundled with the application the lists the plugins that the application is aware by default.
virtual	~pqApplicationCore ()
	Destructor.
Static Public Member Functions
static pqApplicationCore *	instance ()
Protected Slots
void	onStateLoaded (vtkPVXMLElement root, vtkSMProxyLocator locator)
void	onStateSaved (vtkPVXMLElement *root)
Protected Attributes
bool	LoadingState
pqOutputWindow *	OutputWindow
pqOutputWindowAdapter *	OutputWindowAdapter
pqOptions *	Options
pq3DWidgetFactory *	WidgetFactory
pqDisplayPolicy *	DisplayPolicy
pqLinksModel *	LinksModel
pqLookupTableManager *	LookupTableManager
pqObjectBuilder *	ObjectBuilder
pqInterfaceTracker *	InterfaceTracker
pqPluginManager *	PluginManager
pqProgressManager *	ProgressManager
pqServerManagerModel *	ServerManagerModel
pqServerManagerObserver *	ServerManagerObserver
pqUndoStack *	UndoStack
pqRecentlyUsedResourcesList *	RecentlyUsedResourcesList
pqServerConfigurationCollection *	ServerConfigurations
pqSettings *	Settings
QHelpEngine *	HelpEngine
QPointer< pqTestUtility >	TestUtility

Detailed Description

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 75 of file pqApplicationCore.h.

Constructor & Destructor Documentation

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.

virtual pqApplicationCore::~pqApplicationCore ( ) [virtual]

Destructor.

Member Function Documentation

static pqApplicationCore* pqApplicationCore::instance ( ) [static]

Reimplemented in pqPVApplicationCore.

void pqApplicationCore::disableOutputWindow ( )

Dangerous option that disables the debug output window, intended for demo purposes only.

pqOptions* pqApplicationCore::getOptions ( ) const [inline]

Provides access to the command line options object.

Definition at line 95 of file pqApplicationCore.h.

pqObjectBuilder* pqApplicationCore::getObjectBuilder ( ) const [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 101 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.

pqUndoStack* pqApplicationCore::getUndoStack ( ) const [inline]

Definition at line 107 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.

QHelpEngine* pqApplicationCore::helpEngine ( )

provides access to the help engine.

The engine is created the first time this method is called.

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.

pqServerManagerObserver* pqApplicationCore::getServerManagerObserver ( ) [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 140 of file pqApplicationCore.h.

pqServerManagerModel* pqApplicationCore::getServerManagerModel ( ) const [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 147 of file pqApplicationCore.h.

pq3DWidgetFactory* pqApplicationCore::get3DWidgetFactory ( ) const [inline]

Definition at line 150 of file pqApplicationCore.h.

pqInterfaceTracker* pqApplicationCore::interfaceTracker ( ) const [inline]

Locates the interface tracker for the application.

pqInterfaceTracker is used to locate all interface implementations typically loaded from plugins.

Definition at line 156 of file pqApplicationCore.h.

pqLinksModel* pqApplicationCore::getLinksModel ( ) const [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 164 of file pqApplicationCore.h.

pqPluginManager* pqApplicationCore::getPluginManager ( ) const [inline]

pqPluginManager manages all functionality associated with loading plugins.

Definition at line 168 of file pqApplicationCore.h.

pqProgressManager* pqApplicationCore::getProgressManager ( ) const [inline]

ProgressManager is the manager that streamlines progress.

Definition at line 172 of file pqApplicationCore.h.

pqDisplayPolicy* pqApplicationCore::getDisplayPolicy ( ) const [inline]

Definition at line 178 of file pqApplicationCore.h.

void pqApplicationCore::setDisplayPolicy ( pqDisplayPolicy * dp )

It is possible to change the display policy used by the application.

Used to change the active display policy. The pqApplicationCore takes over the ownership of the display policy.

virtual pqTestUtility* pqApplicationCore::testUtility ( ) [virtual]

Provides access to the test utility.

Reimplemented in pqPVApplicationCore.

void pqApplicationCore::setLookupTableManager ( pqLookupTableManager * )

Set/Get the lookup table manager.

Lookup table manager is used to manage lookup tables used for coloring using data arrays. policy. The pqApplicationCore takes over the ownership of the manager.

pqLookupTableManager* pqApplicationCore::getLookupTableManager ( ) const [inline]

Definition at line 193 of file pqApplicationCore.h.

vtkSMGlobalPropertiesManager* pqApplicationCore::getGlobalPropertiesManager ( )

Returns the manager for the global properties such as ForegroundColor etc.

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.

vtkPVXMLElement* pqApplicationCore::saveState ( )

Save the ServerManager state.

void pqApplicationCore::saveState ( const QString & filename )

void pqApplicationCore::loadState	(	vtkPVXMLElement *	root,
		pqServer *	server
	)

Loads the ServerManager state.

Emits the signal stateLoaded() on loading state successfully.

void pqApplicationCore::loadState	(	const char *	filename,
		pqServer *	server
	)

bool pqApplicationCore::isLoadingState ( ) [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 222 of file pqApplicationCore.h.

void pqApplicationCore::loadGlobalPropertiesFromSettings ( )

Loads global properties values from settings.

HACK: Need more graceful way of dealing with changes to settings and updating items that depend on it.

void pqApplicationCore::loadPalette ( const QString & name )

loads palette i.e. global property values given the name of the palette.

void pqApplicationCore::loadPalette ( vtkPVXMLElement * xml )

loads palette i.e.

global property values given the name XML state for a palette.

vtkPVXMLElement* pqApplicationCore::getCurrrentPalette ( )

save the current palette as XML.

A new reference is returned, so the caller is responsible for releasing memory i.e. call Delete() on the returned value.

pqServer* pqApplicationCore::getActiveServer ( ) const

returns the active server is any.

void pqApplicationCore::loadDistributedPlugins ( const char * filename = 0 )

Called to load the configuration xml bundled with the application the lists the plugins that the application is aware by default.

If no filename is specified, {executable-path}/.plugins is loaded.

void pqApplicationCore::prepareForQuit ( ) [slot]

Applications calls this to ensure that any cleanup is performed correctly.

void pqApplicationCore::quit ( ) [slot]

Calls QCoreApplication::quit().

void pqApplicationCore::showOutputWindow ( ) [slot]

Causes the output window to be shown.

void pqApplicationCore::loadConfiguration ( const QString & filename ) [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.

void pqApplicationCore::render ( ) [slot]

Renders all windows.

void pqApplicationCore::aboutToLoadState ( vtkPVXMLElement * root ) [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.

void pqApplicationCore::stateLoaded	(	vtkPVXMLElement *	root,
		vtkSMProxyLocator *	locator
	)		`[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.

void pqApplicationCore::stateSaved ( vtkPVXMLElement * root ) [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.

void pqApplicationCore::undoStackChanged ( pqUndoStack * ) [signal]

Fired when the undo stack is set.

void pqApplicationCore::loadXML ( vtkPVXMLElement * ) [signal]

Fired on loadConfiguration().

void pqApplicationCore::forceFilterMenuRefresh ( ) [signal]

Fired when the filter menu state needs to be manually updated.

void pqApplicationCore::updateMasterEnableState ( bool ) [signal]

Fired when master changed. true if current user is master, false otherwise.