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

Provides UI for Box Widget. More...

#include <pqBoxWidget.h>

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

Public Member Functions

 pqBoxWidget (vtkSMProxy *refProxy, vtkSMProxy *proxy, QWidget *p=0)
 
virtual ~pqBoxWidget ()
 
virtual void resetBounds (double bounds[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 accept ()
 accept the changes. More...
 
virtual void reset ()
 reset the changes. More...
 
virtual void select ()
 Overridden to update widget placement based on data bounds. More...
 
- Public Member Functions inherited from pq3DWidget
 pq3DWidget (vtkSMProxy *referenceProxy, vtkSMProxy *proxy, QWidget *parent=0)
 
virtual ~pq3DWidget ()
 
vtkSMProxygetControlledProxy () const
 Controlled proxy is a proxy which is controlled by the 3D widget. More...
 
vtkSMProxygetReferenceProxy () const
 
void setHints (vtkPVXMLElement *element)
 Set the hints XML to be using to map the 3D widget to the controlled proxy. More...
 
vtkPVXMLElementgetHints () const
 
vtkSMNewWidgetRepresentationProxygetWidgetProxy () 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...
 
vtkSMProxyproxy () 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 Member Functions

void createWidget (pqServer *)
 Internal method to create the widget. 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 updateWidgetVisibility ()
 Update the widget visibility according to the WidgetVisible and Selected flags. 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

- 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 deselect ()
 Deactivates the widget. 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 deselect ()
 Called when the panel becomes inactive. More...
 
virtual void setView (pqView *)
 Set the view that this panel works with. More...
 
virtual void setModified ()
 Fires modified. More...
 
- 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 *)
 
- Static Public Member Functions inherited from pq3DWidget
static QList< pq3DWidget * > createWidgets (vtkSMProxy *refProxy, vtkSMProxy *proxy)
 
- 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...
 

Detailed Description

Provides UI for Box Widget.

Definition at line 42 of file pqBoxWidget.h.

Constructor & Destructor Documentation

§ pqBoxWidget()

pqBoxWidget::pqBoxWidget ( vtkSMProxy refProxy,
vtkSMProxy proxy,
QWidget *  p = 0 
)

§ ~pqBoxWidget()

virtual pqBoxWidget::~pqBoxWidget ( )
virtual

Member Function Documentation

§ resetBounds() [1/2]

virtual void pqBoxWidget::resetBounds ( double  bounds[6])
virtual

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.

§ resetBounds() [2/2]

virtual void pqBoxWidget::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 60 of file pqBoxWidget.h.

§ accept()

virtual void pqBoxWidget::accept ( )
virtual

accept the changes.

Overridden to hide handles.

Reimplemented from pq3DWidget.

§ reset()

virtual void pqBoxWidget::reset ( )
virtual

reset the changes.

Overridden to hide handles.

Reimplemented from pq3DWidget.

§ select()

virtual void pqBoxWidget::select ( )
virtual

Overridden to update widget placement based on data bounds.

Reimplemented from pq3DWidget.

§ createWidget()

void pqBoxWidget::createWidget ( pqServer )
protected

Internal method to create the widget.


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