custom property widget using vtkBoxWidget2 and vtkBoxRepresentation. More...
#include <pqBoxPropertyWidget.h>
Public Member Functions | |
pqBoxPropertyWidget (vtkSMProxy *proxy, vtkSMPropertyGroup *smgroup, QWidget *parent=nullptr, bool hideReferenceBounds=false) | |
~pqBoxPropertyWidget () override | |
Public Member Functions inherited from pqInteractivePropertyWidget | |
pqInteractivePropertyWidget (const char *widget_smgroup, const char *widget_smname, vtkSMProxy *proxy, vtkSMPropertyGroup *smgroup, QWidget *parent=nullptr) | |
~pqInteractivePropertyWidget () override | |
vtkSMNewWidgetRepresentationProxy * | widgetProxy () const |
Returns the proxy for the 3D interactive widget. More... | |
Public Member Functions inherited from pqInteractivePropertyWidgetAbstract | |
pqInteractivePropertyWidgetAbstract (const char *widget_smgroup, const char *widget_smname, vtkSMProxy *proxy, vtkSMPropertyGroup *smgroup, QWidget *parent=nullptr) | |
~pqInteractivePropertyWidgetAbstract () override | |
void | reset () override |
Overridden to call this->render() to ensure that the widget is redrawn. More... | |
void | setView (pqView *view) override |
Overridden to show the widget proxy in the new view. More... | |
bool | isWidgetVisible () const |
Returns the interactive widget's visibility. More... | |
vtkSMProxy * | dataSource () const |
Returns the data source. More... | |
vtkBoundingBox | dataBounds (bool visibleOnly=false) const |
Returns bounds from the dataSource, if possible. More... | |
vtkSMPropertyGroup * | propertyGroup () const |
Returns the vtkSMPropertyGroup pass to the constructor. More... | |
void | hideEvent (QHideEvent *) override |
Overriden in order to hide the VTK widget. More... | |
void | showEvent (QShowEvent *) override |
Overriden in order to show the VTK widget. More... | |
void | select () override |
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". More... | |
void | deselect () override |
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". More... | |
void | selectPort (int portIndex) final |
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". More... | |
Public Member Functions inherited from pqPropertyWidget | |
pqPropertyWidget (vtkSMProxy *proxy, QWidget *parent=nullptr) | |
~pqPropertyWidget () override | |
virtual void | apply () |
virtual void | updateWidget (bool showing_advanced_properties) |
pqView * | view () const |
vtkSMProxy * | proxy () const |
vtkSMProperty * | property () 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... | |
virtual void | setReadOnly (bool readOnly) |
Set widget in read-only mode. More... | |
void | setProperty (vtkSMProperty *property) |
bool | isSelected () const |
These methods are called by pqPropertiesPanel when the panel for proxy becomes active/deactive. More... | |
Protected Slots | |
void | placeWidget () override |
Places the interactive widget using current data source information. More... | |
Protected Slots inherited from pqInteractivePropertyWidgetAbstract | |
virtual void | placeWidget ()=0 |
Places the interactive widget using current data source information. More... | |
void | render () |
Safe call render on the view. More... | |
virtual void | updateWidgetVisibility () |
This method is called to update the state of Visibility and Enabled properties on the widget based on the state of isWidgetVisible(), isSelected() and the active view. More... | |
Additional Inherited Members | |
Public Slots inherited from pqInteractivePropertyWidgetAbstract | |
virtual void | setWidgetVisible (bool val) |
Toggle the interactive widget's visibility. More... | |
void | setDataSource (vtkSMProxy *dataSource) |
DataSource is used by interactive widgets to determine now to place the widget in the view e.g. More... | |
Public Slots inherited from pqPropertyWidget | |
Signals inherited from pqInteractivePropertyWidgetAbstract | |
void | widgetVisibilityToggled (bool) |
Fired whenever setWidgetVisible() changes the widget's visibility. More... | |
void | widgetVisibilityUpdated (bool) |
Fired whenever the widgets visibility is updated for whatever reason, be it because the panel was selected/deselected or the view changed, etc. More... | |
void | startInteraction () |
Fired by the underlying interactive widget representation proxy, for each respective events. More... | |
void | interaction () |
Fired by the underlying interactive widget representation proxy, for each respective events. More... | |
void | endInteraction () |
Fired by the underlying interactive widget representation proxy, for each respective events. 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::string > | parseComponentLabels (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 pqInteractivePropertyWidget | |
vtkSMNewWidgetRepresentationProxyAbstract * | internalWidgetProxy () final |
Get the internal instance of the widget proxy. More... | |
Protected Member Functions inherited from pqInteractivePropertyWidgetAbstract | |
void | setupConnections (vtkSMNewWidgetRepresentationProxyAbstract *widget, vtkSMPropertyGroup *smgroup, vtkSMProxy *smproxy) |
Setup all the links and events for the given widget and SM property group. More... | |
void | setupUserObserver (vtkSMProxy *smproxy) |
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... | |
pqPropertyLinks & | links () |
Provides access to the pqPropertyLinks instance. More... | |
Protected Attributes inherited from pqInteractivePropertyWidgetAbstract | |
bool | VisibleState = true |
bool | WidgetVisibility = false |
int | LinkedPortIndex = -1 |
Properties inherited from pqInteractivePropertyWidgetAbstract | |
pqSMProxy | dataSource |
custom property widget using vtkBoxWidget2 and vtkBoxRepresentation.
pqBoxPropertyWidget is a custom property widget that uses "BoxWidgetRepresentation" to help users interactively set the origin, orientation and scale for an oriented bounding box.
To use this widget for a property group (vtkSMPropertyGroup
), use "InteractiveBox" as the "panel_widget" in the XML configuration for the proxy. The property group should have properties for following functions (all of which are optional):
UseReferenceBounds and ReferenceBounds must be used together i.e. both are required for this to work.
The constructor accepts a boolean "hideReferenceBounds" to toggle the visibility of reference bounds items. This is useful when reference bounds are fixed by an external entity that doesn't want the user to modify it.
Note while all of the above are optional, it really doesn't make much sense to use this widget if any of them are not specified.
Definition at line 46 of file pqBoxPropertyWidget.h.
pqBoxPropertyWidget::pqBoxPropertyWidget | ( | vtkSMProxy * | proxy, |
vtkSMPropertyGroup * | smgroup, | ||
QWidget * | parent = nullptr , |
||
bool | hideReferenceBounds = false |
||
) |
|
override |
|
overrideprotectedslot |
Places the interactive widget using current data source information.