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

This is 3DWidget Factory. More...

#include <pq3DWidgetFactory.h>

Inherits QObject.

Public Member Functions

 pq3DWidgetFactory (QObject *parent=NULL)
 
virtual ~pq3DWidgetFactory ()
 
vtkSMNewWidgetRepresentationProxyget3DWidget (const QString &name, pqServer *server, vtkSMProxy *referenceProxy=0)
 Use this method to obtain a 3D widget of the given name on the given server. More...
 
void free3DWidget (vtkSMNewWidgetRepresentationProxy *widget)
 Call this method when done with using a 3D widget, this makes the 3DWidget available for reuse. More...
 

Protected Attributes

pq3DWidgetFactoryInternal * Internal
 

Detailed Description

This is 3DWidget Factory.

One can request a 3D widget of any type from this class on the given server. If a 3D widget is available, it will be reused, and marked in-use. When the caller is done using the 3D widget, it must call free3DWidget(), which makes the widget available for reuse.

Definition at line 51 of file pq3DWidgetFactory.h.

Constructor & Destructor Documentation

◆ pq3DWidgetFactory()

pq3DWidgetFactory::pq3DWidgetFactory ( QObject *  parent = NULL)

◆ ~pq3DWidgetFactory()

virtual pq3DWidgetFactory::~pq3DWidgetFactory ( )
virtual

Member Function Documentation

◆ get3DWidget()

vtkSMNewWidgetRepresentationProxy* pq3DWidgetFactory::get3DWidget ( const QString &  name,
pqServer server,
vtkSMProxy referenceProxy = 0 
)

Use this method to obtain a 3D widget of the given name on the given server.

If no 3D widget is available, a new one will be created on the server and returned. The caller can call free3DWidget() when it is done with the 3D Widget, that way it can be used by others.

◆ free3DWidget()

void pq3DWidgetFactory::free3DWidget ( vtkSMNewWidgetRepresentationProxy widget)

Call this method when done with using a 3D widget, this makes the 3DWidget available for reuse.

Member Data Documentation

◆ Internal

pq3DWidgetFactoryInternal* pq3DWidgetFactory::Internal
protected

Definition at line 87 of file pq3DWidgetFactory.h.


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