Public Slots | Public Member Functions | List of all members
pqMultiBlockInspectorWidget Class Reference

widget to show composite data hierarchy and control 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 setRepresentation (pqDataRepresentation *view)
 When auto-tracking is disabled, sets the representation to use. More...
 

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...
 
pqOutputPortoutputPort () const
 Get the current output port. More...
 
pqDataRepresentationrepresentation () const
 Get the current representation. More...
 

Detailed Description

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

pqMultiBlockInspectorWidget is a QWidget that allows the user to explore the hierarchical structure of from a composite dataset produced by a source. Optionally, it also supports viewing and changing appearance parameters associated with the hierarchy such as block visibility, block colors, and block opacity.

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 representation to use can be set using setOutputPort and setRepresentation.

See also
pqDataAssemblyTreeModel, pqDataAssemblyPropertyWidget

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 78 of file pqMultiBlockInspectorWidget.h.

◆ outputPort()

pqOutputPort* pqMultiBlockInspectorWidget::outputPort ( ) const

Get the current output port.

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

◆ 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.

◆ setRepresentation

void pqMultiBlockInspectorWidget::setRepresentation ( pqDataRepresentation view)
slot

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

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


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