pqDisplayColorWidget Class Reference

pqDisplayColorWidget is a widget that can be used to select the array to with for representations (also known as displays). More...

#include <pqDisplayColorWidget.h>

Inherits QWidget.

Public Types
typedef QPair< int, QString >	ValueType

Public Slots
void	setRepresentationText (const QString &text)
	set representation type. More...
void	queryCurrentSelectedArray ()
	Query the currently selected array from the property. More...
void	setRepresentation (pqDataRepresentation *display, int selectedPropertiesType)
	Set the representation to control the scalar coloring properties on. More...
void	setRepresentation (pqDataRepresentation *display)
	Set the representation to control the scalar coloring properties on. More...

Signals
void	arraySelectionChanged ()
	fired to indicate the array-name changed. More...
void	representationTextChanged (const QString &text)
	fired to indicate the representation type changed, allowing us to update. More...

Public Member Functions
	pqDisplayColorWidget (QWidget *parent=nullptr)
	~pqDisplayColorWidget () override
ValueType	arraySelection () const
	Get/Set the array name as pair (association-number, arrayname). More...
QString	getCurrentText () const
int	componentNumber () const
	Get/Set the component number (-1 == magnitude). More...
vtkSMViewProxy *	viewProxy () const
	Returns the view proxy corresponding to the set representation, if any. More...
QString	representationText () const
	Returns the selected representation type as a string. More...

Static Public Member Functions
static void	hideScalarBarsIfNotNeeded (vtkSMViewProxy *view, std::vector< vtkSMProxy *> luts)
	Hides the scalar bars if not needed. More...
static void	updateScalarBarVisibility (vtkSMViewProxy *view, vtkSMProxy *reprProxy, int selectedPropertiesType=0)
	Updates the scalar bar visibility of the representation reprProxy in view. More...

Protected Member Functions
void	setArraySelection (const ValueType &)
	Update the UI to show the selected array. More...
void	setComponentNumber (int)
	Update the UI to show the selected component. More...

Properties
QString	representationText

Friends
class	PropertyLinksConnection

Detailed Description

pqDisplayColorWidget is a widget that can be used to select the array to with for representations (also known as displays).

It comprises of two combo-boxes, one for the array name, and another for component number. To use, set the representation using setRepresentation(..). If the representation has appropriate properties, this widget will allow users to select the array name.

Definition at line 31 of file pqDisplayColorWidget.h.

Member Typedef Documentation

ValueType

typedef QPair<int, QString> pqDisplayColorWidget::ValueType

Definition at line 38 of file pqDisplayColorWidget.h.

Constructor & Destructor Documentation

pqDisplayColorWidget()

pqDisplayColorWidget::pqDisplayColorWidget

(

QWidget *

parent = nullptr

)

~pqDisplayColorWidget()

pqDisplayColorWidget::~pqDisplayColorWidget ( )

override

Member Function Documentation

arraySelection()

ValueType pqDisplayColorWidget::arraySelection

(

)

const

Get/Set the array name as pair (association-number, arrayname).

getCurrentText()

QString pqDisplayColorWidget::getCurrentText ( ) const

inline

Definition at line 47 of file pqDisplayColorWidget.h.

componentNumber()

int pqDisplayColorWidget::componentNumber

(

)

const

Get/Set the component number (-1 == magnitude).

viewProxy()

vtkSMViewProxy* pqDisplayColorWidget::viewProxy

(

)

const

Returns the view proxy corresponding to the set representation, if any.

hideScalarBarsIfNotNeeded()

static void pqDisplayColorWidget::hideScalarBarsIfNotNeeded ( vtkSMViewProxy *  view, std::vector< vtkSMProxy *>  luts  )

static

Hides the scalar bars if not needed.

updateScalarBarVisibility()

static void pqDisplayColorWidget::updateScalarBarVisibility ( vtkSMViewProxy *  view, vtkSMProxy *  reprProxy, int  selectedPropertiesType = 0  )

static

Updates the scalar bar visibility of the representation reprProxy in view.

The behavior of the scalar bar visibility is dependent of the general settings.

representationText()

QString pqDisplayColorWidget::representationText ( ) const

inline

Returns the selected representation type as a string.

Definition at line 74 of file pqDisplayColorWidget.h.

arraySelectionChanged

void pqDisplayColorWidget::arraySelectionChanged ( )

signal

fired to indicate the array-name changed.

representationTextChanged

void pqDisplayColorWidget::representationTextChanged ( const QString &  text )

signal

fired to indicate the representation type changed, allowing us to update.

setRepresentation [1/2]

void pqDisplayColorWidget::setRepresentation ( pqDataRepresentation *  display, int  selectedPropertiesType  )

slot

Set the representation to control the scalar coloring properties on.

setRepresentation [2/2]

void pqDisplayColorWidget::setRepresentation ( pqDataRepresentation *  display )

inlineslot

Set the representation to control the scalar coloring properties on.

Definition at line 93 of file pqDisplayColorWidget.h.

setRepresentationText

void pqDisplayColorWidget::setRepresentationText ( const QString &  text )

slot

set representation type.

queryCurrentSelectedArray

void pqDisplayColorWidget::queryCurrentSelectedArray ( )

slot

Query the currently selected array from the property.

setArraySelection()

void pqDisplayColorWidget::setArraySelection ( const ValueType &  )

protected

Update the UI to show the selected array.

setComponentNumber()

void pqDisplayColorWidget::setComponentNumber ( int  )

protected

Update the UI to show the selected component.

Friends And Related Function Documentation

PropertyLinksConnection

friend class PropertyLinksConnection

friend

Definition at line 183 of file pqDisplayColorWidget.h.

Property Documentation

representationText

QString pqDisplayColorWidget::representationText

readwrite

Definition at line 34 of file pqDisplayColorWidget.h.

---

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

• /builds/gitlab-kitware-sciviz-ci/Qt/Components/pqDisplayColorWidget.h