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

pqQVTKWidget extends pqQVTKWidgetBase to add awareness for view proxies. More...

#include <pqQVTKWidget.h>

Inherits pqQVTKWidgetBase.

Public Slots

void paintMousePointer (int x, int y)
 

Public Member Functions

 pqQVTKWidget (QWidget *parent=NULL, Qt::WindowFlags f=0)
 
 ~pqQVTKWidget () override
 
void setViewProxy (vtkSMProxy *)
 Set the view proxy. More...
 
void setSession (vtkSMSession *)
 Set the session. More...
 
vtkTypeUInt32 getProxyId ()
 Return the Proxy ID if any, otherwise return 0. More...
 
void setSizePropertyName (const QString &pname)
 Set/Get the name of the property to use to update the size of the widget on the proxy. More...
 
const QString & sizePropertyName () const
 

Protected Member Functions

bool renderVTK ()
 
bool canRender ()
 
void resizeEvent (QResizeEvent *evt) override
 

Detailed Description

pqQVTKWidget extends pqQVTKWidgetBase to add awareness for view proxies.

The advantage of doing that is that pqQVTKWidget can automatically update the "ViewSize" property on the view proxy whenever the widget's size/position changes.

This class also enables image-caching by default (image caching support is provided by the superclass).

Definition at line 55 of file pqQVTKWidget.h.

Constructor & Destructor Documentation

◆ pqQVTKWidget()

pqQVTKWidget::pqQVTKWidget ( QWidget *  parent = NULL,
Qt::WindowFlags  f = 0 
)

◆ ~pqQVTKWidget()

pqQVTKWidget::~pqQVTKWidget ( )
override

Member Function Documentation

◆ setViewProxy()

void pqQVTKWidget::setViewProxy ( vtkSMProxy )

Set the view proxy.

◆ setSession()

void pqQVTKWidget::setSession ( vtkSMSession )

Set the session.

This is only used when ViewProxy is not set.

◆ getProxyId()

vtkTypeUInt32 pqQVTKWidget::getProxyId ( )

Return the Proxy ID if any, otherwise return 0.

◆ setSizePropertyName()

void pqQVTKWidget::setSizePropertyName ( const QString &  pname)
inline

Set/Get the name of the property to use to update the size of the widget on the proxy.

By default "ViewSize" is used.

Definition at line 84 of file pqQVTKWidget.h.

◆ sizePropertyName()

const QString& pqQVTKWidget::sizePropertyName ( ) const
inline

Definition at line 85 of file pqQVTKWidget.h.

◆ paintMousePointer

void pqQVTKWidget::paintMousePointer ( int  x,
int  y 
)
slot

◆ renderVTK()

bool pqQVTKWidget::renderVTK ( )
protected

◆ canRender()

bool pqQVTKWidget::canRender ( )
protected

◆ resizeEvent()

void pqQVTKWidget::resizeEvent ( QResizeEvent *  evt)
overrideprotected

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