pqPVApplicationCore is the application code used by ParaView-based applications that use more of ParaView's functionality than that provided by pqApplicationCore such as the the selection manager, animation manager etc. More...

#include <pqPVApplicationCore.h>

Inheritance diagram for pqPVApplicationCore:

[legend]

Collaboration diagram for pqPVApplicationCore:

[legend]

Public Slots
void	applyPipeline ()
	A useful slot to trigger an apply on the pipeline. More...

void	quickLaunch ()
	Pops-up the quick launch dialog. More...

void	startSearch ()
	Pops-up the search dialog if the focused widget is QAsbstractItemView type. More...

Public Slots inherited from pqApplicationCore
void	prepareForQuit ()
	Applications calls this to ensure that any cleanup is performed correctly. More...

void	quit ()
	Calls QCoreApplication::quit(). More...

void	updateAvailableReadersAndWriters ()
	Update the available readers and writers using the factories. More...

void	render ()
	Renders all windows. More...

void	loadConfiguration (const QString &filename)
	Load configuration xml. More...

void	loadConfigurationXML (const char *xmldata)
	Load configuration xml. More...

Signals
void	aboutToShowQuickLaunch ()
	Emitted whenever the quickLaunch dialog is about to show. More...

void	triggerApply ()

Signals inherited from pqApplicationCore
void	aboutToWriteState (QString filename)
	Fired before a state file, either python or XML, is written. More...

void	aboutToReadState (QString filename)
	Fired before a state file, either python or XML, is read. More...

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
	pqPVApplicationCore (int &argc, char *argv, vtkCLIOptions options=nullptr, bool addStandardArgs=true, QObject *parent=nullptr)

	~pqPVApplicationCore () override

pqSelectionManager *	selectionManager () const
	Provides access to the selection manager. More...

pqAnimationManager *	animationManager () const
	Provides access to the animation manager. More...

pqTestUtility *	testUtility () override
	Provides access to the test utility. More...

pqPythonManager *	pythonManager () const
	Provides access to the python manager. More...

pqLiveSourceManager *	liveSourceManager () const
	Provides access to the live source manager. More...

virtual void	registerForQuicklaunch (QWidget *)
	ParaView provides a mechanism to trigger menu actions using a quick-launch dialog. More...

void	loadStateFromPythonFile (const QString &filename, pqServer *server, vtkTypeUInt32 location=0x10)

void	instantiateLiveSourceManager ()
	Instantiate the live source manager, if it has not been done yet. More...

Public Member Functions inherited from pqApplicationCore
	pqApplicationCore (int &argc, char *argv, vtkCLIOptions options=nullptr, bool addStandardArgs=true, QObject *parent=nullptr)
	Initializes the ParaView application engine. 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...

QHelpEngine *	helpEngine ()
	provides access to the help engine. 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...

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 user settings. More...

QString	getDefaultSaveStateFileFormatQString (bool pythonAvailable, bool loading)
	Return the QString to populate the pqFileDialog with available file formats for saving/loading State. More...

void	useVersionedSettings (bool use)
	Set versioned settings mode. More...

vtkPVXMLElement *	saveState ()
	Save the ServerManager state to a XML element. More...

bool	saveState (const QString &filename, vtkTypeUInt32 location=0x10)
	Save the ServerManager state to a file. More...

void	loadState (vtkPVXMLElement root, pqServer server, vtkSMStateLoader *loader=nullptr)
	Loads the ServerManager state. More...

void	loadState (const char filename, pqServer server, vtkSMStateLoader *loader=nullptr)
	Load state xml from a file. More...

void	loadStateFromString (const char xmlcontents, pqServer server, vtkSMStateLoader *loader=nullptr)
	Loads state from an in-memory buffer. More...

void	clearViewsForLoadingState (pqServer *server)

void	loadStateIncremental (vtkPVXMLElement root, pqServer server, vtkSMStateLoader *loader=nullptr)
	Same as loadState() except that it doesn't clear the current visualization state. More...

void	loadStateIncremental (const QString &filename, pqServer server, vtkSMStateLoader loader=nullptr)

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...

QString	getTranslationsPathFromInterfaceLanguage (QString prefix, QString locale)
	returns a path to a directory containing a translation binary file located in a path specified by the PV_TRANSLATIONS_DIR environment variable or in the resources directory. More...

QTranslator *	getQtTranslations (QString prefix, QString locale)
	returns a QTranslator with a loaded qm file. More...

QString	getInterfaceLanguage ()
	returns interface language in use in a locale code form. More...

	~pqApplicationCore () override
	Destructor. More...

void	_paraview_client_environment_complete ()
	INTERNAL. More...

Static Public Member Functions
static pqPVApplicationCore *	instance ()
	Returns the pqPVApplicationCore instance. More...

Static Public Member Functions inherited from pqApplicationCore
static pqApplicationCore *	instance ()

static QString	stateFileFormatToExtension (pqApplicationCore::StateFileFormat format)
	Return the extension for the given format See StateFileFormat. More...

Protected Member Functions
bool	eventFilter (QObject obj, QEvent event) override
	Override event filter in order to catch file association mechanism. More...

Protected Attributes
QPointer< pqSelectionManager >	SelectionManager

QPointer< pqAnimationManager >	AnimationManager

QPointer< pqLiveSourceManager >	LiveSourceManager

pqPythonManager *	PythonManager

QList< QPointer< QWidget > >	QuickLaunchMenus

Protected Attributes inherited from pqApplicationCore
bool	LoadingState

pqLinksModel *	LinksModel

pqObjectBuilder *	ObjectBuilder

pqInterfaceTracker *	InterfaceTracker

pqMainWindowEventManager *	MainWindowEventManager

pqPluginManager *	PluginManager

pqProgressManager *	ProgressManager

pqServerManagerModel *	ServerManagerModel

pqServerManagerObserver *	ServerManagerObserver

pqUndoStack *	UndoStack

pqRecentlyUsedResourcesList *	RecentlyUsedResourcesList

pqServerConfigurationCollection *	ServerConfigurations

pqSettings *	Settings

QHelpEngine *	HelpEngine

QPointer< pqTestUtility >	TestUtility

Additional Inherited Members
Public Types inherited from pqApplicationCore
enum	StateFileFormat : unsigned int { StateFileFormat::PVSM = 0, StateFileFormat::Python = 1 }
	Enum to capture possible Save State file formats. More...

Protected Slots inherited from pqApplicationCore
void	onStateLoaded (vtkPVXMLElement root, vtkSMProxyLocator locator)

void	onStateSaved (vtkPVXMLElement *root)

void	onHelpEngineWarning (const QString &)

Detailed Description

pqPVApplicationCore is the application code used by ParaView-based applications that use more of ParaView's functionality than that provided by pqApplicationCore such as the the selection manager, animation manager etc.

Definition at line 26 of file pqPVApplicationCore.h.

Constructor & Destructor Documentation

◆ pqPVApplicationCore()

pqPVApplicationCore::pqPVApplicationCore	(	int &	argc,
		char **	argv,
		vtkCLIOptions *	options = `nullptr`,
		bool	addStandardArgs = `true`,
		QObject *	parent = `nullptr`
	)

◆ ~pqPVApplicationCore()

pqPVApplicationCore::~pqPVApplicationCore ( )

override

Member Function Documentation

◆ instance()

static pqPVApplicationCore* pqPVApplicationCore::instance ( )

inlinestatic

Returns the pqPVApplicationCore instance.

If no pqPVApplicationCore has been created then return nullptr.

Definition at line 40 of file pqPVApplicationCore.h.

◆ selectionManager()

pqSelectionManager* pqPVApplicationCore::selectionManager ( ) const

Provides access to the selection manager.

Selection manager provides access to the ParaView wide data selection mechanism. This must not be confused with the active-object selection.

◆ animationManager()

pqAnimationManager* pqPVApplicationCore::animationManager ( ) const

Provides access to the animation manager.

Animation manager helps with the animation subsystem – saving movies, creating scenes etc.

◆ testUtility()

pqTestUtility* pqPVApplicationCore::testUtility ( )

overridevirtual

Provides access to the test utility.

Reimplemented from pqApplicationCore.

◆ pythonManager()

pqPythonManager* pqPVApplicationCore::pythonManager ( ) const

Provides access to the python manager.

This is non-nullptr only when paraview is compiled with python support i.e. PARAVIEW_USE_PYTHON is ON.

◆ liveSourceManager()

pqLiveSourceManager* pqPVApplicationCore::liveSourceManager ( ) const

Provides access to the live source manager.

This can be nullptr if the live source manager was not instantiated first. (Either with pqLiveSourceBehavior or directly with instantiateLiveSourceManager()).

◆ registerForQuicklaunch()

virtual void pqPVApplicationCore::registerForQuicklaunch ( QWidget * )

virtual

ParaView provides a mechanism to trigger menu actions using a quick-launch dialog.

Applications can register menus action from which should be launch-able from the quick-launch dialog. Typical candidates are the sources menu, filters menu etc.

◆ loadStateFromPythonFile()

void pqPVApplicationCore::loadStateFromPythonFile	(	const QString &	filename,
		pqServer *	server,
		vtkTypeUInt32	location = `0x10`
	)

◆ instantiateLiveSourceManager()

void pqPVApplicationCore::instantiateLiveSourceManager ( )

Instantiate the live source manager, if it has not been done yet.

This method was designed to be called by pqLiveSourceBehavior.

◆ applyPipeline

void pqPVApplicationCore::applyPipeline ( )

slot

A useful slot to trigger an apply on the pipeline.

This is just emitting a signal usually caught by a pqApplyBehavior.

◆ quickLaunch

void pqPVApplicationCore::quickLaunch ( )

slot

Pops-up the quick launch dialog.

◆ startSearch

void pqPVApplicationCore::startSearch ( )

slot

Pops-up the search dialog if the focused widget is QAsbstractItemView type.

◆ aboutToShowQuickLaunch

void pqPVApplicationCore::aboutToShowQuickLaunch ( )

signal

Emitted whenever the quickLaunch dialog is about to show.

This can be used to update the menu items (QActions) that will be shown in the quick-launch dialog.

◆ triggerApply

void pqPVApplicationCore::triggerApply ( )

signal

◆ eventFilter()

bool pqPVApplicationCore::eventFilter	(	QObject *	obj,
		QEvent *	event
	)

overrideprotected

Override event filter in order to catch file association mechanism.

Member Data Documentation

◆ SelectionManager

QPointer<pqSelectionManager> pqPVApplicationCore::SelectionManager

protected

Definition at line 127 of file pqPVApplicationCore.h.

◆ AnimationManager

QPointer<pqAnimationManager> pqPVApplicationCore::AnimationManager

protected

Definition at line 128 of file pqPVApplicationCore.h.

◆ LiveSourceManager

QPointer<pqLiveSourceManager> pqPVApplicationCore::LiveSourceManager

protected

Definition at line 129 of file pqPVApplicationCore.h.

◆ PythonManager

pqPythonManager* pqPVApplicationCore::PythonManager

protected

Definition at line 131 of file pqPVApplicationCore.h.

◆ QuickLaunchMenus

QList<QPointer<QWidget> > pqPVApplicationCore::QuickLaunchMenus

protected

Definition at line 132 of file pqPVApplicationCore.h.

The documentation for this class was generated from the following file:

/builds/gitlab-kitware-sciviz-ci/Qt/ApplicationComponents/pqPVApplicationCore.h

Public Slots

Signals

Public Member Functions

Static Public Member Functions

Protected Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ pqPVApplicationCore()

◆ ~pqPVApplicationCore()

Member Function Documentation

◆ instance()

◆ selectionManager()

◆ animationManager()

◆ testUtility()

◆ pythonManager()

◆ liveSourceManager()

◆ registerForQuicklaunch()

◆ loadStateFromPythonFile()

◆ instantiateLiveSourceManager()

◆ applyPipeline

◆ quickLaunch

◆ startSearch

◆ aboutToShowQuickLaunch

◆ triggerApply

◆ eventFilter()

Member Data Documentation

◆ SelectionManager

◆ AnimationManager

◆ LiveSourceManager

◆ PythonManager

◆ QuickLaunchMenus