ImageData Class Reference

#include <ImageData.h>

Inheritance diagram for ImageData:

Public Types
enum	Type { Undefined = -1 , Sequence , Stack , MultiPartSequence }
Public Types inherited from hdps::gui::WidgetAction
enum class	Scope { Private , Public }
enum class	HighlightOption { None , Moderate , Strong }
enum class	ConfigurationFlag {   VisibleInMenu = 0x00001 , InternalUseOnly = 0x00002 , NoLabelInGroup = 0x00004 , ForceCollapsedInGroup = 0x00008 ,   ForceExpandedInGroup = 0x00010 , User = 0x00100 , Default = 0 }
enum	ConnectionContextFlag { Api = 0x00008 , Gui = 0x00010 , ApiAndGui = Api | Gui }
	‍** Describes the connection context options *‍/ More...
enum class	ConnectionPermissionFlag {   None = 0x00000 , PublishViaApi = 0x00001 , PublishViaGui = 0x00002 , PublishViaApiAndGui = PublishViaApi | PublishViaGui ,   ConnectViaApi = 0x00008 , ConnectViaGui = 0x00010 , ConnectViaApiAndGui = ConnectViaApi | ConnectViaGui , DisconnectViaApi = 0x00040 ,   DisconnectViaGui = 0x00080 , DisconnectViaApiAndGui = DisconnectViaApi | DisconnectViaGui , ForceNone = 0x00100 , All = PublishViaApiAndGui | ConnectViaApiAndGui | DisconnectViaApiAndGui ,   Default = All }
Public Types inherited from hdps::util::Serializable
enum class	State { Idle , Reading , Writing }

Public Member Functions
	ImageData (const hdps::plugin::PluginFactory *factory)
void	init () override
Type	getType () const
void	setType (const Type &type)
std::uint32_t	getNumberOfImages () const
void	setNumberImages (const std::uint32_t &numberOfImages)
QSize	getImageSize () const
void	setImageSize (const QSize &imageSize)
QRect	getTargetRectangle () const
std::uint32_t	getNumberOfComponentsPerPixel () const
void	setNumberOfComponentsPerPixel (const std::uint32_t &numberOfComponentsPerPixel)
QStringList	getImageFilePaths () const
void	setImageFilePaths (const QStringList &imageFilePaths)
hdps::Dataset< hdps::DatasetImpl >	createDataSet (const QString &guid="") const override
Public Member Functions inherited from hdps::plugin::RawData
	RawData (const PluginFactory *factory, const DataType &dataType)
	~RawData () override
const DataType &	getDataType () const
Public Member Functions inherited from hdps::plugin::Plugin
	Plugin (const PluginFactory *factory)
virtual	~Plugin ()
virtual const PluginFactory *	getFactory () const final
QString	getName () const
QString	getGuiName () const
virtual QIcon	getIcon () const final
QString	getKind () const
Type	getType () const
virtual QString	getVersion () const
virtual bool	hasHelp ()
virtual gui::TriggerAction &	getTriggerHelpAction () final
QVariant	getProperty (const QString &name, const QVariant &defaultValue=QVariant()) const
void	setProperty (const QString &name, const QVariant &value)
bool	hasProperty (const QString &name) const
QStringList	propertyNames () const
QVariant	getSetting (const QString &path, const QVariant &defaultValue=QVariant()) const
void	setSetting (const QString &path, const QVariant &value)
void	fromVariantMap (const QVariantMap &variantMap) override
QVariantMap	toVariantMap () const override
virtual void	destroy () final
gui::StringAction &	getGuiNameAction ()
gui::TriggerAction &	getDestroyAction ()
Public Member Functions inherited from hdps::gui::WidgetAction
	WidgetAction (QObject *parent, const QString &title)
	~WidgetAction ()
virtual WidgetAction *	getParentAction () const final
virtual WidgetActions	getParentActions () const final
virtual WidgetActions	getChildren () const final
virtual bool	isRoot () const final
virtual bool	isLeaf () const final
virtual QWidget *	createWidget (QWidget *parent) override final
virtual QWidget *	createCollapsedWidget (QWidget *parent) const final
virtual QWidget *	createLabelWidget (QWidget *parent, const std::int32_t &widgetFlags=0x00001) const final
virtual QMenu *	getContextMenu (QWidget *parent=nullptr)
QWidget *	createWidget (QWidget *parent, const std::int32_t &widgetFlags)
virtual std::int32_t	getSortIndex () const final
virtual void	setSortIndex (const std::int32_t &sortIndex) final
virtual std::int32_t	getStretch () const final
virtual void	setStretch (const std::int32_t &stretch) final
virtual bool	getForceHidden () const final
virtual void	setForceHidden (bool forceHidden) final
virtual bool	isVisible () const final
virtual bool	getForceDisabled () const final
virtual void	setForceDisabled (bool forceDisabled) final
virtual bool	isEnabled () const final
void	setText (const QString &text)
virtual QString	getLocation () const
virtual std::int32_t	getDefaultWidgetFlags () const final
virtual void	setDefaultWidgetFlags (const std::int32_t &widgetFlags) final
virtual void	setDefaultWidgetFlag (const std::int32_t &widgetFlags, bool unset=false) final
virtual HighlightOption	getHighlighting () const final
virtual bool	isHighlighted () const final
virtual void	setHighlighting (const HighlightOption &highlighting) final
virtual void	setHighlighted (bool highlighted) final
virtual void	highlight () final
virtual void	unHighlight () final
virtual Scope	getScope () const final
virtual bool	isPrivate () const final
virtual bool	isPublic () const final
virtual bool	isPublished () const final
virtual bool	isConnected () const final
virtual bool	mayConnectToPublicAction (const WidgetAction *publicAction) const final
virtual bool	publish (const QString &name="", bool allowDuplicateName=false) final
virtual WidgetAction *	getPublicAction () final
virtual WidgetAction *	getPublicCopy () const final
virtual const WidgetActions	getConnectedActions () const final
virtual WidgetActions &	getConnectedActions () final
virtual bool	mayPublish (ConnectionContextFlag connectionContextFlags) const final
virtual bool	mayConnect (ConnectionContextFlag connectionContextFlags) const final
virtual bool	mayDisconnect (ConnectionContextFlag connectionContextFlags) const final
virtual std::int32_t	getConnectionPermissions () const final
virtual bool	isConnectionPermissionFlagSet (ConnectionPermissionFlag connectionPermissionsFlag) final
virtual void	setConnectionPermissionsFlag (ConnectionPermissionFlag connectionPermissionsFlag, bool unset=false, bool recursive=false) final
virtual void	setConnectionPermissions (std::int32_t connectionPermissions, bool recursive=false) final
virtual void	setConnectionPermissionsToNone (bool recursive=false) final
virtual void	setConnectionPermissionsToForceNone (bool recursive=false) final
virtual void	setConnectionPermissionsToAll (bool recursive=false) final
virtual void	cacheConnectionPermissions (bool recursive=false) final
virtual void	restoreConnectionPermissions (bool recursive=false) final
virtual void	startDrag () final
virtual bool	isResettable () const final
virtual void	reset () final
virtual void	setSettingsPrefix (const QString &settingsPrefix, const bool &load=true) final
virtual void	setSettingsPrefix (plugin::Plugin *plugin, const QString &settingsPrefix, const bool &load=true) final
virtual QString	getSettingsPrefix () const
virtual void	loadFromSettings () final
virtual void	saveToSettings () final
virtual QVector< WidgetAction * >	findChildren (const QString &searchString, bool recursive=true) const final
virtual QSize	getPopupSizeHint () const final
virtual void	setPopupSizeHint (const QSize &popupSizeHint) final
virtual std::int32_t	getConfiguration () const final
virtual bool	isConfigurationFlagSet (ConfigurationFlag configurationFlag) const final
virtual void	setConfigurationFlag (ConfigurationFlag configurationFlag, bool unset=false, bool recursive=false) final
virtual void	setConfiguration (std::int32_t configuration, bool recursive=false) final
virtual QString	getTypeString (bool humanFriendly=false) const final
void	fromVariantMap (const QVariantMap &variantMap) override
QVariantMap	toVariantMap () const override
virtual void	cacheState (const QString &name="cache") final
virtual void	restoreState (const QString &name="cache", bool remove=true) final
virtual void	setStudioMode (bool studioMode, bool recursive=true) final
Public Member Functions inherited from hdps::util::Serializable
	Serializable (const QString &serializationName="")
virtual QString	getId () const final
virtual void	setId (const QString &id) final
virtual QString	getSerializationName () const final
virtual void	setSerializationName (const QString &serializationName) final
virtual void	fromParentVariantMap (const QVariantMap &parentVariantMap)
virtual void	insertIntoVariantMap (QVariantMap &variantMap) const final
virtual void	fromJsonDocument (const QJsonDocument &jsonDocument) final
virtual QJsonDocument	toJsonDocument () const final
virtual void	fromJsonFile (const QString &filePath="") final
virtual void	toJsonFile (const QString &filePath="") final
virtual void	makeUnique () final

Static Public Member Functions
static QString	getTypeName (const Type &type)
Static Public Member Functions inherited from hdps::util::Serializable
static QString	createId ()

Additional Inherited Members
Signals inherited from hdps::gui::WidgetAction
void	idChanged (const QString &id)
void	sortIndexChanged (std::int32_t sortIndex)
void	stretchChanged (std::int32_t stretch)
void	forceHiddenChanged (bool forceHidden)
void	forceDisabledChanged (bool forceDisabled)
void	highlightingChanged (const HighlightOption &highlightOption)
void	isPublishedChanged (const bool &isPublished)
void	isConnectedChanged (const bool &isConnected)
void	actionConnected (WidgetAction *action)
void	actionDisconnected (WidgetAction *action)
void	connectionPermissionsChanged (std::int32_t connectionPermissions)
void	configurationFlagToggled (const ConfigurationFlag &configurationFlag, bool set)
void	configurationChanged (std::int32_t configuration)
void	scopeChanged (const Scope &scope)
void	textChanged (const QString &text)
void	locationChanged (const QString &location)
Static Public Attributes inherited from hdps::gui::WidgetAction
static QMap< Scope, QString >	scopeNames
Protected Member Functions inherited from hdps::gui::WidgetAction
virtual void	makePublic (bool recursive=true) final
virtual void	connectToPublicAction (WidgetAction *publicAction, bool recursive)
virtual void	connectToPublicActionByName (const QString &publicActionName) final
virtual void	disconnectFromPublicAction (bool recursive)
virtual QWidget *	getWidget (QWidget *parent, const std::int32_t &widgetFlags)
Static Protected Member Functions inherited from hdps::util::Serializable
static void	fromVariantMap (Serializable *serializable, const QVariantMap &variantMap)
static void	fromVariantMap (Serializable &serializable, const QVariantMap &variantMap, const QString &key)
static QVariantMap	toVariantMap (const Serializable *serializable)
static void	insertIntoVariantMap (const Serializable &serializable, QVariantMap &variantMap, const QString &key)
static void	insertIntoVariantMap (const Serializable &serializable, QVariantMap &variantMap)
Protected Attributes inherited from hdps::plugin::Plugin
CoreInterface *	_core
const PluginFactory *	_factory
const QString	_name
QMap< QString, QVariant >	_properties
EventListener	_eventListener
gui::StringAction	_guiNameAction
gui::TriggerAction	_destroyAction

Member Enumeration Documentation

Type

enum ImageData::Type

Enumerator
Undefined
Sequence
Stack
MultiPartSequence

Constructor & Destructor Documentation

ImageData()

ImageData::ImageData

(

const hdps::plugin::PluginFactory *

factory

)

Member Function Documentation

createDataSet()

Dataset< DatasetImpl > ImageData::createDataSet ( const QString &  guid = "" ) const

overridevirtual

Create dataset for raw data

Parameters

guid	Globally unique dataset identifier (use only for deserialization)

Returns

Smart pointer to dataset

Implements hdps::plugin::RawData.

getImageFilePaths()

QStringList ImageData::getImageFilePaths

(

)

const

Gets the image file paths

getImageSize()

QSize ImageData::getImageSize

(

)

const

Get the image size

getNumberOfComponentsPerPixel()

std::uint32_t ImageData::getNumberOfComponentsPerPixel

(

)

const

Gets the number of components per pixel

getNumberOfImages()

std::uint32_t ImageData::getNumberOfImages

(

)

const

Gets the number of images

getTargetRectangle()

QRect ImageData::getTargetRectangle

(

)

const

Get the target rectangle

getType()

ImageData::Type ImageData::getType

(

)

const

Gets the image collection type e.g. stack or sequence

getTypeName()

static QString ImageData::getTypeName ( const Type &  type )

inlinestatic

init()

void ImageData::init ( )

overridevirtual

Can be implemented to initialize the plugin to a certain state. This function gets called when the plugin is first instantiated.

Implements hdps::plugin::Plugin.

setImageFilePaths()

void ImageData::setImageFilePaths

(

const QStringList &

imageFilePaths

)

Sets the image file paths

Parameters

imageFilePaths

Image file paths

setImageSize()

void ImageData::setImageSize

(

const QSize &

imageSize

)

Set the image size

Parameters

imageSize

Size of the image(s)

setNumberImages()

void ImageData::setNumberImages

(

const std::uint32_t &

numberOfImages

)

Sets the number of images

Parameters

numberOfImages

Number of images

setNumberOfComponentsPerPixel()

void ImageData::setNumberOfComponentsPerPixel

(

const std::uint32_t &

numberOfComponentsPerPixel

)

Sets the number of components per pixel

Parameters

numberOfPixelComponents

Number of pixel components

setType()

void ImageData::setType

(

const Type &

type

)

Sets the image collection type e.g. stack or sequence

Parameters

type	Image collection type

---

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

• D:/Work/ManiVault/DevBundle/allmain/source/core/HDPS/src/plugins/ImageData/src/ImageData.h
• D:/Work/ManiVault/DevBundle/allmain/source/core/HDPS/src/plugins/ImageData/src/ImageData.cpp