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

pqSplinePropertyWidget is a custom property widget that uses "SplineWidgetRepresentation" to help users interactively set points that form a spline. More...

#include <pqSplinePropertyWidget.h>

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

Public Types

enum  ModeTypes { SPLINE =0, POLYLINE =1 }
 

Public Slots

void setLineColor (const QColor &)
 Set the color to use for the spline. 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

 pqSplinePropertyWidget (vtkSMProxy *proxy, vtkSMPropertyGroup *smgroup, ModeTypes mode=SPLINE, QWidget *parent=0)
 
virtual ~pqSplinePropertyWidget ()
 
- 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...
 
vtkSMNewWidgetRepresentationProxy * widgetProxy () 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...
 
vtkSMProxy * dataSource () 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
 
vtkSMProxy * proxy () const
 
vtkSMProperty * property () 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 ()
 
- 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. May return an empty string. 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

pqSplinePropertyWidget is a custom property widget that uses "SplineWidgetRepresentation" to help users interactively set points that form a spline.

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

Definition at line 54 of file pqSplinePropertyWidget.h.

Member Enumeration Documentation

§ ModeTypes

Enumerator
SPLINE 
POLYLINE 

Definition at line 59 of file pqSplinePropertyWidget.h.

Constructor & Destructor Documentation

§ pqSplinePropertyWidget()

pqSplinePropertyWidget::pqSplinePropertyWidget ( vtkSMProxy *  proxy,
vtkSMPropertyGroup *  smgroup,
ModeTypes  mode = SPLINE,
QWidget *  parent = 0 
)

§ ~pqSplinePropertyWidget()

virtual pqSplinePropertyWidget::~pqSplinePropertyWidget ( )
virtual

Member Function Documentation

§ setLineColor

void pqSplinePropertyWidget::setLineColor ( const QColor &  )
slot

Set the color to use for the spline.

§ placeWidget

virtual void pqSplinePropertyWidget::placeWidget ( )
protectedvirtualslot

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