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

pqCalculatorWidget is a property-widget that can shows a calculator-like UI for the property. More...

#include <pqCalculatorWidget.h>

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

Public Member Functions

 pqCalculatorWidget (vtkSMProxy *proxy, vtkSMProperty *property, QWidget *parent=nullptr)
 
 ~pqCalculatorWidget () override
 
- Public Member Functions inherited from pqPropertyWidget
 pqPropertyWidget (vtkSMProxy *proxy, QWidget *parent=nullptr)
 
 ~pqPropertyWidget () override
 
virtual void apply ()
 
virtual void reset ()
 
virtual void updateWidget (bool showing_advanced_properties)
 
pqViewview () const
 
vtkSMProxyproxy () const
 
vtkSMPropertyproperty () const
 
virtual char * panelVisibility () const
 Forward calls to vtkSMProperty. More...
 
virtual void setPanelVisibility (const char *vis)
 
virtual bool isSingleRowItem () const
 Determines if the PropertyWidget must be constructed using a single row. More...
 
bool showLabel () const
 
const QList< QPointer< pqPropertyWidgetDecorator > > & decorators () const
 Provides access to the decorators for this widget. More...
 
void setProperty (vtkSMProperty *property)
 
virtual void select ()
 These methods are called by pqPropertiesPanel when the panel for proxy becomes active/deactive. More...
 
virtual void selectPort (int portIndex)
 These methods are called by pqPropertiesPanel when the panel for proxy becomes active/deactive. More...
 
virtual void deselect ()
 These methods are called by pqPropertiesPanel when the panel for proxy becomes active/deactive. More...
 
bool isSelected () const
 These methods are called by pqPropertiesPanel when the panel for proxy becomes active/deactive. More...
 

Protected Slots

void variableChosen (QAction *action)
 called when the user selects a variable from the scalars/vectors menus. More...
 
void buttonPressed (const QString &)
 called when user clicks one of the function buttons More...
 
void updateVariableNames ()
 updates the variables in the menus. More...
 
void updateVariables (const QString &mode)
 
void updateButtons ()
 Update button labels based on which function parser is active. More...
 

Additional Inherited Members

- Public Slots inherited from pqPropertyWidget
virtual void setView (pqView *)
 called to set the active view. More...
 
- Signals inherited from pqPropertyWidget
void viewChanged (pqView *view)
 This signal is emitted when the current view changes. More...
 
void changeAvailable ()
 This signal is fired as soon as the user starts editing in the widget. More...
 
void changeFinished ()
 This signal is fired as soon as the user is done with making an atomic change. More...
 
void restartRequired ()
 Indicates that a restart of the program is required for the setting to take effect. More...
 
- Static Public Member Functions inherited from pqPropertyWidget
template<class T >
static QString getXMLName (T *object)
 Description: This static utility method returns the XML name for an object as a QString. More...
 
static QString getTooltip (vtkSMProperty *property)
 Returns the tooltip to use for the property. More...
 
static int hintsWidgetHeightNumberOfRows (vtkPVXMLElement *hints, int defaultValue=10)
 Helper method to return value from WidgetHeight XML hint, if any. More...
 
static std::vector< std::stringparseComponentLabels (vtkPVXMLElement *hints, unsigned int elemCount=0)
 Parse a XML element as a list of label to use for this widget. More...
 
- Protected Member Functions inherited from pqPropertyWidget
void addPropertyLink (QObject *qobject, const char *qproperty, const char *qsignal, vtkSMProperty *smproperty, int smindex=-1)
 
void addPropertyLink (QObject *qobject, const char *qproperty, const char *qsignal, vtkSMProxy *smproxy, vtkSMProperty *smproperty, int smindex=-1)
 
void removePropertyLink (QObject *qobject, const char *qproperty, const char *qsignal, vtkSMProperty *smproperty, int smindex=-1)
 
void removePropertyLink (QObject *qobject, const char *qproperty, const char *qsignal, vtkSMProxy *smproxy, vtkSMProperty *smproperty, int smindex=-1)
 
void setShowLabel (bool show)
 
void setChangeAvailableAsChangeFinished (bool status)
 For most pqPropertyWidget subclasses a changeAvailable() signal, corresponds to a changeFinished() signal. More...
 
void addDecorator (pqPropertyWidgetDecorator *)
 Register a decorator. More...
 
void removeDecorator (pqPropertyWidgetDecorator *)
 Unregisters a decorator. More...
 
pqPropertyLinkslinks ()
 Provides access to the pqPropertyLinks instance. More...
 

Detailed Description

pqCalculatorWidget is a property-widget that can shows a calculator-like UI for the property.

It is designed to be used with vtkPVArrayCalculator (or similar) filters. It allows users to enter expressions to compute derived quantities. To determine the list of input arrays available.

CAVEATS: Currently, this widget expects two additional properties on the proxy: "Input", that provides the input and "AttributeMode", which corresponds to the chosen attribute type. This code can be revised to use RequiredProperties on the domain to make it reuseable, if needed.

Definition at line 20 of file pqCalculatorWidget.h.

Constructor & Destructor Documentation

◆ pqCalculatorWidget()

pqCalculatorWidget::pqCalculatorWidget ( vtkSMProxy proxy,
vtkSMProperty property,
QWidget *  parent = nullptr 
)

◆ ~pqCalculatorWidget()

pqCalculatorWidget::~pqCalculatorWidget ( )
override

Member Function Documentation

◆ variableChosen

void pqCalculatorWidget::variableChosen ( QAction *  action)
protectedslot

called when the user selects a variable from the scalars/vectors menus.

◆ buttonPressed

void pqCalculatorWidget::buttonPressed ( const QString &  )
protectedslot

called when user clicks one of the function buttons

◆ updateVariableNames

void pqCalculatorWidget::updateVariableNames ( )
protectedslot

updates the variables in the menus.

◆ updateVariables

void pqCalculatorWidget::updateVariables ( const QString &  mode)
protectedslot

◆ updateButtons

void pqCalculatorWidget::updateButtons ( )
protectedslot

Update button labels based on which function parser is active.


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