Go to the source code of this file.
Functions | |
function | paraview_plugin_find_plugins (output) |
.md ParaView Plugin CMake APIMore... | |
macro | _paraview_plugin_parse_args (name_output) |
.md Plugin filesMore... | |
function | paraview_plugin_scan () |
.md Scanning pluginsMore... | |
function | paraview_plugin_build () |
.md Building pluginsMore... | |
function | paraview_add_plugin (name) |
.md Adding a pluginMore... | |
function | paraview_plugin_add_property_widget () |
.md Plugin interfacesMore... | |
function | paraview_plugin_add_dock_window () |
.md Dock windowMore... | |
function | paraview_plugin_add_action_group () |
.md Action groupMore... | |
function | paraview_plugin_add_toolbar () |
.md ToolbarMore... | |
function | paraview_plugin_add_view_frame_action_group () |
.md View frame action groupMore... | |
function | paraview_plugin_add_auto_start () |
.md Auto startMore... | |
function | paraview_plugin_add_tree_layout_strategy () |
.md Tree layout strategyMore... | |
function | paraview_plugin_add_proxy () |
.md ProxyMore... | |
function paraview_plugin_find_plugins | ( | output | ) |
.md
.md
Similar to VTK modules, plugins first have to be discovered. The paraview_plugin_find_plugins
function does this. The output variable is the list of discovered paraview.plugin
files.
Definition at line 21 of file ParaViewPlugin.cmake.
macro _paraview_plugin_parse_args | ( | name_output | ) |
.md
The paraview.plugin
file is parsed and used as arguments to a CMake function.
Example:
The supported arguments are:
NAME
: (Required) The name of the plugin.DESCRIPTION
: (Recommended) Short text describing what the plugin does.CONDITION
: Arguments to CMake's if
command which may be used to hide the plugin for certain platforms or other reasons. If the expression is false, the module is completely ignored.REQUIRES_MODULES
: If the plugin is enabled, these modules will be listed as those required to build the enabled plugins. Definition at line 60 of file ParaViewPlugin.cmake.
function paraview_plugin_scan | ( | ) |
.md
Once the paraview.plugin
files have been found, they need to be scanned to determine which should be built. Generally, plugins should be scanned first in order to use the REQUIRES_MODULES
list to enable them during the scan for their required modules.
PLUGIN_FILES
: (Required) The list of plugin files to scan.PROVIDES_PLUGINS
: (Required) This variable contains a list of the plugins to be built.ENABLE_BY_DEFAULT
: (Defaults to OFF
) Whether to enable plugins by default or not.HIDE_PLUGINS_FROM_CACHE
: (Defaults to OFF
) Whether to display options to enable and disable plugins in the cache or not.REQUIRES_MODULES
: The list of modules required by the enabled plugins. Definition at line 118 of file ParaViewPlugin.cmake.
function paraview_plugin_build | ( | ) |
.md
Once all plugins have been scanned, they need to be built.
PLUGINS
: (Required) The list of plugins to build. May be empty.AUTOLOAD
: A list of plugins to mark for autoloading.TARGET
: (Recommended) The name of an interface target to generate. This provides. an initialization function <TARGET>_initialize
which initializes static plugins. The function is provided, but is a no-op for shared plugin builds.RUNTIME_DESTINATION
: (Defaults to ${CMAKE_INSTALL_BINDIR}
) Where to install runtime files.LIBRARY_DESTINATION
: (Defaults to ${CMAKE_INSTALL_LIBDIR}
) Where to install modules built by plugins.LIBRARY_SUBDIRECTORY
: (Defaults to ""
) Where to install the plugins themselves. Each plugin lives in a directory of its name in <RUNTIME_DESTINATION>/<LIBRARY_SUBDIRECTORY>
(for Windows) or <LIBRARY_DESTINATION>/<LIBRARY_SUBDIRECTORY>
for other platforms.PLUGINS_FILE_NAME
: The name of the XML plugin file to generate for the built plugins. This file will be placed under <LIBRARY_DESTINATION>/<LIBRARY_SUBDIRECTORY>
. It will be installed with the plugin
component. Definition at line 274 of file ParaViewPlugin.cmake.
.md
TODO: Describe.
REQUIRED_ON_SERVER
: The plugin is required to be loaded on the server for proper functionality.REQUIRED_ON_CLIENT
: The plugin is required to be loaded on the client for proper functionality.VERSION
: (Required) The version number of the plugin.MODULE_FILES
: Paths to vtk.module
files describing modules to include in the plugin.MODULE_ARGS
: Arguments to pass to vtk_module_build
for included modules.MODULES
: Modules to include in the plugin. These modules will be wrapped using client server and have their server manager XML files processed.SOURCES
: Source files for the plugin.SERVER_MANAGER_XML
: Server manager XML files for the plugin.UI_INTERFACES
: Interfaces to initialize. See the plugin interfaces section for more details.UI_RESOURCES
: Qt resource files to include with the plugin.UI_FILES
: Qt .ui
files to include with the plugin.PYTHON_MODULES
: Python modules to embed into the plugin.REQUIRED_PLUGINS
: Plugins which must be loaded for this plugin to function. These plugins do not need to be available at build time and are therefore their existence is not checked here.EULA
: A file with content to display as an end-user license agreement before the plugin is initialized at runtime.XML_DOCUMENTATION
: (Defaults to ON
) If set, documentation will be generated for the associated XML files.DOCUMENTATION_DIR
: If specified, *.html
, *.css
, *.png
, and *.jpg
files in this directory will be copied and made available to the documentation.EXPORT
: If provided, the plugin will be added to the given export set.FORCE_STATIC
: (Defaults to OFF
) If set, the plugin will be built statically so that it can be embedded into an application. Definition at line 518 of file ParaViewPlugin.cmake.
function paraview_plugin_add_property_widget | ( | ) |
.md
ParaView plugins may satisfy a number of interfaces. These functions all take a INTERFACES
argument which takes the name of a variable to set with the name of the interface generated. This variable's should be passed to paraview_add_plugin
's UI_INTERFACES
argument. .md
TODO: What is a property widget?
KIND
: The kind of widget represented.TYPE
: The name of the property type.CLASS_NAME
: The name of the property widget class.INTERFACES
: The name of the generated interface.SOURCES
: The source files generated by the interface. Definition at line 1001 of file ParaViewPlugin.cmake.
function paraview_plugin_add_dock_window | ( | ) |
.md
TODO: What is a dock window?
CLASS_NAME
: The name of the dock window class.DOCK_AREA
: (Default Left
) Where to dock the window within the application.INTERFACES
: The name of the generated interface.SOURCES
: The source files generated by the interface. Definition at line 1087 of file ParaViewPlugin.cmake.
function paraview_plugin_add_action_group | ( | ) |
.md
TODO: What is an action group?
CLASS_NAME
: The name of the action group class.GROUP_NAME
: The name of the action group.INTERFACES
: The name of the generated interface.SOURCES
: The source files generated by the interface. Definition at line 1165 of file ParaViewPlugin.cmake.
function paraview_plugin_add_toolbar | ( | ) |
.md
TODO: What is a toolbar?
CLASS_NAME
: The name of the toolbar class.INTERFACES
: The name of the generated interface.SOURCES
: The source files generated by the interface. Definition at line 1233 of file ParaViewPlugin.cmake.
function paraview_plugin_add_view_frame_action_group | ( | ) |
.md
TODO: What is a view frame action group?
CLASS_NAME
: The name of the view frame action group class.INTERFACES
: The name of the generated interface.SOURCES
: The source files generated by the interface. Definition at line 1296 of file ParaViewPlugin.cmake.
function paraview_plugin_add_auto_start | ( | ) |
.md
TODO: What is an auto start?
CLASS_NAME
: The name of the auto start class.STARTUP
: (Defaults to startup
) The name of the method to call on startup.SHUTDOWN
: (Defaults to shutdown
) The name of the method to call on shutdown.INTERFACES
: The name of the generated interface.SOURCES
: The source files generated by the interface. Definition at line 1365 of file ParaViewPlugin.cmake.
function paraview_plugin_add_tree_layout_strategy | ( | ) |
.md
TODO: What is a tree layout strategy?
STRATEGY_TYPE
: The name of the tree layout strategy class.STRATEGY_LABEL
: The label to use for the strategy.INTERFACES
: The name of the generated interface.SOURCES
: The source files generated by the interface. Definition at line 1438 of file ParaViewPlugin.cmake.
function paraview_plugin_add_proxy | ( | ) |
.md
TODO: What is a proxy?
NAME
: The name of the proxy.INTERFACES
: The name of the generated interface.SOURCES
: The source files generated by the interface.At least one PROXY_TYPE
must be specified. Each proxy type must be given an XML_GROUP
and either an XML_NAME
or XML_NAME_REGEX
. If CLASS_NAME
is not given, the PROXY_TYPE
name is used instead.
Definition at line 1514 of file ParaViewPlugin.cmake.