pqCoordinateFramePropertyWidget is a custom property widget that uses "CoordinateFrameWidgetRepresentation" to help users interactively set the origin and normal for a plane. More...
#include <pqCoordinateFramePropertyWidget.h>
Public Slots | |
| void | useXNormal () |
| Set the widget normal to be along the X axis. More... | |
| void | useYNormal () |
| Set the widget normal to be along the Y axis. More... | |
| void | useZNormal () |
| Set the widget normal to be along the Z axis. More... | |
| void | resetToWorldXYZ () |
| Reset the axes to align with world coordinate axes. More... | |
| void | resetToDataBounds () |
| Update the widget's origin and bounds using current data bounds. More... | |
| void | resetCameraToNormal () |
| Reset the camera to be down the locked (or nearest) coordinate-frame axis. More... | |
| void | useCameraNormal () |
| Set the locked (or nearest) coordinate frame axis to be along the camera view direction. More... | |
| void | setUserXAxis () |
| Set the X-,Y-, or Z-axis with user-specified values and update the other axes accordingly. More... | |
| void | setUserYAxis () |
| void | setUserZAxis () |
 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 | |
| void | lockedAxisChangedByUser (int) |
| 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... | |
Public Member Functions | |
| pqCoordinateFramePropertyWidget (vtkSMProxy *proxy, vtkSMPropertyGroup *smgroup, QWidget *parent=nullptr) | |
| ~pqCoordinateFramePropertyWidget () override | |
| int | getLockedAxis () const |
| Set/get which axis is locked. More... | |
| void | setLockedAxis (int lockedAxis) |
| 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... | |
| 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... | |
Protected Member Functions | |
| void | setUserAxis (int axis) |
| 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... | |
Properties | |
| int | lockedAxis |
| Properties inherited from pqInteractivePropertyWidgetAbstract | |
| pqSMProxy | dataSource |
Additional Inherited Members | |
| 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 Attributes inherited from pqInteractivePropertyWidgetAbstract | |
| bool | VisibleState = true |
| bool | WidgetVisibility = false |
| int | LinkedPortIndex = -1 |
pqCoordinateFramePropertyWidget is a custom property widget that uses "CoordinateFrameWidgetRepresentation" to help users interactively set the origin and normal for a plane.
To use this widget for a property group (vtkSMPropertyGroup), use "InteractiveFrame" as the "panel_widget" in the XML configuration for the proxy. The property group should have properties for following functions:
Origin: a 3-tuple vtkSMDoubleVectorProperty that will be linked to the origin of the interactive coordinate frame. XAxis: a 3-tuple vtkSMDoubleVectorProperty that will be linked to the x axis for the interactive coordinate frame. YAxis: a 3-tuple vtkSMDoubleVectorProperty that will be linked to the y axis for the interactive coordinate frame. ZAxis: a 3-tuple vtkSMDoubleVectorProperty that will be linked to the z axis for the interactive coordinate frame. Input: (optional) a vtkSMInputProperty that is used to get data information for bounds when placing/resetting the widget. Definition at line 27 of file pqCoordinateFramePropertyWidget.h.
| pqCoordinateFramePropertyWidget::pqCoordinateFramePropertyWidget | ( | vtkSMProxy * | proxy, |
| vtkSMPropertyGroup * | smgroup, | ||
| QWidget * | parent = nullptr |
||
| ) |
|
override |
| int pqCoordinateFramePropertyWidget::getLockedAxis | ( | ) | const |
Set/get which axis is locked.
(-1 indicates no axis is locked.)
| void pqCoordinateFramePropertyWidget::setLockedAxis | ( | int | lockedAxis | ) |
|
inlineslot |
Set the widget normal to be along the X axis.
Definition at line 49 of file pqCoordinateFramePropertyWidget.h.
|
inlineslot |
Set the widget normal to be along the Y axis.
Definition at line 54 of file pqCoordinateFramePropertyWidget.h.
|
inlineslot |
Set the widget normal to be along the Z axis.
Definition at line 59 of file pqCoordinateFramePropertyWidget.h.
|
slot |
Reset the axes to align with world coordinate axes.
|
slot |
Update the widget's origin and bounds using current data bounds.
|
slot |
Reset the camera to be down the locked (or nearest) coordinate-frame axis.
|
slot |
Set the locked (or nearest) coordinate frame axis to be along the camera view direction.
|
slot |
Set the X-,Y-, or Z-axis with user-specified values and update the other axes accordingly.
|
slot |
|
slot |
|
overrideprotectedslot |
Places the interactive widget using current data source information.
|
protected |
|
signal |
|
readwrite |
Definition at line 31 of file pqCoordinateFramePropertyWidget.h.
1.8.13 on Tue Oct 1 2024