Go to the source code of this file.
| 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_check_destdir | ( | variable | ) |
Definition at line 231 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.PLUGINS_COMPONENT: (Defaults to paraview_plugins) The installation component to use for installed plugins.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.INSTALL_EXPORT: If provided, the generated target will be added to the named export set.CMAKE_DESTINATION: If provided, the plugin target's properties will be written to a file named <TARGET>-paraview-plugin-properties.cmake in the specified destination.TARGET_COMPONENT: (Defaults to development) The component to use for <TARGET>.INSTALL_HEADERS: (Defaults to ON) Whether to install headers or not.HEADERS_DESTINATION: (Defaults to ${CMAKE_INSTALL_INCLUDEDIR}) Where to install include files.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.ADD_INSTALL_RPATHS: (Defaults to OFF) If specified, an RPATH to load dependent libraries from the LIBRARY_DESTINATION from the plugins will be added.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 300 of file ParaViewPlugin.cmake.
| function paraview_plugin_write_conf | ( | ) |
.md
Applications will want to consume plugin targets by discovering their locations at runtime. In order to facilitate this, ParaView supports loading a conf file which contains the locations of plugin targets' XML files. The plugins specified in that file is then
NAME: (Required) The base name of the configuration file.PLUGINS_TARGETS: (Required) The list of plugin targets to add to the configuration file.BUILD_DESTINATION: (Required) Where to place the configuration file in the build tree.INSTALL_DESTINATION: Where to install the configuration file in the install tree. If not provided, the configuration file will not be installed.COMPONENT: (Defaults to runtime) The component to use when installing the configuration file. Definition at line 689 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, in the given order. See the plugin interfaces section for more details.MODULE_INSTALL_EXPORT: (Defaults to <name>) If provided, any modules will be added to the given export set.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: (Deprecated) Use paraview_plugin_build(INSTALL_EXPORT) instead.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 869 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 1391 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 1477 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 1555 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 1623 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 1686 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 1755 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 1828 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 1904 of file ParaViewPlugin.cmake.
1.8.13 on Wed Aug 5 2020