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

pqHandlePropertyWidget is a custom property widget that uses "HandleWidgetRepresentation" to help users interactively set a 3D point in space. More...

#include <pqHandlePropertyWidget.h>

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

Public Slots

void centerOnBounds ()
 Update the widget's WorldPosition using current data bounds. More...
 
- Public Slots inherited from pqInteractivePropertyWidget
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

Public Member Functions

 pqHandlePropertyWidget (vtkSMProxy *proxy, vtkSMPropertyGroup *smgroup, QWidget *parent=0)
 
 ~pqHandlePropertyWidget () override
 
- Public Member Functions inherited from pqInteractivePropertyWidget
 pqInteractivePropertyWidget (const char *widget_smgroup, const char *widget_smname, vtkSMProxy *proxy, vtkSMPropertyGroup *smgroup, QWidget *parent=0)
 
 ~pqInteractivePropertyWidget () override
 
void reset () override
 Overridden to call this->render() to ensure that the widget is redrawn. More...
 
vtkSMNewWidgetRepresentationProxywidgetProxy () const
 Returns the proxy for the interactive widget. 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...
 
vtkSMProxydataSource () const
 Returns the data source. 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
 
vtkBoundingBox dataBounds () const
 Returns bounds from the dataSource, if possible. More...
 
vtkSMPropertyGrouppropertyGroup () 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...
 
- Public Member Functions inherited from pqPropertyWidget
 pqPropertyWidget (vtkSMProxy *proxy, QWidget *parent=0)
 
 ~pqPropertyWidget () override
 
virtual void apply ()
 
bool isSelected () const
 
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)
 

Protected Slots

void placeWidget () override
 Places the interactive widget using current data source information. More...
 
- Protected Slots inherited from pqInteractivePropertyWidget
virtual void placeWidget ()=0
 Places the interactive widget using current data source information. More...
 
void render ()
 Safe call render on the view. More...
 

Additional Inherited Members

- Signals inherited from pqInteractivePropertyWidget
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 ()
 Signals fired when the interactive widget proxy fires the corresponding events. More...
 
void interaction ()
 
void endInteraction ()
 
void dummySignal ()
 
- 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...
 
- 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...
 
- Protected Attributes inherited from pqInteractivePropertyWidget
bool VisibleState = true
 
- Properties inherited from pqInteractivePropertyWidget
pqSMProxy dataSource
 

Detailed Description

pqHandlePropertyWidget is a custom property widget that uses "HandleWidgetRepresentation" to help users interactively set a 3D point in space.

To use this widget for a property group (vtkSMPropertyGroup), use "InteractiveHandle" as the "panel_widget" in the XML configuration for the proxy. The property group should have properties for following functions:

Definition at line 51 of file pqHandlePropertyWidget.h.

Constructor & Destructor Documentation

◆ pqHandlePropertyWidget()

pqHandlePropertyWidget::pqHandlePropertyWidget ( vtkSMProxy proxy,
vtkSMPropertyGroup smgroup,
QWidget *  parent = 0 
)

◆ ~pqHandlePropertyWidget()

pqHandlePropertyWidget::~pqHandlePropertyWidget ( )
override

Member Function Documentation

◆ centerOnBounds

void pqHandlePropertyWidget::centerOnBounds ( )
slot

Update the widget's WorldPosition using current data bounds.

◆ placeWidget

void pqHandlePropertyWidget::placeWidget ( )
overrideprotectedslot

Places the interactive widget using current data source information.


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