Public Member Functions | Protected Slots | Protected Member Functions | Protected Attributes | List of all members
pqComparativeContextView Class Reference

The abstract base class for comparative chart views. More...

#include <pqComparativeContextView.h>

Inheritance diagram for pqComparativeContextView:
Inheritance graph
[legend]
Collaboration diagram for pqComparativeContextView:
Collaboration graph
[legend]

Public Member Functions

 ~pqComparativeContextView () override
 
vtkContextViewgetVTKContextView () const override
 
vtkSMContextViewProxygetContextViewProxy () const override
 Returns the context view proxy associated with this object. More...
 
vtkSMComparativeViewProxygetComparativeViewProxy () const
 
virtual vtkSMViewProxygetViewProxy () const
 Returns the proxy of the root plot view in the comparative view. More...
 
- Public Member Functions inherited from pqContextView
 ~pqContextView () override
 
virtual bool supportsSelection () const
 Returns true if selection can be done. More...
 
bool supportsCapture () const override
 Returns if this view module can support image capture. More...
 
virtual void setSelectionAction (int selAction)
 set/get the selection action in the context view, defined by vtkChart enumeration from SELECT to SELECT_POLYGON. More...
 
virtual int selectionAction ()
 
void resetDisplay (bool closest=false) override
 Resets the zoom level to 100%. More...
 
- Public Member Functions inherited from pqView
 ~pqView () override
 
vtkSMViewProxygetViewProxy () const
 Returns the internal render Module proxy associated with this object. More...
 
virtual vtkViewgetClientSideView () const
 Return the client-side vtkView encapsulated by this view (if any), or return nullptr. More...
 
QWidget * widget ()
 Return a widget associated with this view. More...
 
virtual bool supportsUndo () const
 Returns if this view module can support undo/redo. More...
 
QString getViewType () const
 Returns the type of this view module. More...
 
virtual bool canUndo () const
 Returns true if undo can be done. More...
 
virtual bool canRedo () const
 Returns true if redo can be done. More...
 
virtual QSize getSize ()
 Returns the current size of the rendering context. More...
 
bool hasRepresentation (pqRepresentation *repr) const
 This method checks if the representation is shown in this view. More...
 
int getNumberOfRepresentations () const
 Returns the number representations in the view. More...
 
int getNumberOfVisibleRepresentations () const
 
int getNumberOfVisibleDataRepresentations () const
 
pqRepresentationgetRepresentation (int index) const
 Returns the representation for the specified index where (index < getNumberOfRepresentations()). More...
 
QList< pqRepresentation * > getRepresentations () const
 Returns a list of representations in this view. More...
 
bool canDisplay (pqOutputPort *opPort) const
 This method returns is any pqPipelineSource can be displayed in this view. More...
 
- Public Member Functions inherited from pqProxy
 pqProxy (const QString &group, const QString &name, vtkSMProxy *proxy, pqServer *server, QObject *parent=nullptr)
 
 ~pqProxy () override
 
pqServergetServer () const
 Get the server on which this proxy exists. More...
 
void rename (const QString &newname)
 This is a convenience method. More...
 
const QString & getSMName ()
 Get the name with which this proxy is registered on the server manager. More...
 
const QString & getSMGroup ()
 
vtkSMProxygetProxy () const
 Get the vtkSMProxy this object stands for. More...
 
ModifiedState modifiedState () const
 Gets whether or not the source has been modified. More...
 
void setModifiedState (ModifiedState modified)
 Sets whether or not the source has been modified. More...
 
vtkPVXMLElementgetHints () const
 Returns the hints for this proxy, if any. More...
 
QList< vtkSMProxy * > getHelperProxies () const
 Returns a list of all helper proxies. More...
 
QList< vtkSMProxy * > getHelperProxies (const QString &key) const
 Returns a list of all the helper proxies added with a given key. More...
 
QList< QString > getHelperKeys () const
 Returns the keys for helper proxies. More...
 
virtual void addHelperProxy (const QString &key, vtkSMProxy *)
 Concept of helper proxies: A pqProxy is created for every important vtkSMProxy registered. More...
 
void removeHelperProxy (const QString &key, vtkSMProxy *)
 
void updateHelperProxies () const
 Updates the internal datastructures using the proxies currently registered under the group that would be used for helper proxies. More...
 
vtkSMSessionProxyManagerproxyManager () const
 Returns the proxy manager by calling this->getProxy()->GetProxyManager();. More...
 
bool userModifiedSMName ()
 Return whether or not the user has modified the GUI name of the source. More...
 
- Public Member Functions inherited from pqServerManagerModelItem
 pqServerManagerModelItem (QObject *parent=nullptr)
 
 ~pqServerManagerModelItem () override
 

Protected Slots

void updateViewWidgets ()
 Called when the layout on the comparative vis changes. More...
 
- Protected Slots inherited from pqContextView
void startInteraction ()
 Slots called when vtkCommand::StartInteractionEvent and vtkCommand::EndInteractionEvent are fired by vtkSMContextViewProxy. More...
 
void endInteraction ()
 Slots called when vtkCommand::StartInteractionEvent and vtkCommand::EndInteractionEvent are fired by vtkSMContextViewProxy. More...
 
- Protected Slots inherited from pqProxy
void onProxyRegistered (const QString &, const QString &, vtkSMProxy *)
 
void onProxyUnRegistered (const QString &, const QString &, vtkSMProxy *)
 

Protected Member Functions

QWidget * createWidget () override
 Create the QWidget for this view. More...
 
 pqComparativeContextView (const QString &type, const QString &group, const QString &name, vtkSMComparativeViewProxy *view, pqServer *server, QObject *parent=nullptr)
 Constructor: type :- view type. More...
 
- Protected Member Functions inherited from pqContextView
 pqContextView (const QString &type, const QString &group, const QString &name, vtkSMViewProxy *view, pqServer *server, QObject *parent=nullptr)
 Constructor: type :- view type. More...
 
QWidget * createWidget () override
 Creates a new instance of the QWidget subclass to be used to show this view. More...
 
virtual void selectionChanged ()
 Listen for new selection events, and pass them back to ParaView. More...
 
virtual void setSelection (vtkSelection *)
 Set selection to the view. More...
 
- Protected Member Functions inherited from pqView
 pqView (const QString &type, const QString &group, const QString &name, vtkSMViewProxy *view, pqServer *server, QObject *parent=nullptr)
 Constructor: type :- view type. More...
 
void initialize () override
 Use this method to initialize the pqObject state using the underlying vtkSMProxy. More...
 
- Protected Member Functions inherited from pqProxy
void setSMName (const QString &new_name)
 Make this pqProxy take on a new identity. More...
 
virtual void addInternalHelperProxy (const QString &key, vtkSMProxy *) const
 
virtual void removeInternalHelperProxy (const QString &key, vtkSMProxy *) const
 
- Protected Member Functions inherited from pqServerManagerModelItem
vtkEventQtSlotConnectgetConnector ()
 All subclasses generally need some vtkEventQtSlotConnect instance to connect to VTK events. More...
 

Protected Attributes

QPointer< QWidget > Widget
 
- Protected Attributes inherited from pqContextView
command * Command
 

Additional Inherited Members

- Public Types inherited from pqView
enum  SelectionModifier { PV_SELECTION_DEFAULT = 0, PV_SELECTION_ADDITION, PV_SELECTION_SUBTRACTION, PV_SELECTION_TOGGLE }
 
- Public Types inherited from pqProxy
enum  ModifiedState { UNINITIALIZED, MODIFIED, UNMODIFIED }
 The modification state of this proxy. More...
 
- Public Slots inherited from pqView
virtual void render ()
 Request a StillRender on idle. More...
 
virtual void forceRender ()
 Forces an immediate render. More...
 
void cancelPendingRenders ()
 Cancels any pending renders. More...
 
virtual void undo ()
 Called to undo interaction. More...
 
virtual void redo ()
 Called to redo interaction. More...
 
- Signals inherited from pqView
void updateDataEvent ()
 Fired when the vtkSMViewProxy fires the vtkCommand::UpdateDataEvent The view proxy fires this event at the end of vtkSMViewProxy::Update() when the update executes, not just when the method is called. More...
 
void representationAdded (pqRepresentation *)
 Fired after a representation has been added to this view. More...
 
void representationRemoved (pqRepresentation *)
 Fired after a representation has been removed from this view. More...
 
void beginRender ()
 Fired when the render module fires a vtkCommand::StartEvent signalling the beginning of rendering. More...
 
void endRender ()
 Fired when the render module fires a vtkCommand::EndEvent signalling the end of rendering. More...
 
void representationVisibilityChanged (pqRepresentation *repr, bool visible)
 Fired when any representation visibility changes. More...
 
void canUndoChanged (bool)
 Fired when interaction undo stack status changes. More...
 
void canRedoChanged (bool)
 Fired when interaction undo stack status changes. More...
 
void selected (pqOutputPort *opport)
 Fired when a selection is made in this view. More...
 
void picked (pqOutputPort *opport)
 Fired when a port is picked. More...
 
void beginProgress ()
 Fired before doing any actions that may result in progress events that must be reported by the client. More...
 
void endProgress ()
 Fired after performing any actions that may result in progress events. More...
 
void progress (const QString &message, int percent_progress)
 Fired to notify the current execution progress. More...
 
void multipleSelected (QList< pqOutputPort *> opports)
 Fired when UseMultipleRepresentationSelection is set to on and selection on multiple representations is made in this view. More...
 
- Signals inherited from pqProxy
void nameChanged (pqServerManagerModelItem *)
 Fired when the name of the proxy is changed. More...
 
void modifiedStateChanged (pqServerManagerModelItem *)
 Fired when the modified status changes for the proxy. More...
 
- Static Public Member Functions inherited from pqProxy
static pqProxyfindProxyWithHelper (vtkSMProxy *aproxy, QString &key)
 Returns a pqProxy instance, of any, whose helper proxy is the aproxy. More...
 
static std::string rstToHtml (const char *rstStr)
 convert proxy documentation from RST to HTML (so that it can be used in Qt) More...
 
static QString rstToHtml (const QString &rstStr)
 convert proxy documentation from RST to HTML (so that it can be used in Qt) More...
 

Detailed Description

The abstract base class for comparative chart views.

It handles the layout of the individual chart views in the comparative view.

Definition at line 44 of file pqComparativeContextView.h.

Constructor & Destructor Documentation

◆ ~pqComparativeContextView()

pqComparativeContextView::~pqComparativeContextView ( )
override

◆ pqComparativeContextView()

pqComparativeContextView::pqComparativeContextView ( const QString &  type,
const QString &  group,
const QString &  name,
vtkSMComparativeViewProxy view,
pqServer server,
QObject *  parent = nullptr 
)
protected

Constructor: type :- view type.

group :- SManager registration group. name :- SManager registration name. view :- View proxy. server:- server on which the proxy is created. parent:- QObject parent.

Member Function Documentation

◆ getVTKContextView()

vtkContextView* pqComparativeContextView::getVTKContextView ( ) const
overridevirtual
Returns
the internal vtkContextView which provides the implementation for the chart rendering.

Reimplemented from pqContextView.

◆ getContextViewProxy()

vtkSMContextViewProxy* pqComparativeContextView::getContextViewProxy ( ) const
overridevirtual

Returns the context view proxy associated with this object.

Reimplemented from pqContextView.

◆ getComparativeViewProxy()

vtkSMComparativeViewProxy* pqComparativeContextView::getComparativeViewProxy ( ) const
Returns
the comparative view proxy.

◆ getViewProxy()

virtual vtkSMViewProxy* pqComparativeContextView::getViewProxy ( ) const
virtual

Returns the proxy of the root plot view in the comparative view.

◆ updateViewWidgets

void pqComparativeContextView::updateViewWidgets ( )
protectedslot

Called when the layout on the comparative vis changes.

◆ createWidget()

QWidget* pqComparativeContextView::createWidget ( )
overrideprotectedvirtual

Create the QWidget for this view.

Implements pqView.

Member Data Documentation

◆ Widget

QPointer<QWidget> pqComparativeContextView::Widget
protected

Definition at line 97 of file pqComparativeContextView.h.


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