Documentation‎ > ‎User Manual‎ > ‎

Plugins and the Plugin Wizard

ParaViewGeo comes with numerous plugins to extend the capabilities of the application. You can also add your own plugins to add new functionality.

These are the plugins available with the standard build. Please note that this list will change periodically as plugins are added.

  • Windows Readers SM Plugin
  • Windows Readers GUI Plugin
  • Windows Readers C Plugin
  • Stable Writers SM Plugin
  • Stable Writers C Plugin
  • Stable Readers SM Plugin
  • Stable Readers GUI Plugin
  • Stable Readers C Plugin
  • Stable Filters SM Plugin
  • Stable Filter GUI Plugin
  • Stable Filter C Plugin


The Plugin Manager

Plugins are compiled programs that add readers, writers, filters, adding custom GUI components such as toolbar buttons, etc. to ParaViewGeo. There are two types of plugins; server-side and client-side. Server-side plugins extend algorithmic capabilities, such as new filters, readers and writers. Client-side plugins extend the user interface, such as property panels for new filters, and toolbars. Some plugins have both server-side and a client-side components.

The Plugin Manager is used to manage the plugins available to ParaViewGeo. You can open the Plugin Manager by choosing Tools > Manage Plugins/Extensions and see which plugins are loaded by default. The Plugin Manager displays the plugins that are currently loaded on the server-side (remote) and on the client-side (local). The remote side displays only when you are connected to a server.

You can add plugins to the ParaViewGeo by clicking the Load button and selecting the plugin to load. The supported file types are: *.so, *.dylib, *.dll, and *.sl. The default locations where ParaViewGeo automatically searches for plugins are listed at the top of the Plugin Manager window. If a plugin is successfully loaded, it will appear in the list.

However, plugins loaded via the Plugin Manager are available only during the current session. You will need to use an environment variable or place the plugin in a recognized location for it to be auto-loaded. If you want to load it only for sessions where you need that plugin, the Plugin Manager has a Recent drop-down for both the Remote and Local sides that will allow you to re-load a plugin without having to browse to it again.

Additional information on writing your own plugins can be found on the ParaView Plugin How To website: http://www.paraview.org/Wiki/Plugin_HowTo


MIRARCO's Plugin Wizard

MIRARCO has created a Plugin Wizard that can help you if you have trouble creating all the required files for your plugin. The wizard will create the necessary CMake code and C++/XML boilerplate for a simple Filter, Reader, Source or Writer plugin.

You can download the Plugin Wizard here: http://pluginwizard.mirarco.org/




Next Section Previous Section Return To
The Menu Bar Custom Filters User Manual

Comments