ParaView/Users Guide/Plugins: Difference between revisions

From KitwarePublic
Jump to navigationJump to search
(restructure so main wiki can link to it)
(Replaced content with "{{ParaView/Template/DeprecatedUsersGuide}}")
 
Line 1: Line 1:
== Introduction ==
{{ParaView/Template/DeprecatedUsersGuide}}
 
ParaView comes with plethora of functionality bundled in: several readers, multitude of filters, quite a few different types of views etc. However, it is not uncommon for developers to add new functionality to ParaView. For example to add support for their new file format, incorporate a new filter, etc. ParaView makes it possible to add new functionlity by using an extensive plugin mechanism.
 
Plugins can be used to extend ParaView in several ways:
* Add new readers
* Add new writers
* Add new filters
* Add new GUI components
* Add new views
* Add new representations
 
=== Plugin Types ===
 
Plugins are distributed as shared libraries (*.so on Unix, *.dylib on Mac, *.dll on Windows etc). For a plugin to be loadable in ParaView, it must be built with the same version of ParaView as it is expected to be deployed on. Plugins can be classified into two broad categories:
* Server-side plugins
: These are plugins that extend the algorithmic capabilities for ParaView eg. new filters, readers, writers etc. Since in ParaView data is processed on the server-side, these plugins need to be loaded on the server.
* Client-side plugins
: These are plugins that extend the ParaView GUI eg. property panels for new filters, toolbars, views etc. These plugins need to be loaded on the client.
 
Oftentimes a plugin has both server-side as well as client-side components to it eg. a plugin that adds a new filter and a property panel that goes with that filter. Such plugins need to be loaded both on the server as well as the client.
 
Generally, users don't have to worry whether a plugin is a server-side or client-side plugin. Simply load the plugin on the server as well as the client. ParaView will include relevant components from plugin on each of the processes.

Latest revision as of 21:30, 14 January 2015

PAGE DELETED
The Paraview's User Guide and Reference Manual have been moved from the Wiki to The ParaView Guide. Please use the history if you want to access the old version of this document.