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

pqQVTKWidget has a QVTKOpenGL*Widget object to which it adds awareness for view proxies. More...

#include <pqQVTKWidget.h>

Inherits QWidget.

Public Slots

void paintMousePointer (int x, int y)
 

Public Member Functions

 pqQVTKWidget (QWidget *parent=nullptr, Qt::WindowFlags f=Qt::WindowFlags{})
 
 pqQVTKWidget (QWidget *parentObject, Qt::WindowFlags f, bool isStereo)
 
 ~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
 
void notifyQApplication (QMouseEvent *)
 
void setRenderWindow (vtkRenderWindow *win)
 Methods that decorates QVTKOpenGL*Widget methods. More...
 
vtkRenderWindowrenderWindow () const
 
QVTKInteractor * interactor () const
 
bool isValid ()
 
void setEnableHiDPI (bool flag)
 
void setCustomDevicePixelRatio (double cdpr)
 
double effectiveDevicePixelRatio () const
 
void setViewSize (int width, int height)
 

Protected Member Functions

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

Detailed Description

pqQVTKWidget has a QVTKOpenGL*Widget object to which it adds 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 its contained QVTKOpenGL*Widget class).

Definition at line 58 of file pqQVTKWidget.h.

Constructor & Destructor Documentation

◆ pqQVTKWidget() [1/2]

pqQVTKWidget::pqQVTKWidget ( QWidget *  parent = nullptr,
Qt::WindowFlags  f = Qt::WindowFlags{} 
)

◆ pqQVTKWidget() [2/2]

pqQVTKWidget::pqQVTKWidget ( QWidget *  parentObject,
Qt::WindowFlags  f,
bool  isStereo 
)

◆ ~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 88 of file pqQVTKWidget.h.

◆ sizePropertyName()

const QString& pqQVTKWidget::sizePropertyName ( ) const
inline

Definition at line 89 of file pqQVTKWidget.h.

◆ notifyQApplication()

void pqQVTKWidget::notifyQApplication ( QMouseEvent *  )

◆ setRenderWindow()

void pqQVTKWidget::setRenderWindow ( vtkRenderWindow win)

Methods that decorates QVTKOpenGL*Widget methods.

◆ renderWindow()

vtkRenderWindow* pqQVTKWidget::renderWindow ( ) const

◆ interactor()

QVTKInteractor* pqQVTKWidget::interactor ( ) const

◆ isValid()

bool pqQVTKWidget::isValid ( )

◆ setEnableHiDPI()

void pqQVTKWidget::setEnableHiDPI ( bool  flag)

◆ setCustomDevicePixelRatio()

void pqQVTKWidget::setCustomDevicePixelRatio ( double  cdpr)

◆ effectiveDevicePixelRatio()

double pqQVTKWidget::effectiveDevicePixelRatio ( ) const

◆ setViewSize()

void pqQVTKWidget::setViewSize ( int  width,
int  height 
)

◆ 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: