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

#include <vtkPVPlugin.h>

Inheritance diagram for vtkPVPlugin:

[legend]

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 const char *	GetDescription ()=0
	Returns a description of this plugin. More...

virtual const char *	GetEULA ()=0
	Returns EULA for the plugin, if any. More...

virtual void	GetBinaryResources (std::vector< std::string > &resources)
	Provides access to binary resources compiled into the plugin. More...

Protected Member Functions
void	SetFileName (const char *filename)
	Set the filename the plugin is loaded from, if any. More...

Friends
class	vtkPVPluginLoader

typedef bool(*	EULAConfirmationCallback) (vtkPVPlugin *)
	Type for EULAConfirmationCallback. More...

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

static void	SetEULAConfirmationCallback (EULAConfirmationCallback callback)
	Get/Set the static callback to call to confirm EULA. More...

static EULAConfirmationCallback	GetEULAConfirmationCallback ()
	Type for EULAConfirmationCallback. More...

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 PARAVIEW_LOG_PLUGIN_VERBOSITY=<level> 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. See vtkPVLogger::SetPluginVerbosity for details.

Definition at line 38 of file vtkPVPlugin.h.

Member Typedef Documentation

◆ EULAConfirmationCallback

typedef bool(* vtkPVPlugin::EULAConfirmationCallback) (vtkPVPlugin *)

Type for EULAConfirmationCallback.

Definition at line 107 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 44 of file vtkPVPlugin.h.

◆ GetPluginName()

virtual const char* vtkPVPlugin::GetPluginName ( )

pure virtual

Returns the name for this plugin.

Implemented in AcceleratedAlgorithmsPlugin, AnalyzeNIfTIReaderWriterPlugin, ArrowGlyphPlugin, BagPlotViewsAndFiltersPlugin, BivariateRepresentationsPlugin, CFSReaderPlugin, ContourLabelPluginPlugin, DataminePlugin, DigitalRockPhysicsPlugin, DigitalSignalProcessingPlugin, EmbossingRepresentationsPlugin, EnSightGoldCombinedReaderPlugin, ExplicitStructuredGridPlugin, FlipBookPluginPlugin, GenericIOReaderPlugin, GeodesicMeasurementPlugin, GMVReaderPlugin, HyperTreeGridADRPlugin, LagrangianParticleTrackerPlugin, LANLX3DReaderPlugin, LegacyExodusReaderPlugin, LegacyExodusWriterPlugin, LegacyGhostCellsGeneratorPlugin, MomentsPlugin, MooseXfemClipPlugin, NodeEditorPlugin, NonOrthogonalSourcePlugin, PanoramicProjectionViewPlugin, ParametricSurfacesPlugin, PrismPlugin, SaveStateAndScreenshotPlugin, SLACToolsPlugin, StereoCursorViewPlugin, StreamingParticlesPlugin, StreamLinesRepresentationPlugin, ThickenLayeredCellsPlugin, VTKmFiltersPlugin, and vtkPVPythonAlgorithmPlugin.

◆ GetPluginVersionString()

virtual const char* vtkPVPlugin::GetPluginVersionString ( )

pure virtual

Returns the version for this plugin.

Implemented in AcceleratedAlgorithmsPlugin, AnalyzeNIfTIReaderWriterPlugin, ArrowGlyphPlugin, BagPlotViewsAndFiltersPlugin, BivariateRepresentationsPlugin, CFSReaderPlugin, ContourLabelPluginPlugin, DataminePlugin, DigitalRockPhysicsPlugin, DigitalSignalProcessingPlugin, EmbossingRepresentationsPlugin, EnSightGoldCombinedReaderPlugin, ExplicitStructuredGridPlugin, FlipBookPluginPlugin, GenericIOReaderPlugin, GeodesicMeasurementPlugin, GMVReaderPlugin, HyperTreeGridADRPlugin, LagrangianParticleTrackerPlugin, LANLX3DReaderPlugin, LegacyExodusReaderPlugin, LegacyExodusWriterPlugin, LegacyGhostCellsGeneratorPlugin, MomentsPlugin, MooseXfemClipPlugin, NodeEditorPlugin, NonOrthogonalSourcePlugin, PanoramicProjectionViewPlugin, ParametricSurfacesPlugin, PrismPlugin, SaveStateAndScreenshotPlugin, SLACToolsPlugin, StereoCursorViewPlugin, StreamingParticlesPlugin, StreamLinesRepresentationPlugin, ThickenLayeredCellsPlugin, VTKmFiltersPlugin, and vtkPVPythonAlgorithmPlugin.

◆ GetRequiredOnServer()

virtual bool vtkPVPlugin::GetRequiredOnServer ( )

pure virtual

Returns true if this plugin is required on the server.

Implemented in AcceleratedAlgorithmsPlugin, AnalyzeNIfTIReaderWriterPlugin, ArrowGlyphPlugin, BagPlotViewsAndFiltersPlugin, BivariateRepresentationsPlugin, CFSReaderPlugin, ContourLabelPluginPlugin, DataminePlugin, DigitalRockPhysicsPlugin, DigitalSignalProcessingPlugin, EmbossingRepresentationsPlugin, EnSightGoldCombinedReaderPlugin, ExplicitStructuredGridPlugin, FlipBookPluginPlugin, GenericIOReaderPlugin, GeodesicMeasurementPlugin, GMVReaderPlugin, HyperTreeGridADRPlugin, LagrangianParticleTrackerPlugin, LANLX3DReaderPlugin, LegacyExodusReaderPlugin, LegacyExodusWriterPlugin, LegacyGhostCellsGeneratorPlugin, MomentsPlugin, MooseXfemClipPlugin, NodeEditorPlugin, NonOrthogonalSourcePlugin, PanoramicProjectionViewPlugin, ParametricSurfacesPlugin, PrismPlugin, SaveStateAndScreenshotPlugin, SLACToolsPlugin, StereoCursorViewPlugin, StreamingParticlesPlugin, StreamLinesRepresentationPlugin, ThickenLayeredCellsPlugin, VTKmFiltersPlugin, and vtkPVPythonAlgorithmPlugin.

◆ GetRequiredOnClient()

virtual bool vtkPVPlugin::GetRequiredOnClient ( )

pure virtual

Returns true if this plugin is required on the client.

Implemented in AcceleratedAlgorithmsPlugin, AnalyzeNIfTIReaderWriterPlugin, ArrowGlyphPlugin, BagPlotViewsAndFiltersPlugin, BivariateRepresentationsPlugin, CFSReaderPlugin, ContourLabelPluginPlugin, DataminePlugin, DigitalRockPhysicsPlugin, DigitalSignalProcessingPlugin, EmbossingRepresentationsPlugin, EnSightGoldCombinedReaderPlugin, ExplicitStructuredGridPlugin, FlipBookPluginPlugin, GenericIOReaderPlugin, GeodesicMeasurementPlugin, GMVReaderPlugin, HyperTreeGridADRPlugin, LagrangianParticleTrackerPlugin, LANLX3DReaderPlugin, LegacyExodusReaderPlugin, LegacyExodusWriterPlugin, LegacyGhostCellsGeneratorPlugin, MomentsPlugin, MooseXfemClipPlugin, NodeEditorPlugin, NonOrthogonalSourcePlugin, PanoramicProjectionViewPlugin, ParametricSurfacesPlugin, PrismPlugin, SaveStateAndScreenshotPlugin, SLACToolsPlugin, StereoCursorViewPlugin, StreamingParticlesPlugin, StreamLinesRepresentationPlugin, ThickenLayeredCellsPlugin, VTKmFiltersPlugin, and vtkPVPythonAlgorithmPlugin.

◆ GetRequiredPlugins()

virtual const char* vtkPVPlugin::GetRequiredPlugins ( )

pure virtual

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

Implemented in AcceleratedAlgorithmsPlugin, AnalyzeNIfTIReaderWriterPlugin, ArrowGlyphPlugin, BagPlotViewsAndFiltersPlugin, BivariateRepresentationsPlugin, CFSReaderPlugin, ContourLabelPluginPlugin, DataminePlugin, DigitalRockPhysicsPlugin, DigitalSignalProcessingPlugin, EmbossingRepresentationsPlugin, EnSightGoldCombinedReaderPlugin, ExplicitStructuredGridPlugin, FlipBookPluginPlugin, GenericIOReaderPlugin, GeodesicMeasurementPlugin, GMVReaderPlugin, HyperTreeGridADRPlugin, LagrangianParticleTrackerPlugin, LANLX3DReaderPlugin, LegacyExodusReaderPlugin, LegacyExodusWriterPlugin, LegacyGhostCellsGeneratorPlugin, MomentsPlugin, MooseXfemClipPlugin, NodeEditorPlugin, NonOrthogonalSourcePlugin, PanoramicProjectionViewPlugin, ParametricSurfacesPlugin, PrismPlugin, SaveStateAndScreenshotPlugin, SLACToolsPlugin, StereoCursorViewPlugin, StreamingParticlesPlugin, StreamLinesRepresentationPlugin, ThickenLayeredCellsPlugin, VTKmFiltersPlugin, and vtkPVPythonAlgorithmPlugin.

◆ GetDescription()

virtual const char* vtkPVPlugin::GetDescription ( )

pure virtual

Returns a description of this plugin.

Implemented in AcceleratedAlgorithmsPlugin, AnalyzeNIfTIReaderWriterPlugin, ArrowGlyphPlugin, BagPlotViewsAndFiltersPlugin, BivariateRepresentationsPlugin, CFSReaderPlugin, ContourLabelPluginPlugin, DataminePlugin, DigitalRockPhysicsPlugin, DigitalSignalProcessingPlugin, EmbossingRepresentationsPlugin, EnSightGoldCombinedReaderPlugin, ExplicitStructuredGridPlugin, FlipBookPluginPlugin, GenericIOReaderPlugin, GeodesicMeasurementPlugin, GMVReaderPlugin, HyperTreeGridADRPlugin, LagrangianParticleTrackerPlugin, LANLX3DReaderPlugin, LegacyExodusReaderPlugin, LegacyExodusWriterPlugin, LegacyGhostCellsGeneratorPlugin, MomentsPlugin, MooseXfemClipPlugin, NodeEditorPlugin, NonOrthogonalSourcePlugin, PanoramicProjectionViewPlugin, ParametricSurfacesPlugin, PrismPlugin, SaveStateAndScreenshotPlugin, SLACToolsPlugin, StereoCursorViewPlugin, StreamingParticlesPlugin, StreamLinesRepresentationPlugin, ThickenLayeredCellsPlugin, VTKmFiltersPlugin, and vtkPVPythonAlgorithmPlugin.

◆ GetEULA()

virtual const char* vtkPVPlugin::GetEULA ( )

pure virtual

Returns EULA for the plugin, if any.

If none, this will return nullptr.

Implemented in AcceleratedAlgorithmsPlugin, AnalyzeNIfTIReaderWriterPlugin, ArrowGlyphPlugin, BagPlotViewsAndFiltersPlugin, BivariateRepresentationsPlugin, CFSReaderPlugin, ContourLabelPluginPlugin, DataminePlugin, DigitalRockPhysicsPlugin, DigitalSignalProcessingPlugin, EmbossingRepresentationsPlugin, EnSightGoldCombinedReaderPlugin, ExplicitStructuredGridPlugin, FlipBookPluginPlugin, GenericIOReaderPlugin, GeodesicMeasurementPlugin, GMVReaderPlugin, HyperTreeGridADRPlugin, LagrangianParticleTrackerPlugin, LANLX3DReaderPlugin, LegacyExodusReaderPlugin, LegacyExodusWriterPlugin, LegacyGhostCellsGeneratorPlugin, MomentsPlugin, MooseXfemClipPlugin, NodeEditorPlugin, NonOrthogonalSourcePlugin, PanoramicProjectionViewPlugin, ParametricSurfacesPlugin, PrismPlugin, SaveStateAndScreenshotPlugin, SLACToolsPlugin, StereoCursorViewPlugin, StreamingParticlesPlugin, StreamLinesRepresentationPlugin, ThickenLayeredCellsPlugin, VTKmFiltersPlugin, and vtkPVPythonAlgorithmPlugin.

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

Reimplemented in AcceleratedAlgorithmsPlugin, AnalyzeNIfTIReaderWriterPlugin, ArrowGlyphPlugin, BagPlotViewsAndFiltersPlugin, BivariateRepresentationsPlugin, CFSReaderPlugin, ContourLabelPluginPlugin, DataminePlugin, DigitalRockPhysicsPlugin, DigitalSignalProcessingPlugin, EmbossingRepresentationsPlugin, EnSightGoldCombinedReaderPlugin, ExplicitStructuredGridPlugin, FlipBookPluginPlugin, GenericIOReaderPlugin, GeodesicMeasurementPlugin, GMVReaderPlugin, HyperTreeGridADRPlugin, LagrangianParticleTrackerPlugin, LANLX3DReaderPlugin, LegacyExodusReaderPlugin, LegacyExodusWriterPlugin, LegacyGhostCellsGeneratorPlugin, MomentsPlugin, MooseXfemClipPlugin, NodeEditorPlugin, NonOrthogonalSourcePlugin, PanoramicProjectionViewPlugin, ParametricSurfacesPlugin, PrismPlugin, SaveStateAndScreenshotPlugin, SLACToolsPlugin, StereoCursorViewPlugin, StreamingParticlesPlugin, StreamLinesRepresentationPlugin, ThickenLayeredCellsPlugin, and VTKmFiltersPlugin.

◆ ImportPlugin()

static bool 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.

Note, if the plugin has EULA and the user declines the EULA, the import request will be ignored, and the plugin won't be imported. This does not mean, however, that the plugin won't have any side effects as the plugin library can have singletons that get initialized on library load.

Returns: true if the plugin was successfully imported.

◆ SetEULAConfirmationCallback()

static void vtkPVPlugin::SetEULAConfirmationCallback ( EULAConfirmationCallback callback )

static

Get/Set the static callback to call to confirm EULA.

◆ GetEULAConfirmationCallback()

static EULAConfirmationCallback vtkPVPlugin::GetEULAConfirmationCallback ( )

static

Type for EULAConfirmationCallback.

◆ SetFileName()

void vtkPVPlugin::SetFileName ( const char * filename )

protected

Set the filename the plugin is loaded from, if any.

If it's nullptr, then its assumed that the plugin is "linked-in" i.e. not loaded from an external file.

Friends And Related Function Documentation

◆ vtkPVPluginLoader

friend class vtkPVPluginLoader

friend

Definition at line 137 of file vtkPVPlugin.h.

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

/builds/gitlab-kitware-sciviz-ci/Remoting/Core/vtkPVPlugin.h

Public Member Functions

Protected Member Functions

Friends

Detailed Description

Member Typedef Documentation

◆ EULAConfirmationCallback

Constructor & Destructor Documentation

◆ vtkPVPlugin()

◆ ~vtkPVPlugin()

Member Function Documentation

◆ GetFileName()

◆ GetPluginName()

◆ GetPluginVersionString()

◆ GetRequiredOnServer()

◆ GetRequiredOnClient()

◆ GetRequiredPlugins()

◆ GetDescription()

◆ GetEULA()

◆ GetBinaryResources()

◆ ImportPlugin()

◆ SetEULAConfirmationCallback()

◆ GetEULAConfirmationCallback()

◆ SetFileName()

Friends And Related Function Documentation

◆ vtkPVPluginLoader