Detailed Description

An item in the VtkVisPipeline containing a graphic object to be visualized.

Any VTK-object (source-items, filter-items, etc.) need to be put into a VtkPipelineItem to be assigned a mapper, an actor and its visualization properties (colour, etc.).

Definition at line 42 of file VtkVisPipelineItem.h.

#include <VtkVisPipelineItem.h>

Inheritance diagram for VtkVisPipelineItem:

[legend]

Collaboration diagram for VtkVisPipelineItem:

[legend]

Public Member Functions
	VtkVisPipelineItem (vtkAlgorithm algorithm, TreeItem parentItem, const QList< QVariant > data=QList< QVariant >())
	Constructor for a source/filter object.

	VtkVisPipelineItem (VtkCompositeFilter compositeFilter, TreeItem parentItem, const QList< QVariant > data=QList< QVariant >())
	Constructor for composite filter.

	~VtkVisPipelineItem () override

VtkVisPipelineItem *	child (int row) const
	Returns a VtkVisPipelineItem.

virtual void	Initialize (vtkRenderer *renderer)=0
	Initializes vtkMapper and vtkActor necessary for visualization of the item and sets the item's properties.

QVariant	data (int column) const override

bool	setData (int column, const QVariant &value) override

vtkAlgorithm *	algorithm () const
	Returns the algorithm object.

vtkProp3D *	actor () const
	Returns the actor as vtkProp3D.

virtual QString	GetActiveAttribute () const

virtual void	SetActiveAttribute (const QString &str)

VtkCompositeFilter *	compositeFilter () const
	Returns the composite filter.

bool	isVisible () const
	Returns if the VTK object is visible in the visualization.

void	setVisible (bool visible)
	Sets the visibility of the VTK object in the visualization.

int	writeToFile (const std::string &filename) const
	Writes this algorithm's vtkDataSet (i.e. vtkPolyData or vtkUnstructuredGrid) to a vtk-file.

virtual void	setScale (double x, double y, double z) const
	Scales the data in visualisation-space. This function is empty and needs to be implemented by derived classes.

void	setScaleOnChildren (double x, double y, double z) const
	Sets the geometry and date scaling recursively on all children of this item.

virtual void	setTranslation (double x, double y, double z) const
	Translates the item in visualisation-space. This function is empty and needs to be implemented by derived classes.

virtual vtkAlgorithm *	transformFilter () const =0

virtual void	setBackfaceCulling (bool enable) const
	Enables / disables backface culling.

void	setBackfaceCullingOnChildren (bool enable) const
	Enables / disables backface culling on all children.

QStringList	getScalarArrayNames () const
	Returns a list of array names prefixed with P- or C- for point and cell data.

VtkAlgorithmProperties *	getVtkProperties () const
	Returns the VtkAlgorithmProperties.

Public Member Functions inherited from TreeItem
	TreeItem (QList< QVariant > data, TreeItem *parent)

virtual	~TreeItem ()

void	appendChild (TreeItem *item)

TreeItem *	child (int row) const

virtual int	childCount () const

virtual int	columnCount () const

int	row () const

TreeItem *	parentItem () const

bool	removeChildren (int position, int count)

Protected Member Functions
virtual int	callVTKWriter (vtkAlgorithm *algorithm, const std::string &filename) const

Protected Attributes
vtkProp3D *	_actor

vtkAlgorithm *	_algorithm

vtkRenderer *	_renderer

VtkCompositeFilter *	_compositeFilter

VtkAlgorithmProperties *	_vtkProps
	The active VtkAlgorithmProperties. From algorithm, compositeFilter, or copied from parent.

Constructor & Destructor Documentation

◆ VtkVisPipelineItem() [1/2]

VtkVisPipelineItem::VtkVisPipelineItem	(	vtkAlgorithm *	algorithm,
		TreeItem *	parentItem,
		const QList< QVariant >	data = QList<QVariant>() )

Constructor for a source/filter object.

Definition at line 38 of file VtkVisPipelineItem.cpp.

    : TreeItem(data, parentItem),
      _actor(nullptr),
      _algorithm(algorithm),
      _renderer(nullptr),
      _compositeFilter(nullptr),
      _vtkProps(nullptr)
{
    auto* visParentItem = dynamic_cast<VtkVisPipelineItem*>(parentItem);
    if (parentItem->parentItem())
    {
        _algorithm->SetInputConnection(
            visParentItem->algorithm()->GetOutputPort());
    }
}

References TreeItem::parentItem().

◆ VtkVisPipelineItem() [2/2]

VtkVisPipelineItem::VtkVisPipelineItem	(	VtkCompositeFilter *	compositeFilter,
		TreeItem *	parentItem,
		const QList< QVariant >	data = QList<QVariant>() )

Constructor for composite filter.

Definition at line 56 of file VtkVisPipelineItem.cpp.

    : TreeItem(data, parentItem),
      _actor(nullptr),
      _renderer(nullptr),
      _compositeFilter(compositeFilter),
      _vtkProps(nullptr)
{
    _algorithm = _compositeFilter->GetOutputAlgorithm();
}

References _algorithm, _compositeFilter, and VtkCompositeFilter::GetOutputAlgorithm().

◆ ~VtkVisPipelineItem()

VtkVisPipelineItem::~VtkVisPipelineItem ( )

override

Definition at line 68 of file VtkVisPipelineItem.cpp.

{
    _renderer->RemoveActor(_actor);
    _actor->Delete();
    delete _compositeFilter;
}

References _actor, _compositeFilter, and _renderer.

Member Function Documentation

◆ actor()

vtkProp3D * VtkVisPipelineItem::actor ( ) const

Returns the actor as vtkProp3D.

Definition at line 136 of file VtkVisPipelineItem.cpp.

{
    return _actor;
}

References _actor.

Referenced by VtkVisPipeline::addPipelineItem(), VtkVisTabWidget::on_diffuseColorPickerButton_colorPicked(), VtkVisTabWidget::on_edgeColorPickerButton_colorPicked(), VtkVisTabWidget::on_opacitySlider_sliderMoved(), VtkVisTabWidget::on_visibleEdgesCheckBox_stateChanged(), VtkVisTabWidget::setActiveItem(), and VtkVisPointSetItem::setVtkProperties().

◆ algorithm()

vtkAlgorithm * VtkVisPipelineItem::algorithm ( ) const

inline

Returns the algorithm object.

Definition at line 69 of file VtkVisPipelineItem.h.

69{ return _algorithm; }

References _algorithm.

Referenced by VtkAddFilterDialog::VtkAddFilterDialog(), VtkVisPipeline::addPipelineItem(), VtkVisImageItem::callVTKWriter(), callVTKWriter(), VtkVisPointSetItem::callVTKWriter(), VtkVisPipelineView::contextMenuEvent(), VtkVisPipelineView::convertVTKToOGSMesh(), getScalarArrayNames(), VtkVisPipeline::removeSourceItem(), VtkVisPipeline::removeSourceItem(), VtkVisPipeline::removeSourceItem(), VtkVisPipelineView::showImageToMeshConversionDialog(), and writeToFile().

◆ callVTKWriter()

int VtkVisPipelineItem::callVTKWriter	(	vtkAlgorithm *	algorithm,
		const std::string &	filename ) const

protectedvirtual

Selects the appropriate VTK-Writer object and writes the object to a file with the given name. This function is empty and needs to be implemented by derived classes.

Reimplemented in VtkVisImageItem, and VtkVisPointSetItem.

Definition at line 127 of file VtkVisPipelineItem.cpp.

{
    // needs to be implemented in derived classes!
    (void)algorithm;
    (void)filename;
    return 0;
}

References algorithm().

Referenced by writeToFile().

◆ child()

VtkVisPipelineItem * VtkVisPipelineItem::child ( int row ) const

Returns a VtkVisPipelineItem.

Definition at line 75 of file VtkVisPipelineItem.cpp.

{
    TreeItem* treeItem = TreeItem::child(row);
    if (treeItem)
    {
        return dynamic_cast<VtkVisPipelineItem*>(treeItem);
    }
 
    return nullptr;
}

References TreeItem::child(), and TreeItem::row().

Referenced by VtkVisTabWidget::on_scaleZ_textChanged(), setBackfaceCullingOnChildren(), and setScaleOnChildren().

◆ compositeFilter()

VtkCompositeFilter * VtkVisPipelineItem::compositeFilter ( ) const

inline

Returns the composite filter.

Definition at line 81 of file VtkVisPipelineItem.h.

81{ return _compositeFilter; }

References _compositeFilter.

Referenced by VtkVisTabWidget::buildProportiesDialog(), and VtkVisTabWidget::on_scaleZ_textChanged().

◆ data()

QVariant VtkVisPipelineItem::data ( int column ) const

overridevirtual

Returns the data from all the columns.

Reimplemented from TreeItem.

Definition at line 86 of file VtkVisPipelineItem.cpp.

{
    if (column == 1)
    {
        return isVisible();
    }
 
    return TreeItem::data(column);
}

References TreeItem::data(), and isVisible().

Referenced by VtkVisPointSetItem::activeAttributeExists(), VtkVisPipelineView::convertVTKToOGSMesh(), and VtkVisImageItem::writeAsRaster().

◆ GetActiveAttribute()

virtual QString VtkVisPipelineItem::GetActiveAttribute ( ) const

inlinevirtual

Reimplemented in VtkVisPointSetItem.

Definition at line 75 of file VtkVisPipelineItem.h.

75{ return QString(""); }

Referenced by VtkVisPipelineView::addColorTable(), VtkVisTabWidget::buildScalarArrayComboBox(), and VtkVisTabWidget::setActiveItem().

◆ getScalarArrayNames()

QStringList VtkVisPipelineItem::getScalarArrayNames ( ) const

Returns a list of array names prefixed with P- or C- for point and cell data.

Definition at line 178 of file VtkVisPipelineItem.cpp.

{
    this->algorithm()->Update();
    vtkDataSet* dataSet =
        vtkDataSet::SafeDownCast(this->algorithm()->GetOutputDataObject(0));
    QStringList dataSetAttributesList;
    if (dataSet)
    {
        vtkPointData* pointData = dataSet->GetPointData();
        // std::cout << "  #point data arrays: " <<
        // pointData->GetNumberOfArrays() << std::endl;
        for (int i = 0; i < pointData->GetNumberOfArrays(); i++)
        {
            // std::cout << "    Name: " << pointData->GetArrayName(i) <<
            // std::endl;
            dataSetAttributesList.push_back(QString("P-") +
                                            pointData->GetArrayName(i));
        }
 
        vtkCellData* cellData = dataSet->GetCellData();
        // std::cout << "  #cell data arrays: " << cellData->GetNumberOfArrays()
        // << std::endl;
        for (int i = 0; i < cellData->GetNumberOfArrays(); i++)
        {
            // std::cout << "    Name: " << cellData->GetArrayName(i) <<
            // std::endl;
            dataSetAttributesList.push_back(QString("C-") +
                                            cellData->GetArrayName(i));
        }
    }
    return dataSetAttributesList;
}

References algorithm().

Referenced by VtkVisTabWidget::buildScalarArrayComboBox(), and VtkVisPointSetItem::Initialize().

◆ getVtkProperties()

VtkAlgorithmProperties * VtkVisPipelineItem::getVtkProperties ( ) const

inline

Returns the VtkAlgorithmProperties.

Definition at line 126 of file VtkVisPipelineItem.h.

126{ return _vtkProps; };

References _vtkProps.

Referenced by VtkVisTabWidget::buildProportiesDialog(), VtkVisPipelineView::contextMenuEvent(), VtkVisPointSetItem::Initialize(), and VtkVisTabWidget::on_arrayResetPushButton_clicked().

◆ Initialize()

virtual void VtkVisPipelineItem::Initialize ( vtkRenderer * renderer )

pure virtual

Initializes vtkMapper and vtkActor necessary for visualization of the item and sets the item's properties.

Implemented in VtkVisImageItem, and VtkVisPointSetItem.

Referenced by VtkVisPipeline::addPipelineItem().

◆ isVisible()

bool VtkVisPipelineItem::isVisible ( ) const

Returns if the VTK object is visible in the visualization.

Definition at line 106 of file VtkVisPipelineItem.cpp.

{
    return static_cast<bool>(_actor->GetVisibility());
}

References _actor.

Referenced by data().

◆ SetActiveAttribute()

virtual void VtkVisPipelineItem::SetActiveAttribute ( const QString & str )

inlinevirtual

Reimplemented in VtkVisPointSetItem.

Definition at line 78 of file VtkVisPipelineItem.h.

78{ (void)str; }

Referenced by VtkVisPipelineView::addColorTable(), VtkVisTabWidget::buildScalarArrayComboBox(), VtkVisImageItem::Initialize(), VtkVisTabWidget::on_arrayResetPushButton_clicked(), and VtkVisTabWidget::SetActiveAttributeOnItem().

◆ setBackfaceCulling()

void VtkVisPipelineItem::setBackfaceCulling ( bool enable ) const

virtual

Enables / disables backface culling.

Reimplemented in VtkVisPointSetItem.

Definition at line 162 of file VtkVisPipelineItem.cpp.

{
    // Reimplemented in subclass
    (void)enable;
}

Referenced by setBackfaceCullingOnChildren(), and VtkVisPipeline::setGlobalBackfaceCulling().

◆ setBackfaceCullingOnChildren()

void VtkVisPipelineItem::setBackfaceCullingOnChildren ( bool enable ) const

Enables / disables backface culling on all children.

Definition at line 168 of file VtkVisPipelineItem.cpp.

{
    for (int i = 0; i < this->childCount(); ++i)
    {
        VtkVisPipelineItem* child = this->child(i);
        child->setBackfaceCulling(static_cast<int>(enable));
        child->setBackfaceCullingOnChildren(static_cast<int>(enable));
    }
}

References child(), TreeItem::childCount(), setBackfaceCulling(), and setBackfaceCullingOnChildren().

Referenced by setBackfaceCullingOnChildren().

◆ setData()

bool VtkVisPipelineItem::setData	(	int	column,
		const QVariant &	value )

overridevirtual

Sets the data at a given column.

Reimplemented from TreeItem.

Definition at line 96 of file VtkVisPipelineItem.cpp.

{
    if (column == 1)
    {
        setVisible(value.toBool());
        return true;
    }
 
    return TreeItem::setData(column, value);
}

References TreeItem::setData(), and setVisible().

◆ setScale()

void VtkVisPipelineItem::setScale	(	double	x,
		double	y,
		double	z ) const

virtual

Scales the data in visualisation-space. This function is empty and needs to be implemented by derived classes.

Reimplemented in VtkVisPointSetItem.

Definition at line 141 of file VtkVisPipelineItem.cpp.

{
    (void)x;
    (void)y, (void)z;
}

Referenced by VtkVisPipeline::addPipelineItem(), VtkVisTabWidget::on_scaleZ_textChanged(), VtkVisPipeline::setGlobalSuperelevation(), and setScaleOnChildren().

◆ setScaleOnChildren()

void VtkVisPipelineItem::setScaleOnChildren	(	double	x,
		double	y,
		double	z ) const

Sets the geometry and date scaling recursively on all children of this item.

Definition at line 153 of file VtkVisPipelineItem.cpp.

{
    for (int i = 0; i < this->childCount(); ++i)
    {
        VtkVisPipelineItem* child = this->child(i);
        child->setScale(x, y, z);
    }
}

References child(), TreeItem::childCount(), and setScale().

◆ setTranslation()

void VtkVisPipelineItem::setTranslation	(	double	x,
		double	y,
		double	z ) const

virtual

Translates the item in visualisation-space. This function is empty and needs to be implemented by derived classes.

Reimplemented in VtkVisImageItem, and VtkVisPointSetItem.

Definition at line 147 of file VtkVisPipelineItem.cpp.

{
    (void)x;
    (void)y, (void)z;
}

Referenced by VtkVisTabWidget::translateItem().

◆ setVisible()

void VtkVisPipelineItem::setVisible ( bool visible )

Sets the visibility of the VTK object in the visualization.

Definition at line 111 of file VtkVisPipelineItem.cpp.

{
    _actor->SetVisibility(static_cast<int>(visible));
    _actor->Modified();
    _renderer->Render();
}

References _actor, and _renderer.

Referenced by setData().

◆ transformFilter()

virtual vtkAlgorithm * VtkVisPipelineItem::transformFilter ( ) const

pure virtual

Returns the transform filter for the object. This function needs to be implemented by derived classes.

Implemented in VtkVisImageItem, and VtkVisPointSetItem.

Referenced by VtkVisTabWidget::setActiveItem().

◆ writeToFile()

int VtkVisPipelineItem::writeToFile ( const std::string & filename ) const

Writes this algorithm's vtkDataSet (i.e. vtkPolyData or vtkUnstructuredGrid) to a vtk-file.

Definition at line 118 of file VtkVisPipelineItem.cpp.

{
    if (!filename.empty())
    {
        return callVTKWriter(this->algorithm(), filename);
    }
    return 0;
}

References algorithm(), and callVTKWriter().

Referenced by VtkVisPipelineView::exportSelectedPipelineItemAsVtk(), and MainWindow::on_actionExportVTK_triggered().

Member Data Documentation

◆ _actor

vtkProp3D* VtkVisPipelineItem::_actor

protected

Definition at line 129 of file VtkVisPipelineItem.h.

Referenced by ~VtkVisPipelineItem(), actor(), VtkVisImageItem::Initialize(), VtkVisPointSetItem::Initialize(), isVisible(), VtkVisPointSetItem::setBackfaceCulling(), setVisible(), and VtkVisPointSetItem::setVtkProperties().

◆ _algorithm

vtkAlgorithm* VtkVisPipelineItem::_algorithm

protected

Definition at line 130 of file VtkVisPipelineItem.h.

Referenced by VtkVisPipelineItem(), algorithm(), VtkVisPointSetItem::GetRangeForActiveAttribute(), VtkVisImageItem::Initialize(), VtkVisPointSetItem::Initialize(), VtkVisPointSetItem::SetActiveAttribute(), and VtkVisImageItem::writeAsRaster().

◆ _compositeFilter

VtkCompositeFilter* VtkVisPipelineItem::_compositeFilter

protected

Definition at line 132 of file VtkVisPipelineItem.h.

Referenced by VtkVisPipelineItem(), ~VtkVisPipelineItem(), compositeFilter(), and VtkVisPointSetItem::Initialize().

◆ _renderer

vtkRenderer* VtkVisPipelineItem::_renderer

protected

Definition at line 131 of file VtkVisPipelineItem.h.

Referenced by ~VtkVisPipelineItem(), VtkVisImageItem::Initialize(), VtkVisPointSetItem::Initialize(), and setVisible().

◆ _vtkProps

VtkAlgorithmProperties* VtkVisPipelineItem::_vtkProps

protected

The active VtkAlgorithmProperties. From algorithm, compositeFilter, or copied from parent.

Definition at line 136 of file VtkVisPipelineItem.h.

Referenced by VtkVisPointSetItem::GetActiveAttribute(), getVtkProperties(), VtkVisPointSetItem::Initialize(), and VtkVisPointSetItem::SetActiveAttribute().

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

Applications/DataExplorer/VtkVis/VtkVisPipelineItem.h
Applications/DataExplorer/VtkVis/VtkVisPipelineItem.cpp

Detailed Description

Public Member Functions

Protected Member Functions

Protected Attributes

Constructor & Destructor Documentation

◆ VtkVisPipelineItem() [1/2]

◆ VtkVisPipelineItem() [2/2]

◆ ~VtkVisPipelineItem()

Member Function Documentation

◆ actor()

◆ algorithm()

◆ callVTKWriter()

◆ child()

◆ compositeFilter()

◆ data()

◆ GetActiveAttribute()

◆ getScalarArrayNames()

◆ getVtkProperties()

◆ Initialize()

◆ isVisible()

◆ SetActiveAttribute()

◆ setBackfaceCulling()

◆ setBackfaceCullingOnChildren()

◆ setData()

◆ setScale()

◆ setScaleOnChildren()

◆ setTranslation()

◆ setVisible()

◆ transformFilter()

◆ writeToFile()

Member Data Documentation

◆ _actor

◆ _algorithm

◆ _compositeFilter

◆ _renderer

◆ _vtkProps