VtkAlgorithmProperties Class Reference

Detailed Description

Contains properties for the visualization of objects as VtkVisPipelineItems.

Definition at line 137 of file VtkAlgorithmProperties.h.

#include <VtkAlgorithmProperties.h>

Inheritance diagram for VtkAlgorithmProperties:

Collaboration diagram for VtkAlgorithmProperties:

Signals
void	ScalarVisibilityChanged (bool on)

Public Member Functions
	VtkAlgorithmProperties (QObject *parent=nullptr)
	Constructor (sets default values)
	~VtkAlgorithmProperties () override
vtkProperty *	GetProperties () const
	Returns the vtk properties.
vtkTexture *	GetTexture ()
	Returns a texture (if one has been assigned).
void	SetTexture (vtkTexture *t)
	Sets a texture for the VtkVisPipelineItem.
vtkLookupTable *	GetLookupTable (const QString &array_name)
	Returns the colour lookup table (if one has been assigned).
void	RemoveLookupTable (const QString &array_name)
	Removes the lookup table for the given scalar.
void	SetLookUpTable (const QString &array_name, vtkLookupTable *lut)
	Sets a colour lookup table for the given scalar array of the VtkVisPipelineItem.
void	SetLookUpTable (const QString &array_name, const QString &filename)
	Loads a predefined color lookup table from a file for the specified scalar array.
bool	GetScalarVisibility () const
	Returns the scalar visibility.
void	SetScalarVisibility (bool on)
	Sets the scalar visibility.
QString	GetName () const
	Returns the name. This is set to the file path if it is a source algorithm.
void	SetName (QString name)
	Sets the name.
bool	IsRemovable () const
	Is this algorithm removable from the pipeline (view).
QMap< QString, QVariant > *	GetAlgorithmUserProperties () const
	Returns a map of user properties.
QMap< QString, QList< QVariant > > *	GetAlgorithmUserVectorProperties () const
	Returns a map of vector user properties.
virtual void	SetUserProperty (QString name, QVariant value)
	Sets a user property. This should be implemented by subclasses.
QVariant	GetUserProperty (QString name) const
	Returns the value of a user property.
virtual void	SetUserVectorProperty (QString name, QList< QVariant > values)
	Sets a vector user property. This should be implemented by subclasses.
QList< QVariant >	GetUserVectorProperty (QString name) const
	Returns a list of values of a vector user property.
void	SetActiveAttribute (QString name)
	Set the active attribute.
QString	GetActiveAttribute () const
	Returns the desired active attribute.

Protected Attributes
vtkProperty *	_property
vtkTexture *	_texture
bool	_scalarVisibility
std::map< QString, vtkLookupTable * >	_lut
QString	_name
QString	_activeAttributeName
bool	_removable
QMap< QString, QVariant > *	_algorithmUserProperties
QMap< QString, QList< QVariant > > *	_algorithmUserVectorProperties

Constructor & Destructor Documentation

VtkAlgorithmProperties()

VtkAlgorithmProperties::VtkAlgorithmProperties ( QObject * parent = nullptr )

explicit

Constructor (sets default values)

Definition at line 26 of file VtkAlgorithmProperties.cpp.

    : QObject(parent)
{
    _property = vtkProperty::New();
    _texture = nullptr;
    _scalarVisibility = true;
    _algorithmUserProperties = new QMap<QString, QVariant>;
    _algorithmUserVectorProperties = new QMap<QString, QList<QVariant>>;
    _activeAttributeName = "";
    _removable = true;
}

References _activeAttributeName, _algorithmUserProperties, _algorithmUserVectorProperties, _property, _removable, _scalarVisibility, and _texture.

~VtkAlgorithmProperties()

VtkAlgorithmProperties::~VtkAlgorithmProperties ( )

override

Definition at line 38 of file VtkAlgorithmProperties.cpp.

{
    _property->Delete();
    if (_texture != nullptr)
    {
        _texture->Delete();
    }
 
    for (auto& row : _lut)
    {
        row.second->Delete();
    }
    delete _algorithmUserProperties;
    delete _algorithmUserVectorProperties;
}

References _algorithmUserProperties, _algorithmUserVectorProperties, _lut, _property, and _texture.

Member Function Documentation

GetActiveAttribute()

QString VtkAlgorithmProperties::GetActiveAttribute ( ) const

inline

Returns the desired active attribute.

Definition at line 215 of file VtkAlgorithmProperties.h.

{ return _activeAttributeName; }

References _activeAttributeName.

Referenced by VtkVisPointSetItem::GetActiveAttribute(), VtkCompositeColorByHeightFilter::init(), and VtkVisPointSetItem::Initialize().

GetAlgorithmUserProperties()

QMap< QString, QVariant > * VtkAlgorithmProperties::GetAlgorithmUserProperties ( ) const

inline

Returns a map of user properties.

Definition at line 184 of file VtkAlgorithmProperties.h.

                                                                {
        return _algorithmUserProperties;
    }

References _algorithmUserProperties.

Referenced by VtkVisTabWidget::buildProportiesDialog().

GetAlgorithmUserVectorProperties()

QMap< QString, QList< QVariant > > * VtkAlgorithmProperties::GetAlgorithmUserVectorProperties ( ) const

inline

Returns a map of vector user properties.

Definition at line 189 of file VtkAlgorithmProperties.h.

                                                                              {
        return _algorithmUserVectorProperties;
    }

References _algorithmUserVectorProperties.

Referenced by VtkVisTabWidget::buildProportiesDialog().

GetLookupTable()

vtkLookupTable * VtkAlgorithmProperties::GetLookupTable

(

const QString &

array_name

)

Returns the colour lookup table (if one has been assigned).

Definition at line 54 of file VtkAlgorithmProperties.cpp.

{
    auto it = _lut.find(array_name);
    if (it != _lut.end())
    {
        return it->second;
    }
 
    return nullptr;
}

References _lut.

Referenced by VtkVisPointSetItem::SetActiveAttribute(), VtkCompositeImageToCylindersFilter::SetUserProperty(), and VtkCompositeImageToCylindersFilter::SetUserVectorProperty().

GetName()

QString VtkAlgorithmProperties::GetName ( ) const

inline

Returns the name. This is set to the file path if it is a source algorithm.

Definition at line 175 of file VtkAlgorithmProperties.h.

{ return _name; }

References _name.

GetProperties()

vtkProperty * VtkAlgorithmProperties::GetProperties ( ) const

inline

Returns the vtk properties.

Definition at line 148 of file VtkAlgorithmProperties.h.

{ return _property; }

References _property.

Referenced by VtkPointsSource::VtkPointsSource(), VtkPolylinesSource::VtkPolylinesSource(), VtkStationSource::VtkStationSource(), VtkSurfacesSource::VtkSurfacesSource(), VtkVisPointSetItem::Initialize(), and VtkVisPointSetItem::setVtkProperties().

GetScalarVisibility()

bool VtkAlgorithmProperties::GetScalarVisibility ( ) const

inline

Returns the scalar visibility.

Definition at line 169 of file VtkAlgorithmProperties.h.

{ return _scalarVisibility; }

References _scalarVisibility.

Referenced by VtkVisPointSetItem::Initialize(), and VtkVisPointSetItem::setVtkProperties().

GetTexture()

vtkTexture * VtkAlgorithmProperties::GetTexture ( )

inline

Returns a texture (if one has been assigned).

Definition at line 151 of file VtkAlgorithmProperties.h.

{ return _texture; }

References _texture.

Referenced by VtkVisPointSetItem::Initialize(), VtkTextureOnSurfaceFilter::RequestData(), and VtkVisPointSetItem::setVtkProperties().

GetUserProperty()

QVariant VtkAlgorithmProperties::GetUserProperty

(

QString

name

)

const

Returns the value of a user property.

Definition at line 109 of file VtkAlgorithmProperties.cpp.

{
    if (this->_algorithmUserProperties->contains(name))
    {
        return this->_algorithmUserProperties->value(name);
    }
 
    ERR("Not a valid property: {:s}", name.toStdString());
    return QVariant();
}

References _algorithmUserProperties, and ERR().

Referenced by VtkCompositeImageToPointCloudFilter::SetUserProperty(), and VtkCompositeContourFilter::SetUserVectorProperty().

GetUserVectorProperty()

QList< QVariant > VtkAlgorithmProperties::GetUserVectorProperty

(

QString

name

)

const

Returns a list of values of a vector user property.

Definition at line 120 of file VtkAlgorithmProperties.cpp.

{
    if (this->_algorithmUserVectorProperties->contains(name))
    {
        return this->_algorithmUserVectorProperties->value(name);
    }
 
    ERR("Not a valid property: {:s}", name.toStdString());
    return QList<QVariant>();
}

References _algorithmUserVectorProperties, and ERR().

IsRemovable()

bool VtkAlgorithmProperties::IsRemovable ( ) const

inline

Is this algorithm removable from the pipeline (view).

Definition at line 181 of file VtkAlgorithmProperties.h.

{ return _removable; }

References _removable.

Referenced by VtkVisPipelineView::contextMenuEvent().

RemoveLookupTable()

void VtkAlgorithmProperties::RemoveLookupTable

(

const QString &

array_name

)

Removes the lookup table for the given scalar.

Definition at line 66 of file VtkAlgorithmProperties.cpp.

{
    auto it = _lut.find(array_name);
    if (it != _lut.end())
    {
        it->second->Delete();
        _lut.erase(it);
    }
}

References _lut.

Referenced by VtkVisTabWidget::on_arrayResetPushButton_clicked(), and SetLookUpTable().

ScalarVisibilityChanged

void VtkAlgorithmProperties::ScalarVisibilityChanged ( bool on )

signal

Referenced by SetScalarVisibility().

SetActiveAttribute()

void VtkAlgorithmProperties::SetActiveAttribute

(

QString

name

)

Set the active attribute.

Definition at line 132 of file VtkAlgorithmProperties.cpp.

{
    if (name.contains("Solid Color") || name.contains("P-TextureCoordinates"))
    {
        SetScalarVisibility(false);
    }
    else
    {
        SetScalarVisibility(true);
    }
    _activeAttributeName = name;
}

References _activeAttributeName, and SetScalarVisibility().

Referenced by VtkVisPointSetItem::SetActiveAttribute().

SetLookUpTable() [1/2]

void VtkAlgorithmProperties::SetLookUpTable	(	const QString &	array_name,
		const QString &	filename )

Loads a predefined color lookup table from a file for the specified scalar array.

Definition at line 89 of file VtkAlgorithmProperties.cpp.

{
    DataHolderLib::ColorLookupTable lut;
    if (FileIO::XmlLutReader::readFromFile(filename, lut))
    {
        VtkColorLookupTable* colorLookupTable = VtkColorLookupTable::New();
        colorLookupTable->setLookupTable(lut);
        SetLookUpTable(array_name, colorLookupTable);
    }
    else
        ERR("Error reading color look-up table.");
}

References ERR(), VtkColorLookupTable::New(), FileIO::XmlLutReader::readFromFile(), SetLookUpTable(), and VtkColorLookupTable::setLookupTable().

SetLookUpTable() [2/2]

void VtkAlgorithmProperties::SetLookUpTable	(	const QString &	array_name,
		vtkLookupTable *	lut )

Sets a colour lookup table for the given scalar array of the VtkVisPipelineItem.

Definition at line 76 of file VtkAlgorithmProperties.cpp.

{
    lut->Build();
 
    if (array_name.length() > 0)
    {
        this->RemoveLookupTable(array_name);
        _lut.insert(std::pair<QString, vtkLookupTable*>(array_name, lut));
        _activeAttributeName = array_name;
    }
}

References _activeAttributeName, _lut, and RemoveLookupTable().

Referenced by VtkVisPipelineView::addColorTable(), VtkCompositeColorByHeightFilter::init(), VtkCompositeElementSelectionFilter::init(), VtkCompositeImageToCylindersFilter::init(), VtkVisPointSetItem::SetActiveAttribute(), and SetLookUpTable().

SetName()

void VtkAlgorithmProperties::SetName ( QString name )

inline

Sets the name.

Definition at line 178 of file VtkAlgorithmProperties.h.

{ _name = name; }

References _name.

Referenced by MainWindow::loadFile(), and VtkGeoImageSource::setImage().

SetScalarVisibility()

void VtkAlgorithmProperties::SetScalarVisibility

(

bool

on

)

Sets the scalar visibility.

Definition at line 103 of file VtkAlgorithmProperties.cpp.

{
    _scalarVisibility = on;
    emit ScalarVisibilityChanged(on);
}

References _scalarVisibility, and ScalarVisibilityChanged().

Referenced by SetActiveAttribute(), and VtkVisPointSetItem::setVtkProperties().

SetTexture()

void VtkAlgorithmProperties::SetTexture ( vtkTexture * t )

inline

Sets a texture for the VtkVisPipelineItem.

Definition at line 154 of file VtkAlgorithmProperties.h.

{ _texture = t; }

References _texture.

Referenced by VtkBGImageSource::SetRaster(), and VtkTextureOnSurfaceFilter::SetRaster().

SetUserProperty()

virtual void VtkAlgorithmProperties::SetUserProperty ( QString name, QVariant value )

inlinevirtual

Sets a user property. This should be implemented by subclasses.

Reimplemented in VtkAppendArrayFilter, VtkBGImageSource, VtkColorByHeightFilter, VtkCompositeColorByHeightFilter, VtkCompositeColormapToImageFilter, VtkCompositeContourFilter, VtkCompositeGeoObjectFilter, VtkCompositeImageToCylindersFilter, VtkCompositeImageToPointCloudFilter, VtkCompositeImageToSurfacePointsFilter, VtkCompositeLineToTubeFilter, VtkCompositePointToGlyphFilter, VtkCompositeTextureOnSurfaceFilter, VtkCompositeThresholdFilter, VtkGeoImageSource, VtkImageDataToLinePolyDataFilter, VtkPointsSource, VtkPolylinesSource, VtkStationSource, VtkSurfacesSource, and VtkTextureOnSurfaceFilter.

Definition at line 194 of file VtkAlgorithmProperties.h.

    {
        (*_algorithmUserProperties)[name] = value;
    }

Referenced by VtkCompositeGeoObjectFilter::init(), VtkAlgorithmPropertyCheckbox::setNewValue(), VtkAlgorithmPropertyLineEdit::setNewValue(), VtkBGImageSource::SetUserProperty(), VtkCompositeColormapToImageFilter::SetUserProperty(), VtkCompositeContourFilter::SetUserProperty(), VtkCompositeImageToCylindersFilter::SetUserProperty(), VtkCompositeImageToPointCloudFilter::SetUserProperty(), VtkCompositeImageToSurfacePointsFilter::SetUserProperty(), VtkCompositeLineToTubeFilter::SetUserProperty(), VtkCompositePointToGlyphFilter::SetUserProperty(), VtkCompositeTextureOnSurfaceFilter::SetUserProperty(), VtkCompositeThresholdFilter::SetUserProperty(), VtkSurfacesSource::SetUserProperty(), and VtkTextureOnSurfaceFilter::SetUserProperty().

SetUserVectorProperty()

virtual void VtkAlgorithmProperties::SetUserVectorProperty ( QString name, QList< QVariant > values )

inlinevirtual

Sets a vector user property. This should be implemented by subclasses.

Reimplemented in VtkCompositeColormapToImageFilter, VtkCompositeContourFilter, VtkCompositeElementSelectionFilter, VtkCompositeImageToCylindersFilter, VtkCompositeImageToPointCloudFilter, VtkCompositeImageToSurfacePointsFilter, and VtkCompositeThresholdFilter.

Definition at line 203 of file VtkAlgorithmProperties.h.

    {
        (*_algorithmUserVectorProperties)[name] = values;
    }

Referenced by VtkAlgorithmPropertyVectorEdit::setNewValue(), VtkCompositeColormapToImageFilter::SetUserVectorProperty(), VtkCompositeContourFilter::SetUserVectorProperty(), VtkCompositeElementSelectionFilter::SetUserVectorProperty(), VtkCompositeImageToCylindersFilter::SetUserVectorProperty(), VtkCompositeImageToPointCloudFilter::SetUserVectorProperty(), and VtkCompositeThresholdFilter::SetUserVectorProperty().

Member Data Documentation

_activeAttributeName

QString VtkAlgorithmProperties::_activeAttributeName

protected

Definition at line 230 of file VtkAlgorithmProperties.h.

Referenced by VtkAlgorithmProperties(), GetActiveAttribute(), VtkCompositeColorByHeightFilter::init(), SetActiveAttribute(), and SetLookUpTable().

_algorithmUserProperties

QMap<QString, QVariant>* VtkAlgorithmProperties::_algorithmUserProperties

protected

Definition at line 233 of file VtkAlgorithmProperties.h.

Referenced by VtkAlgorithmProperties(), ~VtkAlgorithmProperties(), GetAlgorithmUserProperties(), and GetUserProperty().

_algorithmUserVectorProperties

QMap<QString, QList<QVariant> >* VtkAlgorithmProperties::_algorithmUserVectorProperties

protected

Definition at line 234 of file VtkAlgorithmProperties.h.

Referenced by VtkAlgorithmProperties(), ~VtkAlgorithmProperties(), GetAlgorithmUserVectorProperties(), and GetUserVectorProperty().

_lut

std::map<QString, vtkLookupTable*> VtkAlgorithmProperties::_lut

protected

Definition at line 226 of file VtkAlgorithmProperties.h.

Referenced by ~VtkAlgorithmProperties(), GetLookupTable(), RemoveLookupTable(), and SetLookUpTable().

_name

QString VtkAlgorithmProperties::_name

protected

Definition at line 229 of file VtkAlgorithmProperties.h.

Referenced by GetName(), and SetName().

_property

vtkProperty* VtkAlgorithmProperties::_property

protected

Definition at line 221 of file VtkAlgorithmProperties.h.

Referenced by VtkAlgorithmProperties(), ~VtkAlgorithmProperties(), and GetProperties().

_removable

bool VtkAlgorithmProperties::_removable

protected

Definition at line 231 of file VtkAlgorithmProperties.h.

Referenced by VtkAlgorithmProperties(), VtkPointsSource::VtkPointsSource(), VtkPolylinesSource::VtkPolylinesSource(), VtkStationSource::VtkStationSource(), VtkSurfacesSource::VtkSurfacesSource(), and IsRemovable().

_scalarVisibility

bool VtkAlgorithmProperties::_scalarVisibility

protected

Definition at line 225 of file VtkAlgorithmProperties.h.

Referenced by VtkAlgorithmProperties(), GetScalarVisibility(), and SetScalarVisibility().

_texture

vtkTexture* VtkAlgorithmProperties::_texture

protected

Definition at line 222 of file VtkAlgorithmProperties.h.

Referenced by VtkAlgorithmProperties(), ~VtkAlgorithmProperties(), GetTexture(), and SetTexture().

---

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

• Applications/DataExplorer/VtkVis/VtkAlgorithmProperties.h
• Applications/DataExplorer/VtkVis/VtkAlgorithmProperties.cpp