PLUG Namespace Reference

Plugin interface namespace containing common plugin contracts and helper types. More...

Classes
class	Error
	Represents an error with a code and a message. The message is intended for display to the user. More...
interface	IBase
	The IBase interface provides a base class for all plugin interfaces in iVS3D. It inherits from QObject to enable signal-slot communication and common functionality across all plugins. All plugin signals need to be declared in this interface to ensure they are available in derived plugin classes. More...
interface	IMask
	Interface for mask generation plugins in iVS3D. More...
struct	InputData
	Struct to encapsulate data related to the input loaded event in iVS3D. More...
struct	InputMetaData
	Struct containing metadata context that has been loaded for the currently opened input. More...
interface	IPreview
	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...
class	ISelection
	Interface for keyframe/image-selection plugins in iVS3D. More...
struct	MaskData
	Struct containing data required to generate a binary mask. The image is resized to the working resolution and cropped to the region of interest before being passed to the plugin. More...
struct	PreviewData
	Struct containing data required to generate a preview. The image is resized to the working resolution and cropped to the region of interest before being passed to the plugin. More...
struct	SelectionData
	Data available for image selection in ISelection plugins. More...

Typedefs
using	SettingsWidgetResult = tl::expected< std::unique_ptr< QWidget >, Error >
	Type alias for the result of a settings widget creation operation, which can be either a successful unique_ptr to a QWidget or an Error indicating failure.
using	ApplySettingsResult = tl::expected< void, Error >
	Type alias for the result of applying settings to a plugin, which can be either a successful void result or an Error indicating failure.
using	InputLoadedResult = tl::expected< void, Error >
	Type alias for the result of handling an input loaded event, which can be either a successful void result or an Error indicating failure.
using	MetaDataLoadedResult = tl::expected< void, Error >
	Type alias for the result of handling a metadata-loaded event, either success (void) or an Error.

Detailed Description

Plugin interface namespace containing common plugin contracts and helper types.

For a full overview of the plugin API, see PluginInterface.md.