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

pqLinePropertyWidget is a custom property widget that uses "LineWidgetRepresentation" to help the users More...

#include <pqLinePropertyWidget.h>

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

Public Slots

void useXAxis ()
 
void useYAxis ()
 
void useZAxis ()
 
void centerOnBounds ()
 
void setLineColor (const QColor &color)
 Set the color to use for the line widget. 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

 pqLinePropertyWidget (vtkSMProxy *proxy, vtkSMPropertyGroup *smgroup, QWidget *parent=0)
 
virtual ~pqLinePropertyWidget ()
 
- Public Member Functions inherited from pqInteractivePropertyWidget
 pqInteractivePropertyWidget (const char *widget_smgroup, const char *widget_smname, vtkSMProxy *proxy, vtkSMPropertyGroup *smgroup, QWidget *parent=0)
 
virtual ~pqInteractivePropertyWidget ()
 
virtual void reset ()
 Overridden to call this->render() to ensure that the widget is redrawn. More...
 
vtkSMNewWidgetRepresentationProxywidgetProxy () const
 Returns the proxy for the interactive widget. More...
 
virtual void setView (pqView *view)
 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...
 
virtual void select ()
 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...
 
virtual void deselect ()
 
vtkBoundingBox dataBounds () const
 Returns bounds from the dataSource, if possible. More...
 
- Public Member Functions inherited from pqPropertyWidget
 pqPropertyWidget (vtkSMProxy *proxy, QWidget *parent=0)
 
virtual ~pqPropertyWidget ()
 
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)
 
bool showLabel () const
 
const QList< QPointer< pqPropertyWidgetDecorator > > & decorators () const
 Provides access to the decorators for this widget. More...
 
void setProperty (vtkSMProperty *property)
 

Protected Slots

virtual void placeWidget ()
 Places the interactive widget using current data source information. More...
 
void pick (double x, double y, double z)
 Called when user picks a point using the pick shortcut keys. More...
 
void pickPoint1 (double x, double y, double z)
 
void pickPoint2 (double x, double y, double z)
 
void updateLengthLabel ()
 Updates the length label. 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...
 
- 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...
 
pqPropertyLinkslinks ()
 Provides access to the pqPropertyLinks instance. More...
 
- Properties inherited from pqInteractivePropertyWidget
pqSMProxy dataSource
 

Detailed Description

pqLinePropertyWidget is a custom property widget that uses "LineWidgetRepresentation" to help the users

pqLinePropertyWidget is a custom property widget that uses "LineSourceWidgetRepresentation" to help users interactively select the end points of a line. To use this widget for a property group (vtkSMPropertyGroup), use "InteractiveLine" as the "panel_widget" in the XML configuration for the proxy. The property group should have properties for following functions:

Definition at line 58 of file pqLinePropertyWidget.h.

Constructor & Destructor Documentation

§ pqLinePropertyWidget()

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

§ ~pqLinePropertyWidget()

virtual pqLinePropertyWidget::~pqLinePropertyWidget ( )
virtual

Member Function Documentation

§ useXAxis

void pqLinePropertyWidget::useXAxis ( )
slot

§ useYAxis

void pqLinePropertyWidget::useYAxis ( )
slot

§ useZAxis

void pqLinePropertyWidget::useZAxis ( )
slot

§ centerOnBounds

void pqLinePropertyWidget::centerOnBounds ( )
slot

§ setLineColor

void pqLinePropertyWidget::setLineColor ( const QColor &  color)
slot

Set the color to use for the line widget.

§ placeWidget

virtual void pqLinePropertyWidget::placeWidget ( )
protectedvirtualslot

Places the interactive widget using current data source information.

§ pick

void pqLinePropertyWidget::pick ( double  x,
double  y,
double  z 
)
protectedslot

Called when user picks a point using the pick shortcut keys.

§ pickPoint1

void pqLinePropertyWidget::pickPoint1 ( double  x,
double  y,
double  z 
)
protectedslot

§ pickPoint2

void pqLinePropertyWidget::pickPoint2 ( double  x,
double  y,
double  z 
)
protectedslot

§ updateLengthLabel

void pqLinePropertyWidget::updateLengthLabel ( )
protectedslot

Updates the length label.


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