PLUG::IPreview Interface Reference

The IPreview interface defines the contract for preview plugins in iVS3D. Plugins implementing this interface are responsible for generating visualizations for given preview data, which typically includes an image and its index in a sequence. The generated visualization can include various overlays and styles to enhance the preview experience. More...

#include <ipreview.h>

Inheritance diagram for PLUG::IPreview:

Public Member Functions
virtual VIS::VisualizationResult	generatePreview (const PreviewData &data)=0
	Generates a preview visualization based on the provided data. This function is executed asynchronously by iVS3D, such that expensive operations such as neural network inference do not block the main thread and GUI. Plugins should ensure that communication with the settings widget is thread-safe, e.g. by using signals and slots!

Detailed Description

The IPreview interface defines the contract for preview plugins in iVS3D. Plugins implementing this interface are responsible for generating visualizations for given preview data, which typically includes an image and its index in a sequence. The generated visualization can include various overlays and styles to enhance the preview experience.

Plugins must implement the generatePreview method to create a Visualization object based on the provided PreviewData. They may use the updatePreview signal inherited from IBase to notify the system when a new preview should be generated.

See also

PluginInterface.md

Author

Dominik Wüst

Date

2025/12/05

Member Function Documentation

generatePreview()

virtual VIS::VisualizationResult PLUG::IPreview::generatePreview ( const PreviewData &  data )

pure virtual

Generates a preview visualization based on the provided data. This function is executed asynchronously by iVS3D, such that expensive operations such as neural network inference do not block the main thread and GUI. Plugins should ensure that communication with the settings widget is thread-safe, e.g. by using signals and slots!

Parameters

data	The PreviewData containing the image and its index.

Returns

A VisualizationResult containing either the generated Visualization or an Error if the preview generation failed.

Implemented in Blur, and SegmentationPlugin.

---

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

• iVS3D/src/iVS3D-pluginInterface/ipreview.h