ManiVault 1.0.0
A Flexible and Extensible Visual Analytics Framework for High-Dimensional Data
Loading...
Searching...
No Matches
hdps::plugin::ViewPluginFactory Class Referenceabstract

#include <ViewPlugin.h>

Inheritance diagram for hdps::plugin::ViewPluginFactory:
hdps::plugin::PluginFactory ActionsPluginFactory DataHierarchyPluginFactory DataPropertiesPluginFactory LoggingPluginFactory

Public Member Functions

 ViewPluginFactory (bool producesSystemViewPlugins=false)
 
 ~ViewPluginFactory ()=default
 
QIcon getIcon (const QColor &color=Qt::black) const override
 
ViewPluginproduce () override=0
 
bool producesSystemViewPlugins () const
 
gui::DockAreaFlag getPreferredDockArea () const
 
- Public Member Functions inherited from hdps::plugin::PluginFactory
 PluginFactory (Type type)
 
QString getKind () const
 
void setKind (const QString &kind)
 
Type getType () const
 
virtual void initialize ()
 
virtual bool hasHelp ()
 
virtual gui::TriggerActiongetTriggerHelpAction () final
 
QString getGuiName () const
 
void setGuiName (const QString &guiName)
 
QString getVersion () const
 
void setVersion (const QString &version)
 
virtual bool mayProduce () const final
 
virtual hdps::DataTypes supportedDataTypes () const
 
virtual gui::PluginTriggerActiongetPluginTriggerAction ()
 
virtual gui::PluginTriggerActions getPluginTriggerActions (const Datasets &datasets) const
 
virtual gui::PluginTriggerActions getPluginTriggerActions (const DataTypes &dataTypes) const
 
std::uint32_t getNumberOfInstances () const
 
void setNumberOfInstances (std::uint32_t numberOfInstances)
 
std::uint32_t getMaximumNumberOfInstances () const
 
void setMaximumNumberOfInstances (std::uint32_t maximumNumberOfInstances)
 

Protected Member Functions

void setPreferredDockArea (const gui::DockAreaFlag &preferredDockArea)
 

Additional Inherited Members

- Static Protected Member Functions inherited from hdps::plugin::PluginFactory
static QStringList getDatasetTypesAsStringList (const Datasets &datasets)
 
static bool areAllDatasetsOfTheSameType (const Datasets &datasets, const DataType &dataType)
 
static std::uint16_t getNumberOfDatasetsForType (const Datasets &datasets, const DataType &dataType)
 

Constructor & Destructor Documentation

◆ ViewPluginFactory()

hdps::plugin::ViewPluginFactory::ViewPluginFactory ( bool  producesSystemViewPlugins = false)

Constructor

Parameters
producesSystemViewPluginsWhether this factory generates system view plugins or not

◆ ~ViewPluginFactory()

hdps::plugin::ViewPluginFactory::~ViewPluginFactory ( )
default

Destructor

Member Function Documentation

◆ getIcon()

QIcon hdps::plugin::ViewPluginFactory::getIcon ( const QColor &  color = Qt::black) const
overridevirtual

Get plugin icon

Parameters
colorIcon color for flat (font) icons
Returns
Icon

Reimplemented from hdps::plugin::PluginFactory.

◆ getPreferredDockArea()

DockAreaFlag hdps::plugin::ViewPluginFactory::getPreferredDockArea ( ) const

Get preferred dock area

Returns
Preferred initial dock area when the view plugin is added to the workspace

◆ produce()

ViewPlugin * hdps::plugin::ViewPluginFactory::produce ( )
overridepure virtual

Produces the plugin

Returns
Pointer to the produced plugin

Implements hdps::plugin::PluginFactory.

Implemented in DataHierarchyPluginFactory, DataPropertiesPluginFactory, LoggingPluginFactory, and ActionsPluginFactory.

◆ producesSystemViewPlugins()

bool hdps::plugin::ViewPluginFactory::producesSystemViewPlugins ( ) const

Get whether this factory produces system view plugins or not

Returns
Boolean determining whether this factory produces system view plugins or not

◆ setPreferredDockArea()

void hdps::plugin::ViewPluginFactory::setPreferredDockArea ( const gui::DockAreaFlag preferredDockArea)
protected

Set preferred dock area

Parameters
preferredDockAreaPreferred initial dock area when the view plugin is added to the workspace

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