ParaView
Public Member Functions | Friends | List of all members
vtkPVPlugin Class Referenceabstract

defines the core interface for any ParaView plugin. More...

#include <vtkPVPlugin.h>

Public Member Functions

 vtkPVPlugin ()
 
virtual ~vtkPVPlugin ()
 
const char * GetFileName ()
 
virtual const char * GetPluginName ()=0
 Returns the name for this plugin. More...
 
virtual const char * GetPluginVersionString ()=0
 Returns the version for this plugin. More...
 
virtual bool GetRequiredOnServer ()=0
 Returns true if this plugin is required on the server. More...
 
virtual bool GetRequiredOnClient ()=0
 Returns true if this plugin is required on the client. More...
 
virtual const char * GetRequiredPlugins ()=0
 Returns a ';' separated list of plugin names required by this plugin. More...
 
virtual void GetBinaryResources (std::vector< std::string > &resources)
 Provides access to binary resources compiled into the plugin. More...
 

Static Public Member Functions

static void ImportPlugin (vtkPVPlugin *plugin)
 Used when import plugins programmatically. More...
 

Friends

class vtkPVPluginLoader
 

Detailed Description

defines the core interface for any ParaView plugin.

vtkPVPlugin defines the core interface for any ParaView plugin. A plugin implementing merely this interface is pretty much useless. The header file also defines few import macros that are required for exporting/importing plugins.

When debugging issues with plugins try setting the PV_PLUGIN_DEBUG environment variable on all the processes where you are trying to load the plugin. That will print extra information as the plugin is being loaded.

Definition at line 50 of file vtkPVPlugin.h.

Constructor & Destructor Documentation

◆ vtkPVPlugin()

vtkPVPlugin::vtkPVPlugin ( )

◆ ~vtkPVPlugin()

virtual vtkPVPlugin::~vtkPVPlugin ( )
virtual

Member Function Documentation

◆ GetFileName()

const char* vtkPVPlugin::GetFileName ( )
inline

Definition at line 60 of file vtkPVPlugin.h.

◆ GetPluginName()

virtual const char* vtkPVPlugin::GetPluginName ( )
pure virtual

Returns the name for this plugin.

◆ GetPluginVersionString()

virtual const char* vtkPVPlugin::GetPluginVersionString ( )
pure virtual

Returns the version for this plugin.

◆ GetRequiredOnServer()

virtual bool vtkPVPlugin::GetRequiredOnServer ( )
pure virtual

Returns true if this plugin is required on the server.

◆ GetRequiredOnClient()

virtual bool vtkPVPlugin::GetRequiredOnClient ( )
pure virtual

Returns true if this plugin is required on the client.

◆ GetRequiredPlugins()

virtual const char* vtkPVPlugin::GetRequiredPlugins ( )
pure virtual

Returns a ';' separated list of plugin names required by this plugin.

◆ GetBinaryResources()

virtual void vtkPVPlugin::GetBinaryResources ( std::vector< std::string > &  resources)
virtual

Provides access to binary resources compiled into the plugin.

This is primarily used to compile in icons and compressed help project (qch) files into plugins.

◆ ImportPlugin()

static void vtkPVPlugin::ImportPlugin ( vtkPVPlugin plugin)
static

Used when import plugins programmatically.

This must only be called after the application has initialized, more specifically, all plugin managers have been created and they have registered their callbacks.

Friends And Related Function Documentation

◆ vtkPVPluginLoader

friend class vtkPVPluginLoader
friend

Definition at line 54 of file vtkPVPlugin.h.


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