interface class for plugins that create view modules More...
#include <pqViewModuleInterface.h>
Public Member Functions | |
| pqViewModuleInterface () | |
| virtual | ~pqViewModuleInterface () |
| virtual QStringList | viewTypes () const =0 |
| Return a list of view types supported by this interface. | |
| virtual QStringList | displayTypes () const |
| Return a list of display types supported by this interface overload this if you have custom pqConsuerDisplay's. | |
| virtual QString | viewTypeName (const QString &viewtype) const =0 |
| Return a friendly type name (e.g. | |
| virtual bool | canCreateView (const QString &viewtype) const =0 |
| Returns true if this can create a view of a given name The name corresponds to the Server Manager XML Hint such as. | |
| virtual vtkSMProxy * | createViewProxy (const QString &viewtype, pqServer *server)=0 |
| Creates the Server Manager view module For example: | |
| virtual pqView * | createView (const QString &viewtypemodule, const QString &group, const QString &name, vtkSMViewProxy *viewmodule, pqServer *server, QObject *parent)=0 |
| Creates the GUI view that corresponds with the server manager view viewtype is the type of view (e.g. | |
| virtual pqDataRepresentation * | createDisplay (const QString &, const QString &, const QString &, vtkSMProxy *, pqServer *, QObject *) |
| Creates a pqDataRepresentation that corresponds with the ViewModuleProxy's display_name this is optional and only needs to be implemented if the pqDataRepresentation needs to do something special. | |
Detailed Description
interface class for plugins that create view modules
Definition at line 47 of file pqViewModuleInterface.h.
Constructor & Destructor Documentation
| pqViewModuleInterface::pqViewModuleInterface | ( | ) |
| virtual pqViewModuleInterface::~pqViewModuleInterface | ( | ) | [virtual] |
Member Function Documentation
| virtual QStringList pqViewModuleInterface::viewTypes | ( | ) | const [pure virtual] |
Return a list of view types supported by this interface.
Implemented in pqStandardViewModules.
| virtual QStringList pqViewModuleInterface::displayTypes | ( | ) | const [inline, virtual] |
Return a list of display types supported by this interface overload this if you have custom pqConsuerDisplay's.
Reimplemented in pqStandardViewModules.
Definition at line 58 of file pqViewModuleInterface.h.
| virtual QString pqViewModuleInterface::viewTypeName | ( | const QString & | viewtype | ) | const [pure virtual] |
Return a friendly type name (e.g.
"My Custom View" in place of "MyCustomView")
Implemented in pqStandardViewModules.
| virtual bool pqViewModuleInterface::canCreateView | ( | const QString & | viewtype | ) | const [pure virtual] |
Returns true if this can create a view of a given name The name corresponds to the Server Manager XML Hint such as.
/// <SourceProxy name="MyCustomFilter" class="vtkMyCustomFilter"> /// ... /// <Hints> /// <View type="MyCustom" /> /// </Hints> /// </SourceProxy> ///
Implemented in pqStandardViewModules.
| virtual vtkSMProxy* pqViewModuleInterface::createViewProxy | ( | const QString & | viewtype, |
| pqServer * | server | ||
| ) | [pure virtual] |
Creates the Server Manager view module For example:
/// <ProxyGroup name="plotmodules"> /// <ViewModuleProxy name="MyCustomViewModule"> /// base_proxygroup="rendermodules" /// base_proxyname="ViewModule" /// display_name="MyCustomViewDisplay" /// </ViewModuleProxy> /// </ProxyGroup> ///
implement this to call vtkSMProxyManager::NewProxy("plotmodules", "MyCustomViewModule")
Implemented in pqStandardViewModules.
| virtual pqView* pqViewModuleInterface::createView | ( | const QString & | viewtypemodule, |
| const QString & | group, | ||
| const QString & | name, | ||
| vtkSMViewProxy * | viewmodule, | ||
| pqServer * | server, | ||
| QObject * | parent | ||
| ) | [pure virtual] |
Creates the GUI view that corresponds with the server manager view viewtype is the type of view (e.g.
MyCustomViewModule), group is the group that the viewmodule was registered with, name is the name that the view module was registered with, viewmodule is the server manager view module this GUI side view module corresponds with, server is the server it was created on, parent is the QObject parent.
Implemented in pqStandardViewModules.
| virtual pqDataRepresentation* pqViewModuleInterface::createDisplay | ( | const QString & | , |
| const QString & | , | ||
| const QString & | , | ||
| vtkSMProxy * | , | ||
| pqServer * | , | ||
| QObject * | |||
| ) | [inline, virtual] |
Creates a pqDataRepresentation that corresponds with the ViewModuleProxy's display_name this is optional and only needs to be implemented if the pqDataRepresentation needs to do something special.
Reimplemented in pqStandardViewModules.
Definition at line 113 of file pqViewModuleInterface.h.
The documentation for this class was generated from the following file:
- /home/kitware/Dashboards/My Tests/ParaView/Qt/Core/pqViewModuleInterface.h
