pqInteractivePropertyWidget is an abstract pqPropertyWidget subclass designed to serve as the superclass for all pqPropertyWidget types that have interactive widget (also called 3D Widgets) associated with them.
More...
#include <pqInteractivePropertyWidget.h>
|
virtual void | placeWidget ()=0 |
| Places the interactive widget using current data source information. More...
|
|
void | render () |
| Safe call render on the view. More...
|
|
|
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...
|
|
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...
|
|
pqPropertyLinks & | links () |
| Provides access to the pqPropertyLinks instance. More...
|
|
pqInteractivePropertyWidget is an abstract pqPropertyWidget subclass designed to serve as the superclass for all pqPropertyWidget types that have interactive widget (also called 3D Widgets) associated with them.
pqInteractivePropertyWidget is intended to provide a Qt widget (along with an interactive widget in the active view) for controlling properties on the proxy
identified by a vtkSMPropertyGroup passed to the constructor. Subclasses are free to determine which interactive widget to create and how to setup the UI for it.
Definition at line 56 of file pqInteractivePropertyWidget.h.
◆ pqInteractivePropertyWidget()
pqInteractivePropertyWidget::pqInteractivePropertyWidget |
( |
const char * |
widget_smgroup, |
|
|
const char * |
widget_smname, |
|
|
vtkSMProxy * |
proxy, |
|
|
vtkSMPropertyGroup * |
smgroup, |
|
|
QWidget * |
parent = 0 |
|
) |
| |
◆ ~pqInteractivePropertyWidget()
pqInteractivePropertyWidget::~pqInteractivePropertyWidget |
( |
| ) |
|
|
override |
◆ reset()
void pqInteractivePropertyWidget::reset |
( |
| ) |
|
|
overridevirtual |
◆ widgetProxy()
Returns the proxy for the interactive widget.
◆ setView()
void pqInteractivePropertyWidget::setView |
( |
pqView * |
view | ) |
|
|
overridevirtual |
Overridden to show the widget proxy in the new view.
Reimplemented from pqPropertyWidget.
◆ isWidgetVisible()
bool pqInteractivePropertyWidget::isWidgetVisible |
( |
| ) |
const |
Returns the interactive widget's visibility.
Note that the widget may still not be visible in the view if the pqPropertyWidget is not selected. An interactive widget may be visible in the view when this->isWidgetVisible() and this->isSelected() both return true and the view is of the right type.
◆ dataSource()
vtkSMProxy* pqInteractivePropertyWidget::dataSource |
( |
| ) |
const |
◆ select()
void pqInteractivePropertyWidget::select |
( |
| ) |
|
|
overridevirtual |
In these methods, we show/hide the widget since the interactive widget is not supposed to be visible except when the panel is "active" or "selected".
Reimplemented from pqPropertyWidget.
◆ deselect()
void pqInteractivePropertyWidget::deselect |
( |
| ) |
|
|
overridevirtual |
◆ dataBounds()
Returns bounds from the dataSource, if possible.
May return invalid bounds when no dataSource exists of hasn't been updated to produce valid data.
◆ propertyGroup()
◆ hideEvent()
void pqInteractivePropertyWidget::hideEvent |
( |
QHideEvent * |
| ) |
|
|
override |
Overriden in order to hide the VTK widget.
◆ showEvent()
void pqInteractivePropertyWidget::showEvent |
( |
QShowEvent * |
| ) |
|
|
override |
Overriden in order to show the VTK widget.
◆ setWidgetVisible
void pqInteractivePropertyWidget::setWidgetVisible |
( |
bool |
val | ) |
|
|
slot |
Toggle the interactive widget's visibility.
This, along with pqPropertyWidget's selected state controls whether the widget proxy is visible in a view.
◆ setDataSource
void pqInteractivePropertyWidget::setDataSource |
( |
vtkSMProxy * |
dataSource | ) |
|
|
slot |
DataSource is used by interactive widgets to determine now to place the widget in the view e.g.
the bounds to use for placing the widget or when re-centering the interactive widget.
◆ placeWidget
virtual void pqInteractivePropertyWidget::placeWidget |
( |
| ) |
|
|
protectedpure virtualslot |
Places the interactive widget using current data source information.
◆ render
void pqInteractivePropertyWidget::render |
( |
| ) |
|
|
protectedslot |
Safe call render on the view.
◆ widgetVisibilityToggled
void pqInteractivePropertyWidget::widgetVisibilityToggled |
( |
bool |
| ) |
|
|
signal |
◆ widgetVisibilityUpdated
void pqInteractivePropertyWidget::widgetVisibilityUpdated |
( |
bool |
| ) |
|
|
signal |
Fired whenever the widgets visibility is updated for whatever reason, be it because the panel was selected/deselected or the view changed, etc.
◆ startInteraction
void pqInteractivePropertyWidget::startInteraction |
( |
| ) |
|
|
signal |
Signals fired when the interactive widget proxy fires the corresponding events.
◆ interaction
void pqInteractivePropertyWidget::interaction |
( |
| ) |
|
|
signal |
◆ endInteraction
void pqInteractivePropertyWidget::endInteraction |
( |
| ) |
|
|
signal |
◆ dummySignal
void pqInteractivePropertyWidget::dummySignal |
( |
| ) |
|
|
signal |
◆ VisibleState
bool pqInteractivePropertyWidget::VisibleState = true |
|
protected |
◆ dataSource
pqSMProxy pqInteractivePropertyWidget::dataSource |
|
readwrite |
The documentation for this class was generated from the following file:
- /home/kitware/dashboards/buildbot/paraview_release-vall-linux-shared-release_adios2_doc_extdeps_gui_mpi_python3/source/Qt/ApplicationComponents/pqInteractivePropertyWidget.h