Detailed Description

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

Any VTK point set object (i.e. vtkUnstructuredGrid- and vtkPolyDataAlgorithm-objects) are represented by a VtkVisPointSetItem to be assigned a mapper, an actor and its visualization properties (colour, scalar values, etc.).

See also: VtkVisPipelineItem

Definition at line 39 of file VtkVisPointSetItem.h.

#include <VtkVisPointSetItem.h>

Inheritance diagram for VtkVisPointSetItem:

[legend]

Collaboration diagram for VtkVisPointSetItem:

[legend]

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

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

	~VtkVisPointSetItem () override

QString	GetActiveAttribute () const override
	Gets the last selected attribute.

void	GetRangeForActiveAttribute (double range[2]) const
	Get the scalar range for the active attribute.

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

vtkAlgorithm *	transformFilter () const override

void	SetActiveAttribute (const QString &name) override
	Sets the selected attribute array for the visualisation of the data set.

void	setScale (double x, double y, double z) const override
	Scales the data in visualisation-space.

void	setTranslation (double x, double y, double z) const override
	Translates the item in visualisation-space.

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

Public Member Functions inherited from VtkVisPipelineItem
	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.

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.

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.

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

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
int	callVTKWriter (vtkAlgorithm *algorithm, const std::string &filename) const override
	Selects the appropriate VTK-Writer object and writes the object to a file with the given name.

void	SetScalarVisibility (bool on)

void	setVtkProperties (VtkAlgorithmProperties *vtkProps)
	Sets pre-set properties on vtkActor and on vtkMapper.

Protected Member Functions inherited from VtkVisPipelineItem

Protected Attributes
QVtkDataSetMapper *	_mapper

vtkTransformFilter *	_transformFilter

bool	_onPointData

std::string	_activeArrayName

Protected Attributes inherited from VtkVisPipelineItem
vtkProp3D *	_actor

vtkAlgorithm *	_algorithm

vtkRenderer *	_renderer

VtkCompositeFilter *	_compositeFilter

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

Private Member Functions
bool	activeAttributeExists (vtkDataSetAttributes *data, std::string &name)
	Checks if the selected attribute actually exists for the data set.

Constructor & Destructor Documentation

◆ VtkVisPointSetItem() [1/2]

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

Constructor for a source/filter object.

Definition at line 54 of file VtkVisPointSetItem.cpp.

    : VtkVisPipelineItem(algorithm, parentItem, data),
      _mapper(nullptr),
      _transformFilter(nullptr),
      _onPointData(true),
      _activeArrayName("")
{
    auto* visParentItem = dynamic_cast<VtkVisPipelineItem*>(parentItem);
    if (parentItem->parentItem())
    {
        // special case if parent is image but child is not (e.g.
        // Image2BarChartFilter)
        if (dynamic_cast<vtkImageAlgorithm*>(visParentItem->algorithm()))
        {
            _algorithm->SetInputConnection(
                visParentItem->algorithm()->GetOutputPort());
        }
        else
        {
            auto* pointSetItem = dynamic_cast<VtkVisPointSetItem*>(parentItem);
            if (pointSetItem)
            {
                _algorithm->SetInputConnection(
                    pointSetItem->transformFilter()->GetOutputPort());
            }
        }
    }
}

References TreeItem::parentItem().

◆ VtkVisPointSetItem() [2/2]

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

Constructor for composite filter.

Definition at line 85 of file VtkVisPointSetItem.cpp.

    : VtkVisPipelineItem(compositeFilter, parentItem, data),
      _mapper(nullptr),
      _transformFilter(nullptr),
      _onPointData(true),
      _activeArrayName("")
{
}

◆ ~VtkVisPointSetItem()

VtkVisPointSetItem::~VtkVisPointSetItem ( )

override

Definition at line 96 of file VtkVisPointSetItem.cpp.

{
    _transformFilter->Delete();
    _mapper->Delete();
}

References _mapper, and _transformFilter.

Member Function Documentation

◆ activeAttributeExists()

bool VtkVisPointSetItem::activeAttributeExists	(	vtkDataSetAttributes *	data,
		std::string &	name )

private

Checks if the selected attribute actually exists for the data set.

Definition at line 368 of file VtkVisPointSetItem.cpp.

{
    bool arrayFound = false;
    for (int i = 0; i < data->GetNumberOfArrays() && !arrayFound; i++)
    {
        std::string arrayName = data->GetArrayName(i);
        if (arrayName == name)
        {
            arrayFound = true;
        }
    }
    if (arrayFound)
    {
        // TODO Necessary? Currently this function is not called
        data->SetActiveAttribute(name.c_str(), vtkDataSetAttributes::SCALARS);
        return true;
    }
 
    return false;
}

References VtkVisPipelineItem::data().

◆ callVTKWriter()

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

overrideprotectedvirtual

Selects the appropriate VTK-Writer object and writes the object to a file with the given name.

Reimplemented from VtkVisPipelineItem.

Definition at line 250 of file VtkVisPointSetItem.cpp.

{
    std::string file_name_cpy(filename);
    auto* algPD = dynamic_cast<vtkPolyDataAlgorithm*>(algorithm);
    if (algPD)
    {
        vtkSmartPointer<vtkXMLPolyDataWriter> pdWriter =
            vtkSmartPointer<vtkXMLPolyDataWriter>::New();
        pdWriter->SetInputData(algPD->GetOutputDataObject(0));
        if (BaseLib::getFileExtension(filename) != ".vtp")
        {
            file_name_cpy.append(".vtp");
        }
        pdWriter->SetFileName(file_name_cpy.c_str());
        return pdWriter->Write();
    }
 
    auto* algUG = dynamic_cast<vtkUnstructuredGridAlgorithm*>(algorithm);
    if (algUG)
    {
        vtkSmartPointer<vtkXMLUnstructuredGridWriter> ugWriter =
            vtkSmartPointer<vtkXMLUnstructuredGridWriter>::New();
        ugWriter->SetInputData(algUG->GetOutputDataObject(0));
        if (BaseLib::getFileExtension(filename) != ".vtu")
        {
            file_name_cpy.append(".vtu");
        }
        ugWriter->SetFileName(file_name_cpy.c_str());
        return ugWriter->Write();
    }
 
    WARN("VtkVisPipelineItem::writeToFile(): Unknown data type.");
    return 0;
}

References VtkVisPipelineItem::algorithm(), BaseLib::getFileExtension(), and WARN().

◆ GetActiveAttribute()

QString VtkVisPointSetItem::GetActiveAttribute ( ) const

overridevirtual

Gets the last selected attribute.

Reimplemented from VtkVisPipelineItem.

Definition at line 101 of file VtkVisPointSetItem.cpp.

{
    return _vtkProps->GetActiveAttribute();
}

References VtkVisPipelineItem::_vtkProps, and VtkAlgorithmProperties::GetActiveAttribute().

◆ GetRangeForActiveAttribute()

void VtkVisPointSetItem::GetRangeForActiveAttribute ( double range[2] ) const

Get the scalar range for the active attribute.

Definition at line 430 of file VtkVisPointSetItem.cpp.

{
    vtkDataSet* dataSet =
        vtkDataSet::SafeDownCast(this->_algorithm->GetOutputDataObject(0));
    if (dataSet && _activeArrayName.length() > 0)
    {
        if (_onPointData)
        {
            vtkPointData* pointData = dataSet->GetPointData();
            if (pointData)
            {
                pointData->GetArray(_activeArrayName.c_str())->GetRange(range);
            }
        }
        else
        {
            vtkCellData* cellData = dataSet->GetCellData();
            cellData->GetArray(_activeArrayName.c_str())->GetRange(range);
        }
    }
}

References _activeArrayName, VtkVisPipelineItem::_algorithm, and _onPointData.

Referenced by Initialize(), and SetActiveAttribute().

◆ Initialize()

void VtkVisPointSetItem::Initialize ( vtkRenderer * renderer )

overridevirtual

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

Implements VtkVisPipelineItem.

Definition at line 106 of file VtkVisPointSetItem.cpp.

{
    // TODO vtkTransformFilter creates a new copy of the point coordinates which
    // conflicts with VtkMappedMeshSource. Find a workaround!
    _transformFilter = vtkTransformFilter::New();
    vtkSmartPointer<vtkTransform> transform =
        vtkSmartPointer<vtkTransform>::New();
    transform->Identity();
    _transformFilter->SetTransform(transform);
 
    _transformFilter->SetInputConnection(_algorithm->GetOutputPort());
    _transformFilter->Update();
 
    _renderer = renderer;
    _mapper = QVtkDataSetMapper::New();
    _mapper->InterpolateScalarsBeforeMappingOff();
    _mapper->SetColorModeToMapScalars();
 
    _mapper->SetInputConnection(_transformFilter->GetOutputPort());
    _actor = vtkActor::New();
    static_cast<vtkActor*>(_actor)->SetMapper(_mapper);
    _renderer->AddActor(_actor);
 
    // Determine the right pre-set properties
    // Order is: _algorithm, _compositeFilter, create a new one with props
    // copied from parent
    auto* vtkProps = dynamic_cast<VtkAlgorithmProperties*>(_algorithm);
    if (!vtkProps)
    {
        vtkProps = dynamic_cast<VtkAlgorithmProperties*>(_compositeFilter);
 
        // Copy properties from parent or create a new VtkAlgorithmProperties
        if (!vtkProps)
        {
            auto* parentItem =
                dynamic_cast<VtkVisPipelineItem*>(this->parentItem());
            while (parentItem)
            {
                VtkAlgorithmProperties* parentProps = nullptr;
                if (dynamic_cast<VtkVisPointSetItem*>(parentItem))
                {
                    parentProps = dynamic_cast<VtkVisPointSetItem*>(parentItem)
                                      ->getVtkProperties();
                }
                if (parentProps)
                {
                    vtkProps =
                        new VtkAlgorithmProperties();  // TODO memory leak?
                    vtkProps->SetScalarVisibility(
                        parentProps->GetScalarVisibility());
                    vtkProps->SetTexture(parentProps->GetTexture());
                    vtkProps->SetActiveAttribute(
                        parentProps->GetActiveAttribute());
                    parentItem = nullptr;
                }
                else
                {
                    parentItem = dynamic_cast<VtkVisPipelineItem*>(
                        parentItem->parentItem());
                }
            }
 
            // Has no parents
            if (!vtkProps)
            {
                vtkProps = new VtkAlgorithmProperties();  // TODO memory leak?
            }
        }
    }
    _vtkProps = vtkProps;
 
    if (vtkProps->GetActiveAttribute().length() == 0)
    {
        // Get first scalar and set it to active
        QStringList arrayNames = this->getScalarArrayNames();
        if (arrayNames.length() > 0)
        {
            vtkProps->SetActiveAttribute(arrayNames[0]);
        }
        else
        {
            vtkProps->SetActiveAttribute("Solid Color");
        }
    }
    this->setVtkProperties(vtkProps);
    this->SetActiveAttribute(vtkProps->GetActiveAttribute());
 
    // Set global backface culling
    QSettings settings;
    bool backfaceCulling = settings.value("globalCullBackfaces", 0).toBool();
    this->setBackfaceCulling(backfaceCulling);
 
    // Set the correct threshold range
    if (dynamic_cast<VtkCompositeThresholdFilter*>(this->_compositeFilter))
    {
        double range[2];
        this->GetRangeForActiveAttribute(range);
        QList<QVariant> thresholdRangeList;
        thresholdRangeList.push_back(range[0]);
        thresholdRangeList.push_back(range[1]);
        dynamic_cast<VtkCompositeFilter*>(this->_compositeFilter)
            ->SetUserVectorProperty("Range", thresholdRangeList);
    }
 
    // Show edges on meshes
    if (dynamic_cast<MeshLib::VtkMappedMeshSource*>(this->_algorithm))
    {
        _vtkProps->GetProperties()->SetEdgeVisibility(1);
    }
}

References VtkVisPipelineItem::_actor, VtkVisPipelineItem::_algorithm, VtkVisPipelineItem::_compositeFilter, _mapper, VtkVisPipelineItem::_renderer, _transformFilter, VtkVisPipelineItem::_vtkProps, VtkAlgorithmProperties::GetActiveAttribute(), VtkAlgorithmProperties::GetProperties(), GetRangeForActiveAttribute(), VtkVisPipelineItem::getScalarArrayNames(), VtkAlgorithmProperties::GetScalarVisibility(), VtkAlgorithmProperties::GetTexture(), VtkVisPipelineItem::getVtkProperties(), QVtkDataSetMapper::New(), TreeItem::parentItem(), SetActiveAttribute(), setBackfaceCulling(), and setVtkProperties().

◆ SetActiveAttribute()

void VtkVisPointSetItem::SetActiveAttribute ( const QString & name )

overridevirtual

Sets the selected attribute array for the visualisation of the data set.

Reimplemented from VtkVisPipelineItem.

Definition at line 286 of file VtkVisPointSetItem.cpp.

{
    // Get type by identifier
    if (name.contains(QRegExp("^P-")))
    {
        _onPointData = true;
    }
    else if (name.contains(QRegExp("^C-")))
    {
        _onPointData = false;
    }
    else if (name.contains("Solid Color"))
    {
        _vtkProps->SetActiveAttribute("Solid Color");
        _mapper->ScalarVisibilityOff();
        return;
    }
    else
    {
        return;
    }
 
    // Remove type identifier
    _activeArrayName = QString(name).remove(0, 2).toStdString();
 
    vtkDataSet* dataSet =
        vtkDataSet::SafeDownCast(this->_algorithm->GetOutputDataObject(0));
    if (!dataSet)
    {
        return;
    }
 
    double range[2];
    GetRangeForActiveAttribute(range);
    if (_onPointData)
    {
        vtkPointData* pointData = dataSet->GetPointData();
        if (pointData)
        {
            _algorithm->SetInputArrayToProcess(
                0, 0, 0, vtkDataObject::FIELD_ASSOCIATION_POINTS,
                _activeArrayName.c_str());
            _mapper->SetScalarModeToUsePointFieldData();
        }
    }
    else
    {
        vtkCellData* cellData = dataSet->GetCellData();
        if (cellData)
        {
            _algorithm->SetInputArrayToProcess(
                0, 0, 0, vtkDataObject::FIELD_ASSOCIATION_CELLS,
                _activeArrayName.c_str());
            _mapper->SetScalarModeToUseCellFieldData();
        }
    }
 
    _vtkProps->SetActiveAttribute(name);
 
    _mapper->ScalarVisibilityOn();
    _mapper->UseLookupTableScalarRangeOn();
 
    auto* mapper = dynamic_cast<QVtkDataSetMapper*>(_mapper);
    if (mapper)
    {
        // Create a default color table when there is no lookup table for this
        // attribute
        vtkLookupTable* lut = _vtkProps->GetLookupTable(name);
        if (lut == nullptr)
        {
            // std::cout << "Creating new lookup table for: " <<
            // name.toStdString() << std::endl;
            lut = vtkLookupTable::New();  // is not a memory leak, gets deleted
                                          // in VtkAlgorithmProperties
            lut->SetTableRange(range);
            _vtkProps->SetLookUpTable(name, lut);
        }
        _mapper->SetLookupTable(lut);
    }
    _mapper->SelectColorArray(_activeArrayName.c_str());
}

References _activeArrayName, VtkVisPipelineItem::_algorithm, _mapper, _onPointData, VtkVisPipelineItem::_vtkProps, VtkAlgorithmProperties::GetLookupTable(), GetRangeForActiveAttribute(), VtkAlgorithmProperties::SetActiveAttribute(), and VtkAlgorithmProperties::SetLookUpTable().

Referenced by Initialize().

◆ setBackfaceCulling()

void VtkVisPointSetItem::setBackfaceCulling ( bool enable ) const

overridevirtual

Enables / disables backface culling.

Reimplemented from VtkVisPipelineItem.

Definition at line 423 of file VtkVisPointSetItem.cpp.

{
    static_cast<vtkActor*>(this->_actor)
        ->GetProperty()
        ->SetBackfaceCulling(static_cast<int>(enable));
}

References VtkVisPipelineItem::_actor.

Referenced by Initialize().

◆ SetScalarVisibility()

void VtkVisPointSetItem::SetScalarVisibility ( bool on )

protected

Definition at line 217 of file VtkVisPointSetItem.cpp.

{
    _mapper->SetScalarVisibility(on);
}

References _mapper, and QVtkDataSetMapper::SetScalarVisibility().

Referenced by setVtkProperties().

◆ setScale()

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

overridevirtual

Scales the data in visualisation-space.

Reimplemented from VtkVisPipelineItem.

Definition at line 390 of file VtkVisPointSetItem.cpp.

{
    if (this->transformFilter())
    {
        auto* transform =
            static_cast<vtkTransform*>(this->_transformFilter->GetTransform());
        double* trans = transform->GetPosition();
        transform->Identity();
        transform->Scale(x, y, z);
        transform->Translate(trans[0] / x, trans[1] / y, trans[2] / z);
        this->transformFilter()->Modified();
    }
}

References _transformFilter, and transformFilter().

◆ setTranslation()

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

overridevirtual

Translates the item in visualisation-space.

Reimplemented from VtkVisPipelineItem.

Definition at line 404 of file VtkVisPointSetItem.cpp.

{
    if (this->transformFilter())
    {
        auto* transform =
            static_cast<vtkTransform*>(this->_transformFilter->GetTransform());
        double* scale = transform->GetScale();
        transform->Identity();
        transform->Scale(scale);
        transform->Translate(x, y, z);
        this->transformFilter()->Modified();
    }
}

References _transformFilter, and transformFilter().

◆ setVtkProperties()

void VtkVisPointSetItem::setVtkProperties ( VtkAlgorithmProperties * vtkProps )

protected

Sets pre-set properties on vtkActor and on vtkMapper.

Definition at line 222 of file VtkVisPointSetItem.cpp.

{
    QObject::connect(vtkProps, SIGNAL(ScalarVisibilityChanged(bool)), _mapper,
                     SLOT(SetScalarVisibility(bool)));
 
    auto* actor = dynamic_cast<vtkActor*>(_actor);
    if (actor)
    {
        if (vtkProps->GetTexture() != nullptr)
        {
            vtkProps->SetScalarVisibility(false);
            actor->GetProperty()->SetColor(1, 1, 1);  // don't colorise textures
            actor->SetTexture(vtkProps->GetTexture());
        }
        else
        {
            vtkSmartPointer<vtkProperty> itemProperty =
                vtkProps->GetProperties();
            actor->SetProperty(itemProperty);
        }
 
        if (!vtkProps->GetScalarVisibility())
        {
            vtkProps->SetScalarVisibility(false);
        }
    }
}

References VtkVisPipelineItem::_actor, _mapper, VtkVisPipelineItem::actor(), VtkAlgorithmProperties::GetProperties(), VtkAlgorithmProperties::GetScalarVisibility(), VtkAlgorithmProperties::GetTexture(), VtkAlgorithmProperties::SetScalarVisibility(), and SetScalarVisibility().

Referenced by Initialize().

◆ transformFilter()

vtkAlgorithm * VtkVisPointSetItem::transformFilter ( ) const

overridevirtual

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

Implements VtkVisPipelineItem.

Definition at line 418 of file VtkVisPointSetItem.cpp.

{
    return _transformFilter;
}

References _transformFilter.

Referenced by setScale(), and setTranslation().

Member Data Documentation

◆ _activeArrayName

std::string VtkVisPointSetItem::_activeArrayName

protected

Definition at line 82 of file VtkVisPointSetItem.h.

Referenced by GetRangeForActiveAttribute(), and SetActiveAttribute().

◆ _mapper

QVtkDataSetMapper* VtkVisPointSetItem::_mapper

protected

Definition at line 79 of file VtkVisPointSetItem.h.

Referenced by ~VtkVisPointSetItem(), Initialize(), SetActiveAttribute(), SetScalarVisibility(), and setVtkProperties().

◆ _onPointData

bool VtkVisPointSetItem::_onPointData

protected

Definition at line 81 of file VtkVisPointSetItem.h.

Referenced by GetRangeForActiveAttribute(), and SetActiveAttribute().

◆ _transformFilter

vtkTransformFilter* VtkVisPointSetItem::_transformFilter

protected

Definition at line 80 of file VtkVisPointSetItem.h.

Referenced by ~VtkVisPointSetItem(), Initialize(), setScale(), setTranslation(), and transformFilter().

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

Applications/DataExplorer/VtkVis/VtkVisPointSetItem.h
Applications/DataExplorer/VtkVis/VtkVisPointSetItem.cpp

Detailed Description

Public Member Functions

Protected Member Functions

Protected Attributes

Private Member Functions

Constructor & Destructor Documentation

◆ VtkVisPointSetItem() [1/2]

◆ VtkVisPointSetItem() [2/2]

◆ ~VtkVisPointSetItem()

Member Function Documentation

◆ activeAttributeExists()

◆ callVTKWriter()

◆ GetActiveAttribute()

◆ GetRangeForActiveAttribute()

◆ Initialize()

◆ SetActiveAttribute()

◆ setBackfaceCulling()

◆ SetScalarVisibility()

◆ setScale()

◆ setTranslation()

◆ setVtkProperties()

◆ transformFilter()

Member Data Documentation

◆ _activeArrayName

◆ _mapper

◆ _onPointData

◆ _transformFilter