pqActiveObjects is a singleton that keeps track of "active objects" including active view, active source, active representation etc.
More...
#include <pqActiveObjects.h>
Inherits QObject.
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 34 of file pqActiveObjects.h.
◆ pqActiveObjects()
| pqActiveObjects::pqActiveObjects |
( |
| ) |
|
|
protected |
◆ ~pqActiveObjects()
| pqActiveObjects::~pqActiveObjects |
( |
| ) |
|
|
overrideprotected |
◆ instance()
Provides access to the singleton.
◆ activeView()
| pqView* pqActiveObjects::activeView |
( |
| ) |
const |
|
inline |
◆ activePipelineProxy()
| pqProxy* pqActiveObjects::activePipelineProxy |
( |
| ) |
const |
|
inline |
Returns the active pipeline proxy e.g.
a pqPipelineSource or pqExtractor.
Historical note: until ParaView 5.9, the only types of objects that could be part of the data-processing pipeline were pqPipelineSource (or subclass) instances i.e. they were all vtkAlgorithm-based. With 5.9, we introduced a concept of extractors (pqExtractor) which are not vtkAlgorithm-based and hence cannot be pqPipelineSource. To avoid major disruption to API and applications, here was the chosen strategy: we let active-source be either a pqPipelineSource or pqExtractor. setActiveSource/activeSource() remains unchanged but will likely get deprecated in the future. setActivePipelineProxy and activePipelineProxy() is the now recommended API to get access to the active source and active extractor.
Definition at line 64 of file pqActiveObjects.h.
◆ activeSource()
Returns the active pipeline proxy e.g.
a pqPipelineSource or pqExtractor.
Historical note: until ParaView 5.9, the only types of objects that could be part of the data-processing pipeline were pqPipelineSource (or subclass) instances i.e. they were all vtkAlgorithm-based. With 5.9, we introduced a concept of extractors (pqExtractor) which are not vtkAlgorithm-based and hence cannot be pqPipelineSource. To avoid major disruption to API and applications, here was the chosen strategy: we let active-source be either a pqPipelineSource or pqExtractor. setActiveSource/activeSource() remains unchanged but will likely get deprecated in the future. setActivePipelineProxy and activePipelineProxy() is the now recommended API to get access to the active source and active extractor.
◆ activePort()
◆ activeServer()
| pqServer* pqActiveObjects::activeServer |
( |
| ) |
const |
|
inline |
◆ activeRepresentation()
◆ activeSourcesSelectionModel()
◆ selection()
◆ proxyManager()
◆ activeLayout()
Convenience method to get the layout for the active view.
◆ activeLayoutLocation()
| int pqActiveObjects::activeLayoutLocation |
( |
| ) |
const |
Convenience method to locate the active vtkSMViewLayoutProxy and the active cell in it.
Since currently this information is not available at the server-manager level, especially if the active view is nullptr, we use pqMultiViewWidget and pqTabbedMultiViewWidget to find this.
Returns 0 if one could not determined.
◆ setActiveView
| void pqActiveObjects::setActiveView |
( |
pqView * |
view | ) |
|
|
slot |
Set the active view.
Changing the active view may lead to change in active representation as well.
◆ setActivePipelineProxy
| void pqActiveObjects::setActivePipelineProxy |
( |
pqProxy * |
proxy | ) |
|
|
slot |
Set the active source.
Changing the active source may lead to changes in active port, and active representation.
Using setActivePipelineProxy is the recommended approach since ParaView 5.9 since it allows for supporting pqExtractor items.
◆ setActiveSource
Set the active source.
Changing the active source may lead to changes in active port, and active representation.
Using setActivePipelineProxy is the recommended approach since ParaView 5.9 since it allows for supporting pqExtractor items.
Definition at line 130 of file pqActiveObjects.h.
◆ setActivePort
Set the active source.
Changing the active source may lead to changes in active port, and active representation.
Using setActivePipelineProxy is the recommended approach since ParaView 5.9 since it allows for supporting pqExtractor items.
Definition at line 131 of file pqActiveObjects.h.
◆ setActiveServer
| void pqActiveObjects::setActiveServer |
( |
pqServer * |
| ) |
|
|
slot |
Set the active server.
Changing the server typically leads to changes all other active items.
◆ setSelection
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.
◆ serverChanged
| void pqActiveObjects::serverChanged |
( |
pqServer * |
| ) |
|
|
signal |
These signals are fired when any of the corresponding active items change.
◆ viewChanged
| void pqActiveObjects::viewChanged |
( |
pqView * |
view | ) |
|
|
signal |
◆ pipelineProxyChanged
| void pqActiveObjects::pipelineProxyChanged |
( |
pqProxy * |
| ) |
|
|
signal |
◆ sourceChanged
◆ portChanged
◆ representationChanged [1/2]
◆ representationChanged [2/2]
◆ selectionChanged
◆ dataUpdated
| void pqActiveObjects::dataUpdated |
( |
| ) |
|
|
signal |
this signal is fired when the active source fires the dataUpdated() signal.
This is used by components in the GUI that need to be updated when the active source's pipeline updates.
◆ representationUpdated
| void pqActiveObjects::representationUpdated |
( |
| ) |
|
|
signal |
this signal is fired when the active representation fires the updated() signal.
This is used by components in the GUI that need to be updated when the active representation updates.
◆ viewUpdated
| void pqActiveObjects::viewUpdated |
( |
| ) |
|
|
signal |
this signal is fired when the active view fires the dataUpdated() signal.
This is used by components in the GUI that need to be updated when the active view updates.
◆ triggerSignals()
| 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:
1.8.17 on Wed Mar 27 2024