pqActiveObjects Class Reference

pqActiveObjects is a singleton that keeps track of "active objects" including active view, active source, active representation etc. More...

#include <pqActiveObjects.h>

List of all members.

Public Slots
void	setActiveView (pqView *view)
void	setActiveSource (pqPipelineSource *source)
void	setActivePort (pqOutputPort *port)
void	setActiveServer (pqServer *)
void	onActiveServerChanged ()
void	setSelection (const pqProxySelection &selection, pqServerManagerModelItem *current)
	Sets the selected set of proxies.
Signals
void	serverChanged (pqServer *)
	These signals are fired when any of the corresponding active items change.
void	viewChanged (pqView *view)
void	sourceChanged (pqPipelineSource *)
void	portChanged (pqOutputPort *)
void	representationChanged (pqDataRepresentation *)
void	representationChanged (pqRepresentation *)
void	selectionChanged (const pqProxySelection &)
void	sourceNotification (pqPipelineSource *, char *)
	These signals are fired when a UserEvent is invoked from one of the active objects.
void	viewNotification (pqView *, char *)
void	serverNotification (pqServer *, char *)
Public Member Functions
pqView *	activeView () const
	Returns the active view.
pqPipelineSource *	activeSource () const
	Returns the active source.
pqOutputPort *	activePort () const
	Returns the active port.
pqServer *	activeServer () const
	Returns the active server.
pqDataRepresentation *	activeRepresentation () const
	Returns the active representation.
vtkSMProxySelectionModel *	activeSourcesSelectionModel () const
const pqProxySelection &	selection () const
	Returns the current source selection.
Static Public Member Functions
static pqActiveObjects &	instance ()
	Provides access to the singleton.
Protected Member Functions
	pqActiveObjects ()
	~pqActiveObjects ()
void	triggerSignals ()
	single method that fires appropriate signals based on state changes.

---

Detailed Description

pqActiveObjects is a singleton that keeps track of "active objects" including active view, active source, active representation etc.

pqActiveObjects also keeps track of selected sources (known as 'selection'). setActiveSource/setActivePort will affect the selection but not vice-versa (unless dealing with multiple server sessions).

Definition at line 55 of file pqActiveObjects.h.

---

Constructor & Destructor Documentation

pqActiveObjects::pqActiveObjects

(

)

[protected]

pqActiveObjects::~pqActiveObjects

(

)

[protected]

---

Member Function Documentation

static pqActiveObjects& pqActiveObjects::instance

(

)

[static]

Provides access to the singleton.

pqView* pqActiveObjects::activeView

(

)

const [inline]

Returns the active view.

Definition at line 64 of file pqActiveObjects.h.

pqPipelineSource* pqActiveObjects::activeSource

(

)

const [inline]

Returns the active source.

Definition at line 67 of file pqActiveObjects.h.

pqOutputPort* pqActiveObjects::activePort

(

)

const [inline]

Returns the active port.

Definition at line 70 of file pqActiveObjects.h.

pqServer* pqActiveObjects::activeServer

(

)

const [inline]

Returns the active server.

Definition at line 73 of file pqActiveObjects.h.

pqDataRepresentation* pqActiveObjects::activeRepresentation

(

)

const [inline]

Returns the active representation.

Definition at line 76 of file pqActiveObjects.h.

vtkSMProxySelectionModel* pqActiveObjects::activeSourcesSelectionModel

(

)

const [inline]

Definition at line 79 of file pqActiveObjects.h.

const pqProxySelection& pqActiveObjects::selection

(

)

const [inline]

Returns the current source selection.

Definition at line 86 of file pqActiveObjects.h.

void pqActiveObjects::setActiveView

(

pqView *

view

)

[slot]

void pqActiveObjects::setActiveSource

(

pqPipelineSource *

source

)

[slot]

void pqActiveObjects::setActivePort

(

pqOutputPort *

port

)

[slot]

void pqActiveObjects::setActiveServer

(

pqServer *

)

[slot]

void pqActiveObjects::onActiveServerChanged

(

)

[slot]

void pqActiveObjects::setSelection	(	const pqProxySelection &	selection,
		pqServerManagerModelItem *	current
	)		[slot]

Sets the selected set of proxies.

All proxies in the selection must be on the same server/session. This generally doesn't affect the activeSource etc. unless the server is different from the active server. In which case, the active server is changed before the selection is updated.

void pqActiveObjects::serverChanged

(

pqServer *

)

[signal]

These signals are fired when any of the corresponding active items change.

void pqActiveObjects::viewChanged

(

pqView *

view

)

[signal]

void pqActiveObjects::sourceChanged

(

pqPipelineSource *

)

[signal]

void pqActiveObjects::portChanged

(

pqOutputPort *

)

[signal]

void pqActiveObjects::representationChanged

(

pqDataRepresentation *

)

[signal]

void pqActiveObjects::representationChanged

(

pqRepresentation *

)

[signal]

void pqActiveObjects::selectionChanged

(

const pqProxySelection &

)

[signal]

void pqActiveObjects::sourceNotification	(	pqPipelineSource *	,
		char *
	)		[signal]

These signals are fired when a UserEvent is invoked from one of the active objects.

The introduction of those signal was to allow Python trace to Show/Hide widget for a given active source.

void pqActiveObjects::viewNotification	(	pqView *	,
		char *
	)		[signal]

void pqActiveObjects::serverNotification	(	pqServer *	,
		char *
	)		[signal]

void pqActiveObjects::triggerSignals

(

)

[protected]

single method that fires appropriate signals based on state changes.

This also ensures that the Cached* variables are updated correctly.

---

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

• /home/kitware/Dashboards/My Tests/ParaView/Qt/Components/pqActiveObjects.h