iVS3D v2.0.9
Loading...
Searching...
No Matches
Public Member Functions | List of all members
VisualSimilarity Class Reference
Inheritance diagram for VisualSimilarity:
PLUG::IBase PLUG::ISelection

Public Member Functions

PLUG::SettingsWidgetResult getSettingsWidget () override
 getSettingsWidget creates and returns a settings QWidget for this plugin.
 
QString getName () const override
 getName returns the name of the plugin which will be displayed in the iVS3D interface.
 
QMap< QString, QVariant > getSettings () const override
 getSettings retrieves the current settings of the plugin as a map of key-value pairs. The settings are stored in the history within iVS3D and in combination with applySettings allow for saving and restoring plugin configurations.
 
PLUG::ApplySettingsResult applySettings (const QMap< QString, QVariant > &settings) override
 applySettings applies the provided settings to the plugin. This method is used to restore plugin configurations from the history within iVS3D.
 
PLUG::InputLoadedResult onInputLoaded (const PLUG::InputData &input) override
 onInputLoaded is called when a new input video or image set is loaded.
 
void onCudaChanged (bool enabled) override
 onCudaChanged is called when the CUDA usage setting is changed in iVS3D.
 
PLUG::SelectionResult selectImages (const PLUG::SelectionData &data, volatile bool &cancelFlag) override
 Selects images based on the provided selection data.
 
- Public Member Functions inherited from PLUG::IBase
virtual QString getSettingsString () const
 getSettingsString is a helper method that converts the plugin settings into a human-readable string format.
 
virtual void activate ()
 activate is called when the plugin is activated in iVS3D. Plugins can override this method to perform any necessary setup when they become active.
 
virtual void deactivate ()
 deactivate is called when the plugin is deactivated in iVS3D. Plugins can override this method to perform any necessary cleanup when they are no longer active.
 
virtual MetaDataLoadedResult onMetaDataLoaded (const InputMetaData &inputMetaData)
 onMetaDataLoaded is called whenever metadata was loaded or refreshed for the currently active input.
 
virtual void onIndexChanged (uint index)
 onIndexChanged is called when the currently displayed frame index changes in the viewer.
 
virtual void onSelectedImagesChanged (const std::vector< uint > &selectedImages)
 onSelectedImagesChanged is called when the current keyframe / selected-image list changed.
 

Additional Inherited Members

- Signals inherited from PLUG::IBase
void updatePreview (bool clearOldPreview=true)
 [signal] updatePreview(bool clearOldPreview) can be emitted when the plugin requests an update of the preview visualization.
 
void updateSelectedImages (std::vector< uint > selectedImages)
 [signal] updateSelectedImages(std::vector<uint> selectedImages) can be emitted when the plugin wants to update the selection of images in the video player. iVS3D will only handle this signal if the plugin is currently active.
 
void updateProgress (int progress, QString message=QString())
 [signal] updateProgress(int progress, QString message) can be emitted to inform iVS3D about the progress of a long-running operation.
 

Member Function Documentation

◆ applySettings()

ApplySettingsResult VisualSimilarity::applySettings ( const QMap< QString, QVariant > &  settings)
overridevirtual

applySettings applies the provided settings to the plugin. This method is used to restore plugin configurations from the history within iVS3D.

See also
getSettings
Parameters
settingsA QMap containing the plugin settings as key-value pairs.

Implements PLUG::IBase.

◆ getName()

QString VisualSimilarity::getName ( ) const
overridevirtual

getName returns the name of the plugin which will be displayed in the iVS3D interface.

Returns
The name of the plugin as a QString.

Implements PLUG::IBase.

◆ getSettings()

QMap< QString, QVariant > VisualSimilarity::getSettings ( ) const
overridevirtual

getSettings retrieves the current settings of the plugin as a map of key-value pairs. The settings are stored in the history within iVS3D and in combination with applySettings allow for saving and restoring plugin configurations.

See also
applySettings
Returns
A QMap containing the plugin settings as key-value pairs.

Implements PLUG::IBase.

◆ getSettingsWidget()

SettingsWidgetResult VisualSimilarity::getSettingsWidget ( )
overridevirtual

getSettingsWidget creates and returns a settings QWidget for this plugin.

Ownership contract:

  • The plugin must allocate and return a std::unique_ptr<QWidget>.
  • Returning the unique_ptr transfers ownership to the caller.
  • The plugin must NOT keep ownership of, or store a pointer to, the returned widget.
  • The caller (core application) owns the widget and may assign a QObject/QWidget parent.

Threading contract:

  • The widget is part of the UI and must only be accessed from the UI thread.
  • Plugins may run in worker threads and therefore must not directly access the widget after handing it over.

If a plugin needs to reflect state changes in the UI later (e.g. from applySettings), it must do so via Qt signals/slots connected during widget creation.

Returns
A unique_ptr to the created settings QWidget or an Error if the widget could not be created.

Implements PLUG::IBase.

◆ onCudaChanged()

void VisualSimilarity::onCudaChanged ( bool  enabled)
overridevirtual

onCudaChanged is called when the CUDA usage setting is changed in iVS3D.

Parameters
enabledIndicates whether CUDA is enabled (true) or disabled (false).

Plugins can override this method to adjust their behavior based on the CUDA setting.

Implements PLUG::IBase.

◆ onInputLoaded()

InputLoadedResult VisualSimilarity::onInputLoaded ( const PLUG::InputData &  input)
overridevirtual

onInputLoaded is called when a new input video or image set is loaded.

Plugins can override this method to reset caches or initialize state that depends on the current input.

Implements PLUG::IBase.

◆ selectImages()

SelectionResult VisualSimilarity::selectImages ( const PLUG::SelectionData &  data,
volatile bool &  cancelFlag 
)
overridevirtual

Selects images based on the provided selection data.

This method should be implemented by the plugin to select images according to the specified criteria in SelectionData.

Parameters
dataThe SelectionData containing selected indices, working resolution, and ROI.
cancelFlagA volatile boolean flag that can be set to true to cancel the selection process.
Returns
A SelectionResult containing either the selected image indices or an Error if the selection failed.

Implements PLUG::ISelection.

The documentation for this class was generated from the following files: