hdps::gui::ColorMapAction Class Reference

#include <ColorMapAction.h>

Inheritance diagram for hdps::gui::ColorMapAction:

Classes
class	ComboBoxWidget

Public Types
enum	WidgetFlag { Settings = 0x00001 , EditRange = 0x00002 , Default = Settings | EditRange }
enum class	Axis { X = 0 , Y , Count }
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 }

Signals
void	typeChanged (const util::ColorMap::Type &colorMapType)
void	imageChanged (const QImage &image)
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)

Public Member Functions
void	initialize (const QString &colorMap)
util::ColorMap::Type	getColorMapType () const
QString	getColorMap () const
QImage	getColorMapImage () const
void	setColorMap (const QString &colorMap)
void	fromVariantMap (const QVariantMap &variantMap) override
QVariantMap	toVariantMap () const override
const OptionAction &	getCurrentColorMapAction () const
const DecimalRangeAction &	getRangeAction (const Axis &axis) const
const DecimalRangeAction &	getDataRangeAction (const Axis &axis) const
const DecimalRangeAction &	getSharedDataRangeAction (const Axis &axis) const
const ToggleAction &	getLockToSharedDataRangeAction () const
const ToggleAction &	getMirrorAction (const Axis &axis) const
const HorizontalGroupAction &	getMirrorGroupAction () const
const ToggleAction &	getDiscretizeAction () const
const IntegralAction &	getNumberOfDiscreteStepsAction () const
const ToggleAction &	getDiscretizeAlphaAction () const
const ColorMapSettings1DAction &	getSettings1DAction () const
const ColorMapSettings2DAction &	getSettings2DAction () const
const ToggleAction &	getCustomColorMapAction () const
const ColorMapEditor1DAction &	getEditor1DAction () const
const HorizontalGroupAction &	getCustomColorMapGroupAction () const
const ColorMapSettingsAction &	getSettingsAction () const
OptionAction &	getCurrentColorMapAction ()
DecimalRangeAction &	getRangeAction (const Axis &axis)
DecimalRangeAction &	getDataRangeAction (const Axis &axis)
DecimalRangeAction &	getSharedDataRangeAction (const Axis &axis)
ToggleAction &	getLockToSharedDataRangeAction ()
ToggleAction &	getMirrorAction (const Axis &axis)
HorizontalGroupAction &	getMirrorGroupAction ()
ToggleAction &	getDiscretizeAction ()
IntegralAction &	getNumberOfDiscreteStepsAction ()
ToggleAction &	getDiscretizeAlphaAction ()
ColorMapSettings1DAction &	getSettings1DAction ()
ColorMapSettings2DAction &	getSettings2DAction ()
ToggleAction &	getCustomColorMapAction ()
ColorMapEditor1DAction &	getEditor1DAction ()
HorizontalGroupAction &	getCustomColorMapGroupAction ()
ColorMapSettingsAction &	getSettingsAction ()
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

Protected Member Functions
QWidget *	getWidget (QWidget *parent, const std::int32_t &widgetFlags) override
Q_INVOKABLE	ColorMapAction (QObject *parent, const QString &title, const util::ColorMap::Type &colorMapType=util::ColorMap::Type::OneDimensional, const QString &colorMap="RdYlBu")
void	setColorMapType (const util::ColorMap::Type &colorMapType)
void	connectToPublicAction (WidgetAction *publicAction, bool recursive) override
void	disconnectFromPublicAction (bool recursive) override
Protected Member Functions inherited from hdps::gui::WidgetAction
virtual void	makePublic (bool recursive=true) final
virtual void	connectToPublicActionByName (const QString &publicActionName) final

Protected Attributes
util::ColorMapFilterModel	_colorMapFilterModel
OptionAction	_currentColorMapAction
DecimalRangeAction	_rangeAction [static_cast< int >(Axis::Count)]
DecimalRangeAction	_dataRangeAction [static_cast< int >(Axis::Count)]
DecimalRangeAction	_sharedDataRangeAction [static_cast< int >(Axis::Count)]
ToggleAction	_lockToSharedDataRangeAction
ToggleAction	_mirrorAction [static_cast< int >(Axis::Count)]
HorizontalGroupAction	_mirrorGroupAction
ToggleAction	_discretizeAction
IntegralAction	_numberOfDiscreteStepsAction
ToggleAction	_discretizeAlphaAction
ColorMapSettings1DAction	_settings1DAction
ColorMapSettings2DAction	_settings2DAction
ToggleAction	_customColorMapAction
ColorMapEditor1DAction	_editor1DAction
HorizontalGroupAction	_customColorMapGroupAction
ColorMapSettingsAction	_settingsAction

Friends
class	AbstractActionsManager
class	ColorMap1DAction
class	ColorMap2DAction

Additional Inherited Members
Static Public Member Functions inherited from hdps::util::Serializable
static QString	createId ()
Static Public Attributes inherited from hdps::gui::WidgetAction
static QMap< Scope, QString >	scopeNames
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)

Detailed Description

Color map action class

Color map selection and settings action

Author

Thomas Kroes

Member Enumeration Documentation

Axis

enum class hdps::gui::ColorMapAction::Axis

strong

Axis enum for distinguishing between x- and y axis part of the color map (range)

Enumerator
X
Y	Along x-axis
Count	Along y-axis

WidgetFlag

enum hdps::gui::ColorMapAction::WidgetFlag

Describes the widget configurations (a color map combobox always exists)

Enumerator
Settings
EditRange	Widgets have a settings popup to adjust range and other settings
Default	Users are allowed to change the color map range

Constructor & Destructor Documentation

ColorMapAction()

hdps::gui::ColorMapAction::ColorMapAction ( QObject *  parent, const QString &  title, const util::ColorMap::Type &  colorMapType = util::ColorMap::Type::OneDimensional, const QString &  colorMap = "RdYlBu"  )

protected

Constructor

Parameters

parent	Pointer to parent object
title	Title of the action
colorMapType	Type of color map (1D/2D)
colorMap	Current color map

Member Function Documentation

connectToPublicAction()

void hdps::gui::ColorMapAction::connectToPublicAction ( WidgetAction *  publicAction, bool  recursive  )

overrideprotectedvirtual

Connect this action to a public action

Parameters

publicAction	Pointer to public action to connect to
recursive	Whether to also connect descendant child actions

Reimplemented from hdps::gui::WidgetAction.

disconnectFromPublicAction()

void hdps::gui::ColorMapAction::disconnectFromPublicAction ( bool  recursive )

overrideprotectedvirtual

Disconnect this action from its public action

Parameters

recursive

Whether to also disconnect descendant child actions

Reimplemented from hdps::gui::WidgetAction.

fromVariantMap()

void hdps::gui::ColorMapAction::fromVariantMap ( const QVariantMap &  variantMap )

overridevirtual

Load widget action from variant map

Parameters

Variant

map representation of the widget action

Reimplemented from hdps::util::Serializable.

getColorMap()

QString hdps::gui::ColorMapAction::getColorMap

(

)

const

Gets the current color map name

getColorMapImage()

QImage hdps::gui::ColorMapAction::getColorMapImage

(

)

const

Gets the current color map

getColorMapType()

hdps::util::ColorMap::Type hdps::gui::ColorMapAction::getColorMapType

(

)

const

Gets the current color map type

getCurrentColorMapAction() [1/2]

OptionAction & hdps::gui::ColorMapAction::getCurrentColorMapAction ( )

inline

getCurrentColorMapAction() [2/2]

const OptionAction & hdps::gui::ColorMapAction::getCurrentColorMapAction ( ) const

inline

getCustomColorMapAction() [1/2]

ToggleAction & hdps::gui::ColorMapAction::getCustomColorMapAction ( )

inline

getCustomColorMapAction() [2/2]

const ToggleAction & hdps::gui::ColorMapAction::getCustomColorMapAction ( ) const

inline

getCustomColorMapGroupAction() [1/2]

HorizontalGroupAction & hdps::gui::ColorMapAction::getCustomColorMapGroupAction ( )

inline

getCustomColorMapGroupAction() [2/2]

const HorizontalGroupAction & hdps::gui::ColorMapAction::getCustomColorMapGroupAction ( ) const

inline

getDataRangeAction() [1/2]

DecimalRangeAction & hdps::gui::ColorMapAction::getDataRangeAction ( const Axis &  axis )

inline

getDataRangeAction() [2/2]

const DecimalRangeAction & hdps::gui::ColorMapAction::getDataRangeAction ( const Axis &  axis ) const

inline

getDiscretizeAction() [1/2]

ToggleAction & hdps::gui::ColorMapAction::getDiscretizeAction ( )

inline

getDiscretizeAction() [2/2]

const ToggleAction & hdps::gui::ColorMapAction::getDiscretizeAction ( ) const

inline

getDiscretizeAlphaAction() [1/2]

ToggleAction & hdps::gui::ColorMapAction::getDiscretizeAlphaAction ( )

inline

getDiscretizeAlphaAction() [2/2]

const ToggleAction & hdps::gui::ColorMapAction::getDiscretizeAlphaAction ( ) const

inline

getEditor1DAction() [1/2]

ColorMapEditor1DAction & hdps::gui::ColorMapAction::getEditor1DAction ( )

inline

getEditor1DAction() [2/2]

const ColorMapEditor1DAction & hdps::gui::ColorMapAction::getEditor1DAction ( ) const

inline

getLockToSharedDataRangeAction() [1/2]

ToggleAction & hdps::gui::ColorMapAction::getLockToSharedDataRangeAction ( )

inline

getLockToSharedDataRangeAction() [2/2]

const ToggleAction & hdps::gui::ColorMapAction::getLockToSharedDataRangeAction ( ) const

inline

getMirrorAction() [1/2]

ToggleAction & hdps::gui::ColorMapAction::getMirrorAction ( const Axis &  axis )

inline

getMirrorAction() [2/2]

const ToggleAction & hdps::gui::ColorMapAction::getMirrorAction ( const Axis &  axis ) const

inline

getMirrorGroupAction() [1/2]

HorizontalGroupAction & hdps::gui::ColorMapAction::getMirrorGroupAction ( )

inline

getMirrorGroupAction() [2/2]

const HorizontalGroupAction & hdps::gui::ColorMapAction::getMirrorGroupAction ( ) const

inline

getNumberOfDiscreteStepsAction() [1/2]

IntegralAction & hdps::gui::ColorMapAction::getNumberOfDiscreteStepsAction ( )

inline

getNumberOfDiscreteStepsAction() [2/2]

const IntegralAction & hdps::gui::ColorMapAction::getNumberOfDiscreteStepsAction ( ) const

inline

getRangeAction() [1/2]

DecimalRangeAction & hdps::gui::ColorMapAction::getRangeAction ( const Axis &  axis )

inline

getRangeAction() [2/2]

const DecimalRangeAction & hdps::gui::ColorMapAction::getRangeAction ( const Axis &  axis ) const

inline

getSettings1DAction() [1/2]

ColorMapSettings1DAction & hdps::gui::ColorMapAction::getSettings1DAction ( )

inline

getSettings1DAction() [2/2]

const ColorMapSettings1DAction & hdps::gui::ColorMapAction::getSettings1DAction ( ) const

inline

getSettings2DAction() [1/2]

ColorMapSettings2DAction & hdps::gui::ColorMapAction::getSettings2DAction ( )

inline

getSettings2DAction() [2/2]

const ColorMapSettings2DAction & hdps::gui::ColorMapAction::getSettings2DAction ( ) const

inline

getSettingsAction() [1/2]

ColorMapSettingsAction & hdps::gui::ColorMapAction::getSettingsAction ( )

inline

getSettingsAction() [2/2]

const ColorMapSettingsAction & hdps::gui::ColorMapAction::getSettingsAction ( ) const

inline

getSharedDataRangeAction() [1/2]

DecimalRangeAction & hdps::gui::ColorMapAction::getSharedDataRangeAction ( const Axis &  axis )

inline

getSharedDataRangeAction() [2/2]

const DecimalRangeAction & hdps::gui::ColorMapAction::getSharedDataRangeAction ( const Axis &  axis ) const

inline

getWidget()

QWidget * hdps::gui::ColorMapAction::getWidget ( QWidget *  parent, const std::int32_t &  widgetFlags  )

overrideprotectedvirtual

Get widget representation of the color map action

Parameters

parent	Pointer to parent widget
widgetFlags	Widget flags for the configuration of the widget (type)

Reimplemented from hdps::gui::WidgetAction.

imageChanged

void hdps::gui::ColorMapAction::imageChanged ( const QImage &  image )

signal

Signals that the current color map image changed

Parameters

image

Current color map image

initialize()

void hdps::gui::ColorMapAction::initialize

(

const QString &

colorMap

)

Initialize the color map action

Parameters

colorMap

Current color map

setColorMap()

void hdps::gui::ColorMapAction::setColorMap

(

const QString &

colorMap

)

Sets the current color map name

Parameters

colorMap

Name of the current color map

setColorMapType()

void hdps::gui::ColorMapAction::setColorMapType ( const util::ColorMap::Type &  colorMapType )

protected

Sets the current color map type

toVariantMap()

QVariantMap hdps::gui::ColorMapAction::toVariantMap ( ) const

overridevirtual

Save widget action to variant map

Returns

Variant map representation of the widget action

Reimplemented from hdps::util::Serializable.

typeChanged

void hdps::gui::ColorMapAction::typeChanged ( const util::ColorMap::Type &  colorMapType )

signal

Signals that the current color map type changed

Parameters

colorMapType

Current color map type

Friends And Related Symbol Documentation

AbstractActionsManager

friend class AbstractActionsManager

friend

Color map settings action

ColorMap1DAction

friend class ColorMap1DAction

friend

ColorMap2DAction

friend class ColorMap2DAction

friend

Member Data Documentation

_colorMapFilterModel

util::ColorMapFilterModel hdps::gui::ColorMapAction::_colorMapFilterModel

protected

_currentColorMapAction

OptionAction hdps::gui::ColorMapAction::_currentColorMapAction

protected

The filtered color map model (contains either 1D or 2D color maps)

_customColorMapAction

ToggleAction hdps::gui::ColorMapAction::_customColorMapAction

protected

Two-dimensional settings action

_customColorMapGroupAction

HorizontalGroupAction hdps::gui::ColorMapAction::_customColorMapGroupAction

protected

One-dimensional editor action

_dataRangeAction

DecimalRangeAction hdps::gui::ColorMapAction::_dataRangeAction[static_cast< int >(Axis::Count)]

protected

Color map range action (1D/2D color map)

_discretizeAction

ToggleAction hdps::gui::ColorMapAction::_discretizeAction

protected

Group action for mirroring along horizontal/vertical axis

_discretizeAlphaAction

ToggleAction hdps::gui::ColorMapAction::_discretizeAlphaAction

protected

Number of discrete steps action

_editor1DAction

ColorMapEditor1DAction hdps::gui::ColorMapAction::_editor1DAction

protected

Toggle custom color map action

_lockToSharedDataRangeAction

ToggleAction hdps::gui::ColorMapAction::_lockToSharedDataRangeAction

protected

Shared range (1D/2D color map) of all connected color maps (if the color map is connected to a public color map)

_mirrorAction

ToggleAction hdps::gui::ColorMapAction::_mirrorAction[static_cast< int >(Axis::Count)]

protected

Lock to shared data range action

_mirrorGroupAction

HorizontalGroupAction hdps::gui::ColorMapAction::_mirrorGroupAction

protected

Mirror along the horizontal/vertical axis action

_numberOfDiscreteStepsAction

IntegralAction hdps::gui::ColorMapAction::_numberOfDiscreteStepsAction

protected

Discretize toggle action

_rangeAction

DecimalRangeAction hdps::gui::ColorMapAction::_rangeAction[static_cast< int >(Axis::Count)]

protected

Current color map selection action

_settings1DAction

ColorMapSettings1DAction hdps::gui::ColorMapAction::_settings1DAction

protected

Whether to also discretize the alpha channel of the color map

_settings2DAction

ColorMapSettings2DAction hdps::gui::ColorMapAction::_settings2DAction

protected

One-dimensional settings action

_settingsAction

ColorMapSettingsAction hdps::gui::ColorMapAction::_settingsAction

protected

Groups the custom color map and editor action

_sharedDataRangeAction

DecimalRangeAction hdps::gui::ColorMapAction::_sharedDataRangeAction[static_cast< int >(Axis::Count)]

protected

Range of the associated dataset (1D/2D color map)

---

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

• D:/Work/ManiVault/DevBundle/allmain/source/core/HDPS/src/actions/ColorMapAction.h
• D:/Work/ManiVault/DevBundle/allmain/source/core/HDPS/src/actions/ColorMapAction.cpp