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

pqScalarBarRepresentation is created for "ScalarBarWidgetRepresentation" proxies. More...

#include <pqScalarBarRepresentation.h>

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

Public Member Functions

 pqScalarBarRepresentation (const QString &group, const QString &name, vtkSMProxy *scalarbar, pqServer *server, QObject *parent=nullptr)
 
 ~pqScalarBarRepresentation () override
 
- Public Member Functions inherited from pqRepresentation
 pqRepresentation (const QString &group, const QString &name, vtkSMProxy *repr, pqServer *server, QObject *parent=nullptr)
 
 ~pqRepresentation () override
 
virtual bool isVisible () const
 Returns if the status of the visbility property of this display. More...
 
virtual void setVisible (bool visible)
 Set the visibility. More...
 
pqViewgetView () const
 Returns the view to which this representation has been added, if any. More...
 
vtkSMViewProxygetViewProxy () const
 Returns the view proxy to which this representation has been added, if any. 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 startInteraction ()
 
void endInteraction ()
 
- Protected Slots inherited from pqRepresentation
virtual void onVisibilityChanged ()
 called when the display visibility property changes. More...
 
- Protected Slots inherited from pqProxy
void onProxyRegistered (const QString &, const QString &, vtkSMProxy *)
 
void onProxyUnRegistered (const QString &, const QString &, vtkSMProxy *)
 

Additional Inherited Members

- Public Types inherited from pqProxy
enum  ModifiedState { UNINITIALIZED, MODIFIED, UNMODIFIED }
 The modification state of this proxy. More...
 
- Public Slots inherited from pqRepresentation
void renderView (bool force)
 Renders the view to which this representation has been added if any. More...
 
void renderViewEventually ()
 Simply calls renderView(false);. More...
 
- Signals inherited from pqRepresentation
void visibilityChanged (bool visible)
 Fired when the visibility property of the underlying display changes. More...
 
void updated ()
 Fired whenever Update() is called on the underlying display proxy. 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...
 
- Protected Member Functions inherited from pqRepresentation
virtual void setView (pqView *)
 Called by pqView when this representation gets added to / removed from the view. More...
 
- Protected Member Functions inherited from pqProxy
void setSMName (const QString &new_name)
 Make this pqProxy take on a new identity. More...
 
virtual void initialize ()
 
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...
 

Detailed Description

pqScalarBarRepresentation is created for "ScalarBarWidgetRepresentation" proxies.

The only reason why pqScalarBarRepresentation is used is to keep create undo elements to aid with undo/redo for scalar bar interaction i.e. if user drags the scalar-bar widget, we capture the entire operation in a single undo-able action.

Definition at line 48 of file pqScalarBarRepresentation.h.

Constructor & Destructor Documentation

◆ pqScalarBarRepresentation()

pqScalarBarRepresentation::pqScalarBarRepresentation ( const QString &  group,
const QString &  name,
vtkSMProxy scalarbar,
pqServer server,
QObject *  parent = nullptr 
)

◆ ~pqScalarBarRepresentation()

pqScalarBarRepresentation::~pqScalarBarRepresentation ( )
override

Member Function Documentation

◆ startInteraction

void pqScalarBarRepresentation::startInteraction ( )
protectedslot

◆ endInteraction

void pqScalarBarRepresentation::endInteraction ( )
protectedslot

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