widget to show composite data hierarchy and controls its display properties. More...

#include <pqMultiBlockInspectorWidget.h>

Inherits QWidget.

Public Slots
void	setOutputPort (pqOutputPort *port)
	When auto-tracking is disabled, sets the port to use to get the data information for this widget to show. More...

void	setView (pqView *view)
	When auto-tracking is disabled, sets the view to use. More...

Signals
void	blockVisibilitiesChanged ()

void	blockColorsChanged ()

void	blockOpacitiesChanged ()

void	requestRender ()

Public Member Functions
	pqMultiBlockInspectorWidget (QWidget *parent=nullptr, Qt::WindowFlags f=Qt::WindowFlags(), bool autotracking=true)

	~pqMultiBlockInspectorWidget () override

bool	isAutoTrackingEnabled () const
	Returns true if tracking of the active objects via pqActiveObjects is enabled. More...

pqOutputPort *	outputPort () const
	Get the current output port. More...

pqView *	view () const
	Get the current view. More...

pqDataRepresentation *	representation () const
	Get the current representation. More...


QList< QVariant >	blockVisibilities () const
	Get/Set block visibilities. More...

void	setBlockVisibilities (const QList< QVariant > &bvs)
	Get/Set block visibilities. More...


QList< QVariant >	visibleBlocks () const
	Get/Set the visible blocks. More...

void	setVisibleBlocks (const QList< QVariant > &vbs)
	Get/Set the visible blocks. More...


QList< QVariant >	blockColors () const
	Get/Set block colors. More...

void	setBlockColors (const QList< QVariant > &bcs)
	Get/Set block colors. More...


QList< QVariant >	blockOpacities () const
	Get/Set block opacities. More...

void	setBlockOpacities (const QList< QVariant > &bos)
	Get/Set block opacities. More...

Properties
QList< QVariant >	blockVisibilities

QList< QVariant >	blockColors

QList< QVariant >	blockOpacities

QList< QVariant >	visibleBlocks

Detailed Description

widget to show composite data hierarchy and controls its display properties.

pqMultiBlockInspectorWidget is a QWidget that is used to allow user to view a composite dataset hierarchy. It also supports viewing and modifying display properties for the composite dataset.

pqMultiBlockInspectorWidget monitors active pqActiveObjects to track active port and view by default. To not have the pqMultiBlockInspectorWidget track the active objects, you can pass autotracking as false to the constructor. In that case, the port and view to use can be set using setOutputPort and setView.

See also: pqCompositeDataInformationTreeModel

Definition at line 62 of file pqMultiBlockInspectorWidget.h.

Constructor & Destructor Documentation

◆ pqMultiBlockInspectorWidget()

pqMultiBlockInspectorWidget::pqMultiBlockInspectorWidget	(	QWidget *	parent = `nullptr`,
		Qt::WindowFlags	f = `Qt::WindowFlags()`,
		bool	autotracking = `true`
	)

◆ ~pqMultiBlockInspectorWidget()

pqMultiBlockInspectorWidget::~pqMultiBlockInspectorWidget ( )

override

Member Function Documentation

◆ isAutoTrackingEnabled()

bool pqMultiBlockInspectorWidget::isAutoTrackingEnabled ( ) const

inline

Returns true if tracking of the active objects via pqActiveObjects is enabled.

It can be disabled by passing appropriate argument to the constructor.

Definition at line 90 of file pqMultiBlockInspectorWidget.h.

◆ blockVisibilities()

QList<QVariant> pqMultiBlockInspectorWidget::blockVisibilities ( ) const

Get/Set block visibilities.

The value is a list of QVariants in pairs where 1st value is the block index and 2nd value is its visibility state.

◆ setBlockVisibilities()

void pqMultiBlockInspectorWidget::setBlockVisibilities ( const QList< QVariant > & bvs )

Get/Set block visibilities.

The value is a list of QVariants in pairs where 1st value is the block index and 2nd value is its visibility state.

◆ visibleBlocks()

QList<QVariant> pqMultiBlockInspectorWidget::visibleBlocks ( ) const

Get/Set the visible blocks.

Unlike blockVisibilities, this is compact list of visible blocks given the current hierarchy.

◆ setVisibleBlocks()

void pqMultiBlockInspectorWidget::setVisibleBlocks ( const QList< QVariant > & vbs )

Get/Set the visible blocks.

Unlike blockVisibilities, this is compact list of visible blocks given the current hierarchy.

◆ blockColors()

QList<QVariant> pqMultiBlockInspectorWidget::blockColors ( ) const

Get/Set block colors.

The value is a list of QVariants in 4-tuples where 1st value is the block color and the next 3 values are rgb color in each in range [0, 1.0].

◆ setBlockColors()

void pqMultiBlockInspectorWidget::setBlockColors ( const QList< QVariant > & bcs )

Get/Set block colors.

The value is a list of QVariants in 4-tuples where 1st value is the block color and the next 3 values are rgb color in each in range [0, 1.0].

◆ blockOpacities()

QList<QVariant> pqMultiBlockInspectorWidget::blockOpacities ( ) const

Get/Set block opacities.

The value is a list of QVariants in pairs where 1st value is the block color and the 2nd value is opacity in range [0, 1.0].

◆ setBlockOpacities()

void pqMultiBlockInspectorWidget::setBlockOpacities ( const QList< QVariant > & bos )

Get/Set block opacities.

The value is a list of QVariants in pairs where 1st value is the block color and the 2nd value is opacity in range [0, 1.0].

◆ outputPort()

pqOutputPort* pqMultiBlockInspectorWidget::outputPort ( ) const

Get the current output port.

The widget shows the composite tree for the data produced by at this port.

◆ view()

pqView* pqMultiBlockInspectorWidget::view ( ) const

Get the current view.

◆ representation()

pqDataRepresentation* pqMultiBlockInspectorWidget::representation ( ) const

Get the current representation.

◆ setOutputPort

void pqMultiBlockInspectorWidget::setOutputPort ( pqOutputPort * port )

slot

When auto-tracking is disabled, sets the port to use to get the data information for this widget to show.

Calling this method when auto-tracking is disabled will raise a debug message and has no effect.

◆ setView

void pqMultiBlockInspectorWidget::setView ( pqView * view )

slot

When auto-tracking is disabled, sets the view to use.

If outputPort has a representation is this view with block-coloring/opacity support, then controls for coloring/opacity will be presented to the user.

Calling this method when auto-tracking is disabled will raise a debug message and has no effect.

◆ blockVisibilitiesChanged

void pqMultiBlockInspectorWidget::blockVisibilitiesChanged ( )

signal

◆ blockColorsChanged

void pqMultiBlockInspectorWidget::blockColorsChanged ( )

signal

◆ blockOpacitiesChanged

void pqMultiBlockInspectorWidget::blockOpacitiesChanged ( )

signal

◆ requestRender

void pqMultiBlockInspectorWidget::requestRender ( )

signal

Property Documentation

◆ blockVisibilities

QList<QVariant> pqMultiBlockInspectorWidget::blockVisibilities

readwrite

Definition at line 68 of file pqMultiBlockInspectorWidget.h.

◆ blockColors

QList<QVariant> pqMultiBlockInspectorWidget::blockColors

readwrite

Definition at line 68 of file pqMultiBlockInspectorWidget.h.

◆ blockOpacities

QList<QVariant> pqMultiBlockInspectorWidget::blockOpacities

readwrite

Definition at line 71 of file pqMultiBlockInspectorWidget.h.

◆ visibleBlocks

QList<QVariant> pqMultiBlockInspectorWidget::visibleBlocks

readwrite

Definition at line 74 of file pqMultiBlockInspectorWidget.h.

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

/builds/gitlab-kitware-sciviz-ci/Qt/Components/pqMultiBlockInspectorWidget.h

Public Slots

Signals

Public Member Functions

Properties

Detailed Description

Constructor & Destructor Documentation

◆ pqMultiBlockInspectorWidget()

◆ ~pqMultiBlockInspectorWidget()

Member Function Documentation

◆ isAutoTrackingEnabled()

◆ blockVisibilities()

◆ setBlockVisibilities()

◆ visibleBlocks()

◆ setVisibleBlocks()

◆ blockColors()

◆ setBlockColors()

◆ blockOpacities()

◆ setBlockOpacities()

◆ outputPort()

◆ view()

◆ representation()

◆ setOutputPort

◆ setView

◆ blockVisibilitiesChanged

◆ blockColorsChanged

◆ blockOpacitiesChanged

◆ requestRender

Property Documentation

◆ blockVisibilities

◆ blockColors

◆ blockOpacities

◆ visibleBlocks