Signals | Public Member Functions | Protected Member Functions | List of all members
pqColorAnnotationsWidget Class Reference

pqColorAnnotationsWidget is used to edit annotations and colors More...

#include <pqColorAnnotationsWidget.h>

Inherits QWidget.

Signals

void annotationsChanged ()
 Fired when the annotations are changed. More...
 
void indexedColorsChanged ()
 Fired when the indexed colors are changed. More...
 
void indexedOpacitiesChanged ()
 Fired when the indexed opacities are changed. More...
 
void visibilitiesChanged ()
 Fired when the visibilities are changed. More...
 
void opacityMappingChanged ()
 Fired when the opacity mapping status is changed. More...
 
void presetChanged (const QString &name)
 Fired when a new preset is applied. More...
 
void selectionChanged (const QItemSelection &, const QItemSelection &)
 Fired when the currently focused item changed. More...
 

Public Member Functions

 pqColorAnnotationsWidget (QWidget *parent=nullptr)
 
 ~pqColorAnnotationsWidget () override
 
void setLookupTableProxy (vtkSMProxy *proxy)
 
void applyPreset (const char *presetName)
 Apply a color preset using its name. More...
 
void indexedLookupStateUpdated (bool indexed)
 Ensures that the table for indexedColors are shown only when this is set to true. More...
 
bool addActiveAnnotations (bool force)
 Use active representation to create annotations. More...
 
bool addActiveAnnotations (bool force, bool extend)
 Setting extend=true grows the list of annotations resulting in a union of previous annotations and annotations for the data range of the active source proxy. More...
 
QModelIndex currentIndex ()
 Return current model index from table. More...
 
QModelIndexList selectedIndexes ()
 Return the selected indexes. More...
 
void setAnnotationsModel (pqAnnotationsModel *model)
 Set the annotionModel on the underlying table. More...
 
void setSupportsReorder (bool reorder)
 Set reordering support on the table. More...
 
void sort (int column, Qt::SortOrder order=Qt::AscendingOrder)
 Sort the underlying proxy model. More...
 
void allowsUserDefinedValues (bool allow)
 Show/Hide relevant widgets. More...
 
void allowsRegexpMatching (bool allow)
 Setup ChooseColor dialog. More...
 
void enablePresets (bool enable)
 Show/Hide relevant widgets. More...
 
void supportsVisibilityCheck (bool val)
 Show/Hide the Visibility column. More...
 
void supportsOpacityMapping (bool val)
 Show/Hide the EnableOpacityMapping button. More...
 
void setColumnVisibility (pqAnnotationsModel::ColumnRoles col, bool visible)
 Show/Hide given column. More...
 
QString currentAnnotationValue ()
 Get the current annotation value. More...
 
QStringList selectedAnnotations ()
 Get the selected annotations values. More...
 
void setSelectedAnnotations (const QStringList &annotations)
 
bool presetLoadAnnotations ()
 Get if annotations should be loaded with the preset. More...
 
QRegularExpression presetRegularExpression ()
 Get the regular expression to use to apply the preset. More...
 
QList< QVariant > annotations () const
 Get/Set the annotations. More...
 
void setAnnotations (const QList< QVariant > &)
 Get/Set the annotations. More...
 
QList< QVariant > indexedColors () const
 Get/Set the indexed colors. More...
 
void setIndexedColors (const QList< QVariant > &)
 Get/Set the indexed colors. More...
 
QList< QVariant > indexedOpacities () const
 Get/Set the indexed opacities. More...
 
void setIndexedOpacities (const QList< QVariant > &)
 Get/Set the indexed opacities. More...
 
QList< QVariant > visibilities () const
 Get/Set the indexed visibilities. More...
 
void setVisibilities (const QList< QVariant > &)
 Get/Set the indexed visibilities. More...
 
QVariant opacityMapping () const
 Get/Set the opacity mapping status. More...
 
void setOpacityMapping (const QVariant &)
 Get/Set the opacity mapping status. More...
 
const char * currentPresetName ()
 Get / Set the name of the current preset in use. More...
 
void setCurrentPresetName (const char *name)
 Get / Set the name of the current preset in use. More...
 

Protected Member Functions

bool addActiveAnnotationsFromVisibleSources (bool force)
 Create annotations from visibles part of the active representation. More...
 

Detailed Description

pqColorAnnotationsWidget is used to edit annotations and colors

Definition at line 21 of file pqColorAnnotationsWidget.h.

Constructor & Destructor Documentation

◆ pqColorAnnotationsWidget()

pqColorAnnotationsWidget::pqColorAnnotationsWidget ( QWidget *  parent = nullptr)

◆ ~pqColorAnnotationsWidget()

pqColorAnnotationsWidget::~pqColorAnnotationsWidget ( )
override

Member Function Documentation

◆ setLookupTableProxy()

void pqColorAnnotationsWidget::setLookupTableProxy ( vtkSMProxy proxy)

◆ annotations()

QList<QVariant> pqColorAnnotationsWidget::annotations ( ) const

Get/Set the annotations.

This is a list generated by flattening 2-tuples where 1st value is the annotated value and second is the annotation text.

◆ setAnnotations()

void pqColorAnnotationsWidget::setAnnotations ( const QList< QVariant > &  )

Get/Set the annotations.

This is a list generated by flattening 2-tuples where 1st value is the annotated value and second is the annotation text.

◆ indexedColors()

QList<QVariant> pqColorAnnotationsWidget::indexedColors ( ) const

Get/Set the indexed colors.

This is a list generated by flattening 3-tuples (r,g,b).

◆ setIndexedColors()

void pqColorAnnotationsWidget::setIndexedColors ( const QList< QVariant > &  )

Get/Set the indexed colors.

This is a list generated by flattening 3-tuples (r,g,b).

◆ indexedOpacities()

QList<QVariant> pqColorAnnotationsWidget::indexedOpacities ( ) const

Get/Set the indexed opacities.

◆ setIndexedOpacities()

void pqColorAnnotationsWidget::setIndexedOpacities ( const QList< QVariant > &  )

Get/Set the indexed opacities.

◆ visibilities()

QList<QVariant> pqColorAnnotationsWidget::visibilities ( ) const

Get/Set the indexed visibilities.

◆ setVisibilities()

void pqColorAnnotationsWidget::setVisibilities ( const QList< QVariant > &  )

Get/Set the indexed visibilities.

◆ opacityMapping()

QVariant pqColorAnnotationsWidget::opacityMapping ( ) const

Get/Set the opacity mapping status.

◆ setOpacityMapping()

void pqColorAnnotationsWidget::setOpacityMapping ( const QVariant &  )

Get/Set the opacity mapping status.

◆ applyPreset()

void pqColorAnnotationsWidget::applyPreset ( const char *  presetName)

Apply a color preset using its name.

◆ indexedLookupStateUpdated()

void pqColorAnnotationsWidget::indexedLookupStateUpdated ( bool  indexed)

Ensures that the table for indexedColors are shown only when this is set to true.

◆ addActiveAnnotations() [1/2]

bool pqColorAnnotationsWidget::addActiveAnnotations ( bool  force)

Use active representation to create annotations.

This method grows the list of annotations. It is equivalent to calling pqColorAnnotationsWidget::addActiveAnnotations(force, true)

◆ addActiveAnnotations() [2/2]

bool pqColorAnnotationsWidget::addActiveAnnotations ( bool  force,
bool  extend 
)

Setting extend=true grows the list of annotations resulting in a union of previous annotations and annotations for the data range of the active source proxy.

◆ currentIndex()

QModelIndex pqColorAnnotationsWidget::currentIndex ( )

Return current model index from table.

Uses QSortFilterProxyModel if exists.

◆ selectedIndexes()

QModelIndexList pqColorAnnotationsWidget::selectedIndexes ( )

Return the selected indexes.

◆ setAnnotationsModel()

void pqColorAnnotationsWidget::setAnnotationsModel ( pqAnnotationsModel model)

Set the annotionModel on the underlying table.

◆ setSupportsReorder()

void pqColorAnnotationsWidget::setSupportsReorder ( bool  reorder)

Set reordering support on the table.

◆ sort()

void pqColorAnnotationsWidget::sort ( int  column,
Qt::SortOrder  order = Qt::AscendingOrder 
)

Sort the underlying proxy model.

◆ allowsUserDefinedValues()

void pqColorAnnotationsWidget::allowsUserDefinedValues ( bool  allow)

Show/Hide relevant widgets.

If allow is false, hide the buttons that add/remove lines.

◆ allowsRegexpMatching()

void pqColorAnnotationsWidget::allowsRegexpMatching ( bool  allow)

Setup ChooseColor dialog.

If allow is true, add a line edit to specify a regexp to do the matching between data values and preset. Intended to be used for series preset.

◆ enablePresets()

void pqColorAnnotationsWidget::enablePresets ( bool  enable)

Show/Hide relevant widgets.

If enable is false, hide the buttons that save / load presets.

◆ supportsVisibilityCheck()

void pqColorAnnotationsWidget::supportsVisibilityCheck ( bool  val)

Show/Hide the Visibility column.

◆ supportsOpacityMapping()

void pqColorAnnotationsWidget::supportsOpacityMapping ( bool  val)

Show/Hide the EnableOpacityMapping button.

◆ setColumnVisibility()

void pqColorAnnotationsWidget::setColumnVisibility ( pqAnnotationsModel::ColumnRoles  col,
bool  visible 
)

Show/Hide given column.

◆ currentPresetName()

const char* pqColorAnnotationsWidget::currentPresetName ( )

Get / Set the name of the current preset in use.

◆ setCurrentPresetName()

void pqColorAnnotationsWidget::setCurrentPresetName ( const char *  name)

Get / Set the name of the current preset in use.

◆ currentAnnotationValue()

QString pqColorAnnotationsWidget::currentAnnotationValue ( )

Get the current annotation value.

◆ selectedAnnotations()

QStringList pqColorAnnotationsWidget::selectedAnnotations ( )

Get the selected annotations values.

◆ setSelectedAnnotations()

void pqColorAnnotationsWidget::setSelectedAnnotations ( const QStringList &  annotations)

◆ presetLoadAnnotations()

bool pqColorAnnotationsWidget::presetLoadAnnotations ( )

Get if annotations should be loaded with the preset.

◆ presetRegularExpression()

QRegularExpression pqColorAnnotationsWidget::presetRegularExpression ( )

Get the regular expression to use to apply the preset.

◆ annotationsChanged

void pqColorAnnotationsWidget::annotationsChanged ( )
signal

Fired when the annotations are changed.

◆ indexedColorsChanged

void pqColorAnnotationsWidget::indexedColorsChanged ( )
signal

Fired when the indexed colors are changed.

◆ indexedOpacitiesChanged

void pqColorAnnotationsWidget::indexedOpacitiesChanged ( )
signal

Fired when the indexed opacities are changed.

◆ visibilitiesChanged

void pqColorAnnotationsWidget::visibilitiesChanged ( )
signal

Fired when the visibilities are changed.

◆ opacityMappingChanged

void pqColorAnnotationsWidget::opacityMappingChanged ( )
signal

Fired when the opacity mapping status is changed.

◆ presetChanged

void pqColorAnnotationsWidget::presetChanged ( const QString &  name)
signal

Fired when a new preset is applied.

◆ selectionChanged

void pqColorAnnotationsWidget::selectionChanged ( const QItemSelection &  ,
const QItemSelection &   
)
signal

Fired when the currently focused item changed.

◆ addActiveAnnotationsFromVisibleSources()

bool pqColorAnnotationsWidget::addActiveAnnotationsFromVisibleSources ( bool  force)
protected

Create annotations from visibles part of the active representation.


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