DimensionsPickerAction Class Reference

#include <DimensionsPickerAction.h>

Inheritance diagram for DimensionsPickerAction:

Classes
class	Widget

Signals
void	proxyModelChanged (DimensionsPickerProxyModel *dimensionsPickerProxyModel)
void	selectedDimensionsChanged (const QVector< std::int32_t > &selectedDimensionIndices)
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
Q_INVOKABLE	DimensionsPickerAction (QObject *parent, const QString &title)
	~DimensionsPickerAction ()
void	fromVariantMap (const QVariantMap &variantMap) override
QVariantMap	toVariantMap () const override
void	setDimensions (const std::uint32_t numDimensions, const std::vector< QString > &names)
const QVector< std::int32_t >	getSelectedDimensions () const
std::vector< bool >	getEnabledDimensions () const
Dataset< Points >	getPointsDataset () const
void	setPointsDataset (const Dataset< Points > &points)
DimensionsPickerHolder &	getHolder ()
DimensionsPickerItemModel &	getItemModel ()
DimensionsPickerProxyModel &	getProxyModel ()
void	setNameFilter (const QString &nameFilter)
void	setShowOnlySelectedDimensions (const bool &showOnlySelectedDimensions)
void	setApplyExclusionList (const bool &applyExclusionList)
void	setIgnoreZeroValues (const bool &ignoreZeroValues)
void	loadSelectionFromFile (const QString &fileName)
void	loadExclusionFromFile (const QString &fileName)
void	saveSelectionToFile (const QString &fileName)
void	selectDimension (const QString &dimensionName, bool clearExisiting=false)
void	selectDimension (const std::int32_t &dimensionIndex, bool clearExisiting=false)
void	selectDimensions (const QVector< std::int32_t > &dimensionIndices, bool clearExisiting=true)
template<bool selectVisible>
void	selectDimensionsBasedOnVisibility ()
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
void	computeStatistics ()
void	updateSlider ()
void	updateSummary ()
void	connectToPublicAction (WidgetAction *publicAction, bool recursive) override
void	disconnectFromPublicAction (bool recursive) override
DimensionsPickerFilterAction &	getFilterAction ()
DimensionsPickerSelectAction &	getSelectAction ()
StringAction &	getSummaryAction ()
DimensionsPickerMiscellaneousAction &	getMiscellaneousAction ()
Protected Member Functions inherited from hdps::gui::WidgetAction
virtual void	makePublic (bool recursive=true) final
virtual void	connectToPublicActionByName (const QString &publicActionName) final

Protected Attributes
Dataset< Points >	_points
DimensionsPickerHolder	_holder
std::unique_ptr< DimensionsPickerItemModel >	_itemModel
std::unique_ptr< DimensionsPickerProxyModel >	_proxyModel
StringAction	_summaryAction
DimensionsPickerFilterAction	_filterAction
DimensionsPickerSelectAction	_selectAction
DimensionsPickerMiscellaneousAction	_miscellaneousAction
QMetaObject::Connection	_summaryUpdateAwakeConnection

Friends
class	Widget
class	AbstractActionsManager

Additional Inherited Members
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 }
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

Dimensions picker action class

Action class for picking one or more points dimensions

Author

Thomas Kroes

Constructor & Destructor Documentation

DimensionsPickerAction()

DimensionsPickerAction::DimensionsPickerAction	(	QObject *	parent,
		const QString &	title
	)

Constructor

Parameters

parent	Pointer to parent object
title	Title of the action

~DimensionsPickerAction()

DimensionsPickerAction::~DimensionsPickerAction

(

)

Destructor

Member Function Documentation

computeStatistics()

void DimensionsPickerAction::computeStatistics ( )

protected

Compute dimension statistics

connectToPublicAction()

void DimensionsPickerAction::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 DimensionsPickerAction::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 DimensionsPickerAction::fromVariantMap ( const QVariantMap &  variantMap )

overridevirtual

Load widget action from variant

Parameters

Variant

representation of the widget action

Reimplemented from hdps::util::Serializable.

getEnabledDimensions()

std::vector< bool > DimensionsPickerAction::getEnabledDimensions

(

)

const

Get enabled dimension

Returns

Vector of booleans where each boolean indicates whether the dimension is enabled or not

getFilterAction()

DimensionsPickerFilterAction & DimensionsPickerAction::getFilterAction ( )

inlineprotected

getHolder()

DimensionsPickerHolder & DimensionsPickerAction::getHolder

(

)

Get selection picker holder

Returns

Reference to dimensions picker holder

getItemModel()

DimensionsPickerItemModel & DimensionsPickerAction::getItemModel

(

)

Get item model

Returns

Reference to item model

getMiscellaneousAction()

DimensionsPickerMiscellaneousAction & DimensionsPickerAction::getMiscellaneousAction ( )

inlineprotected

getPointsDataset()

Dataset< Points > DimensionsPickerAction::getPointsDataset

(

)

const

Get the input points dataset

Parameters

Input

points dataset

getProxyModel()

DimensionsPickerProxyModel & DimensionsPickerAction::getProxyModel

(

)

Get selection proxy model

Returns

Reference to selection proxy model

getSelectAction()

DimensionsPickerSelectAction & DimensionsPickerAction::getSelectAction ( )

inlineprotected

getSelectedDimensions()

const QVector< std::int32_t > DimensionsPickerAction::getSelectedDimensions

(

)

const

Get indices of the currently selected dimensions

Returns

Indices of the currently selected dimensions

getSummaryAction()

StringAction & DimensionsPickerAction::getSummaryAction ( )

inlineprotected

getWidget()

QWidget * DimensionsPickerAction::getWidget ( QWidget *  parent, const std::int32_t &  widgetFlags  )

inlineoverrideprotectedvirtual

Get widget representation of the dimension selection action

Parameters

parent	Pointer to parent widget
widgetFlags	Widget flags for the configuration of the widget

Reimplemented from hdps::gui::WidgetAction.

loadExclusionFromFile()

void DimensionsPickerAction::loadExclusionFromFile

(

const QString &

fileName

)

Load exclusion from file

Parameters

fileName

Exclusion file name

loadSelectionFromFile()

void DimensionsPickerAction::loadSelectionFromFile

(

const QString &

fileName

)

Load selection from file

Parameters

fileName

Selection file name

proxyModelChanged

void DimensionsPickerAction::proxyModelChanged ( DimensionsPickerProxyModel *  dimensionsPickerProxyModel )

signal

Signals that the proxy model changed

Parameters

dimensionsPickerProxyModel

Pointer to dimensions picker proxy model

saveSelectionToFile()

void DimensionsPickerAction::saveSelectionToFile

(

const QString &

fileName

)

Save selection from file

Parameters

fileName

Selection file name

selectDimension() [1/2]

void DimensionsPickerAction::selectDimension	(	const QString &	dimensionName,
		bool	clearExisiting = false
	)

Select a single dimension by name (and possibly clear the selection)

Parameters

dimensionName	Name of the dimension to select
clearExisiting	Whether to clear the current selection

selectDimension() [2/2]

void DimensionsPickerAction::selectDimension	(	const std::int32_t &	dimensionIndex,
		bool	clearExisiting = false
	)

Select a single dimension by index (and possibly clear the selection)

Parameters

dimensionIndex	Index of the dimension to select
clearExisiting	Whether to clear the current selection

selectDimensions()

void DimensionsPickerAction::selectDimensions	(	const QVector< std::int32_t > &	dimensionIndices,
		bool	clearExisiting = true
	)

Select one or more dimensions by index (and possibly clear the selection)

Parameters

dimensionIndices	Indices of the dimensions to select
clearExisiting	Whether to clear the current selection

selectDimensionsBasedOnVisibility()

template<bool selectVisible>

void DimensionsPickerAction::selectDimensionsBasedOnVisibility ( )

inline

Select dimensions based on visibility

selectedDimensionsChanged

void DimensionsPickerAction::selectedDimensionsChanged ( const QVector< std::int32_t > &  selectedDimensionIndices )

signal

Signals that the selected dimensions changed

Parameters

selectedDimensionIndices

Indices of the currently selected dimensions

setApplyExclusionList()

void DimensionsPickerAction::setApplyExclusionList

(

const bool &

applyExclusionList

)

Set apply exclusion list

Parameters

applyExclusionList

Apply exclusion list

setDimensions()

void DimensionsPickerAction::setDimensions	(	const std::uint32_t	numDimensions,
		const std::vector< QString > &	names
	)

Set dimensions

Parameters

numDimensions	Number of dimensions
names	Dimension names

setIgnoreZeroValues()

void DimensionsPickerAction::setIgnoreZeroValues

(

const bool &

ignoreZeroValues

)

Set ignore zero values

Parameters

ignoreZeroValues

Ignore zero values

setNameFilter()

void DimensionsPickerAction::setNameFilter

(

const QString &

nameFilter

)

Set name filter

Parameters

nameFilter

Name filter

setPointsDataset()

void DimensionsPickerAction::setPointsDataset

(

const Dataset< Points > &

points

)

Set the input points dataset

Parameters

points

Smart pointer to points dataset

setShowOnlySelectedDimensions()

void DimensionsPickerAction::setShowOnlySelectedDimensions

(

const bool &

showOnlySelectedDimensions

)

Set show only selected dimensions

Parameters

showOnlySelectedDimensions

Show only selected dimensions

toVariantMap()

QVariantMap DimensionsPickerAction::toVariantMap ( ) const

overridevirtual

Save widget action to variant

Returns

Variant representation of the widget action

Reimplemented from hdps::util::Serializable.

updateSlider()

void DimensionsPickerAction::updateSlider ( )

protected

Update the slider

updateSummary()

void DimensionsPickerAction::updateSummary ( )

protected

Update the dimension selection summary

Friends And Related Symbol Documentation

AbstractActionsManager

friend class AbstractActionsManager

friend

Widget

friend class Widget

friend

Update summary view when idle

Member Data Documentation

_filterAction

DimensionsPickerFilterAction DimensionsPickerAction::_filterAction

protected

Summary action

_holder

DimensionsPickerHolder DimensionsPickerAction::_holder

protected

Smart pointer to points set

_itemModel

std::unique_ptr<DimensionsPickerItemModel> DimensionsPickerAction::_itemModel

protected

Selection holder

_miscellaneousAction

DimensionsPickerMiscellaneousAction DimensionsPickerAction::_miscellaneousAction

protected

Select action

_points

Dataset<Points> DimensionsPickerAction::_points

protected

_proxyModel

std::unique_ptr<DimensionsPickerProxyModel> DimensionsPickerAction::_proxyModel

protected

Selection item model

_selectAction

DimensionsPickerSelectAction DimensionsPickerAction::_selectAction

protected

Filter action

_summaryAction

StringAction DimensionsPickerAction::_summaryAction

protected

Selection proxy model for filtering etc.

_summaryUpdateAwakeConnection

QMetaObject::Connection DimensionsPickerAction::_summaryUpdateAwakeConnection

protected

Miscellaneous settings action

---

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

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