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

GUI for ContourWidgetRepresentation. This is a 3D widget that edits a Contour. More...

#include <pqContourWidget.h>

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

Public Slots

void removeAllNodes ()
 
void checkContourLoopClosed ()
 
void closeLoop (bool)
 Close the contour loop. More...
 
void updateMode ()
 Move to the next mode ( Drawing, Editing, Done ) More...
 
void toggleEditMode ()
 Toggle the edit mode, which will switch between Edit/Modify mode. More...
 
void finishContour ()
 Finish editing the contour. More...
 
virtual void reset ()
 Resets pending changes. More...
 
- Public Slots inherited from pq3DWidget
void setWidgetVisible (bool)
 Sets 3D widget visibility. More...
 
void showWidget ()
 Makes the 3D widget visible. More...
 
void hideWidget ()
 Hides the 3D widget. More...
 
virtual void accept ()
 Accepts pending changes. More...
 
virtual void reset ()
 Resets pending changes. More...
 
virtual void setView (pqView *)
 Set the view that this panel works with. More...
 
virtual void setUseSelectionDataBounds (bool use)
 When set to true, instead of using the referenceProxy to obtain the default bounds to reset to, it will use the bounds for the selected sources as indicated by pqApplicationCore::getSelectionModel()->getSelectionDataBounds(). More...
 
bool useSelectionDataBounds ()
 
- Public Slots inherited from pqProxyPanel
virtual void accept ()
 accept the changes made to the properties changes will be propogated down to the server manager subclasses should only change properties when accept is called to work properly with undo/redo More...
 
virtual void reset ()
 reset the changes made editor will query properties from the server manager More...
 
virtual void setView (pqView *)
 Set the view that this panel works with. More...
 
virtual void setModified ()
 Fires modified. More...
 

Signals

void contourLoopClosed ()
 Signal emitted when the representation proxy's "ClosedLoop" property is modified. More...
 
void contourDone ()
 
- Signals inherited from pq3DWidget
void widgetVisibilityChanged (bool)
 Notifies observers that widget visibility has changed. More...
 
void widgetStartInteraction ()
 Notifies observers that the user is dragging the 3D widget. More...
 
void widgetEndInteraction ()
 Notifies observers that the user is done dragging the 3D widget. More...
 
void widgetInteraction ()
 Notifies observers that the user is dragging the 3D widget. More...
 
- Signals inherited from pqProxyPanel
void modified ()
 
void onaccept ()
 
void onreset ()
 
void onselect ()
 
void ondeselect ()
 
void viewChanged (pqView *)
 

Public Member Functions

 pqContourWidget (vtkSMProxy *refProxy, vtkSMProxy *proxy, QWidget *parent)
 
virtual ~pqContourWidget ()
 
virtual void resetBounds (double [6])
 Resets the bounds of the 3D widget to the reference proxy bounds. More...
 
virtual void resetBounds ()
 Resets the bounds of the 3D widget to the reference proxy bounds. More...
 
virtual void setPointPlacer (vtkSMProxy *)
 
virtual void setLineInterpolator (vtkSMProxy *)
 
virtual void select ()
 Activates the widget. Respects the visibility flag. More...
 
virtual void deselect ()
 Deactivates the widget. More...
 
virtual void setLineColor (const QColor &color)
 Set the line color. More...
 
- Public Member Functions inherited from pq3DWidget
 pq3DWidget (vtkSMProxy *referenceProxy, vtkSMProxy *proxy, QWidget *parent=0)
 
virtual ~pq3DWidget ()
 
vtkSMProxy * getControlledProxy () const
 Controlled proxy is a proxy which is controlled by the 3D widget. More...
 
vtkSMProxy * getReferenceProxy () const
 
void setHints (vtkPVXMLElement *element)
 Set the hints XML to be using to map the 3D widget to the controlled proxy. More...
 
vtkPVXMLElement * getHints () const
 
vtkSMNewWidgetRepresentationProxy * getWidgetProxy () const
 Return the 3D Widget proxy. More...
 
bool widgetVisible () const
 Returns true if 3D widget visibility is enabled. More...
 
bool widgetSelected () const
 Returns true if 3D widget is selected. More...
 
pqRenderViewBaserenderView () const
 Returns the current render view. More...
 
- Public Member Functions inherited from pqProxyPanel
 pqProxyPanel (vtkSMProxy *proxy, QWidget *p)
 constructor More...
 
 ~pqProxyPanel ()
 destructor More...
 
vtkSMProxy * proxy () const
 get the proxy for which properties are displayed More...
 
pqViewview () const
 get the view that this object panel works with. More...
 
QSize sizeHint () const
 size hint for this widget More...
 
pqPropertyManagerpropertyManager ()
 property manager belongs to this panel More...
 
bool selected () const
 returns whether selected More...
 

Protected Slots

void deleteAllNodes ()
 
- Protected Slots inherited from pq3DWidget
void render ()
 Called to request a render. More...
 
void setPickOnMeshPoint (bool)
 
void pickPoint ()
 triggers a pick action using the current location of the mouse. More...
 
virtual void pick (double, double, double)
 Called on each pick, default implementation does nothing. More...
 
- Protected Slots inherited from pqProxyPanel
virtual void updateInformationAndDomains ()
 This method gets called to referesh all domains and information properties. More...
 
void dataUpdated ()
 Called after the algorithm executes. More...
 

Protected Member Functions

virtual void createWidget (pqServer *)
 Internal method to create the widget. More...
 
virtual void updateWidgetVisibility ()
 Update the widget visibility according to the WidgetVisible and Selected flags. More...
 
- Protected Member Functions inherited from pq3DWidget
virtual void updateMasterEnableState (bool)
 Called when master/slave change. More...
 
void handleReferenceProxyUserEvent (vtkObject *, unsigned long, void *)
 Handle custom user notification to show/hide corresponding widget. More...
 
bool pickOnMeshPoint () const
 
virtual void setControlledProperty (const char *function, vtkSMProperty *controlled_property)
 Subclasses can override this method to map properties to GUI. More...
 
void pickingSupported (const QKeySequence &key)
 Subclasses should call this method if they support picking. More...
 
void setControlledProperty (vtkSMProperty *widget_property, vtkSMProperty *controlled_property)
 
void setWidgetProxy (vtkSMNewWidgetRepresentationProxy *)
 
virtual void onControlledPropertyChanged ()
 Called when one of the controlled properties change (e.g: by undo/redo) More...
 
int getReferenceInputBounds (double bounds[6]) const
 Used to get the input bounds on for the reference proxy, if any. More...
 
virtual void updateWidgetState (bool visible, bool enable)
 Update the widget visibility and enable state. More...
 
virtual void updatePickShortcut ()
 updates the enable state of the picking shortcut. More...
 
virtual void updatePickShortcut (bool pickable)
 
- Protected Member Functions inherited from pqProxyPanel
bool event (QEvent *e)
 

Additional Inherited Members

- Static Public Member Functions inherited from pq3DWidget
static QList< pq3DWidget * > createWidgets (vtkSMProxy *refProxy, vtkSMProxy *proxy)
 

Detailed Description

GUI for ContourWidgetRepresentation. This is a 3D widget that edits a Contour.

Definition at line 42 of file pqContourWidget.h.

Constructor & Destructor Documentation

§ pqContourWidget()

pqContourWidget::pqContourWidget ( vtkSMProxy *  refProxy,
vtkSMProxy *  proxy,
QWidget *  parent 
)

§ ~pqContourWidget()

virtual pqContourWidget::~pqContourWidget ( )
virtual

Member Function Documentation

§ resetBounds() [1/2]

virtual void pqContourWidget::resetBounds ( double  [6])
inlinevirtual

Resets the bounds of the 3D widget to the reference proxy bounds.

This typically calls PlaceWidget on the underlying 3D Widget with reference proxy bounds. This should be explicitly called after the panel is created and the widget is initialized i.e. the reference proxy, controlled proxy and hints have been set.

Implements pq3DWidget.

Definition at line 56 of file pqContourWidget.h.

§ resetBounds() [2/2]

virtual void pqContourWidget::resetBounds ( )
inlinevirtual

Resets the bounds of the 3D widget to the reference proxy bounds.

This typically calls PlaceWidget on the underlying 3D Widget with reference proxy bounds. This should be explicitly called after the panel is created and the widget is initialized i.e. the reference proxy, controlled proxy and hints have been set. Default implementation uses the getReferenceInputBounds() to get the bounds and then calls resetBounds(double bounds[]). Subclasses generally need to override this resetBounds(double*) method.

Reimplemented from pq3DWidget.

Definition at line 57 of file pqContourWidget.h.

§ setPointPlacer()

virtual void pqContourWidget::setPointPlacer ( vtkSMProxy *  )
virtual

§ setLineInterpolator()

virtual void pqContourWidget::setLineInterpolator ( vtkSMProxy *  )
virtual

§ select()

virtual void pqContourWidget::select ( )
virtual

Activates the widget. Respects the visibility flag.

Reimplemented from pq3DWidget.

§ deselect()

virtual void pqContourWidget::deselect ( )
virtual

Deactivates the widget.

Reimplemented from pq3DWidget.

§ setLineColor()

virtual void pqContourWidget::setLineColor ( const QColor &  color)
virtual

Set the line color.

§ contourLoopClosed

void pqContourWidget::contourLoopClosed ( )
signal

Signal emitted when the representation proxy's "ClosedLoop" property is modified.

§ contourDone

void pqContourWidget::contourDone ( )
signal

§ removeAllNodes

void pqContourWidget::removeAllNodes ( )
slot

§ checkContourLoopClosed

void pqContourWidget::checkContourLoopClosed ( )
slot

§ closeLoop

void pqContourWidget::closeLoop ( bool  )
slot

Close the contour loop.

§ updateMode

void pqContourWidget::updateMode ( )
slot

Move to the next mode ( Drawing, Editing, Done )

§ toggleEditMode

void pqContourWidget::toggleEditMode ( )
slot

Toggle the edit mode, which will switch between Edit/Modify mode.

§ finishContour

void pqContourWidget::finishContour ( )
slot

Finish editing the contour.

§ reset

virtual void pqContourWidget::reset ( )
virtualslot

Resets pending changes.

Default implementation pushes the property values of the controlled widget to the 3D widget properties. The correspondence is determined from the <Hints> associated with the controlled proxy.

§ createWidget()

virtual void pqContourWidget::createWidget ( pqServer )
protectedvirtual

Internal method to create the widget.

§ updateWidgetVisibility()

virtual void pqContourWidget::updateWidgetVisibility ( )
protectedvirtual

Update the widget visibility according to the WidgetVisible and Selected flags.

Reimplemented from pq3DWidget.

§ deleteAllNodes

void pqContourWidget::deleteAllNodes ( )
protectedslot

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