VtkAlgorithmProperties.h

Go to the documentation of this file.

// SPDX-FileCopyrightText: Copyright (c) OpenGeoSys Community (opengeosys.org)
// SPDX-License-Identifier: BSD-3-Clause
 
#pragma once
 
// ** INCLUDES **
#include <QList>
#include <QMap>
#include <QObject>
#include <QString>
#include <QVariant>
 
class vtkProperty;
class vtkTexture;
class vtkLookupTable;
 
 
#define ogsUserPropertyMacro(name,type) \
        virtual void Set ## name (type _arg) \
    { \
        vtkDebugMacro( \
                << this->GetClassName() << " (" << this << "): setting " # name " to " << \
                _arg); \
        if (this->name != _arg)  \
        { \
            this->name = _arg; \
            this->Modified(); \
            (*(this->_algorithmUserProperties))[QString(# name)] = QVariant(_arg); \
        } \
    } \
\
        type name;
// End of ogsUserPropertyMacro
 
#define ogsUserVec2PropertyMacro(name,type) \
        virtual void Set ## name (type _arg1, type _arg2) \
    { \
        vtkDebugMacro( \
                << this->GetClassName() << " (" << this << "): setting " << \
                # name " to (" << \
                _arg1 << "," << _arg2 << ")"); \
        if ((this->name[0] != _arg1) || (this->name[1] != _arg2)) \
        { \
            this->name[0] = _arg1; \
            this->name[1] = _arg2; \
            this->Modified(); \
            QList<QVariant> list; \
            list.push_back(QVariant(_arg1)); \
            list.push_back(QVariant(_arg2)); \
            (*(this->_algorithmUserVectorProperties))[QString(# name)] = list; \
        } \
    } \
\
        virtual void Set ## name (type _arg[2]) \
    { \
        this->Set ## name (_arg[0], _arg[1]); \
    } \
\
        type name[2];
// End of ogsUserVec2PropertyMacro
 
#define ogsUserVec3PropertyMacro(name,type) \
        virtual void Set ## name (type _arg1, type _arg2, type _arg3) \
    { \
        vtkDebugMacro( \
                << this->GetClassName() << " (" << this << "): setting " << \
                # name " to (" << \
                _arg1 << "," << _arg2 << "," << _arg3 << ")"); \
        if ((this->name[0] != _arg1) || (this->name[1] != _arg2) || (this->name[2] != _arg3)) \
        { \
            this->name[0] = _arg1; \
            this->name[1] = _arg2; \
            this->name[2] = _arg3; \
            this->Modified(); \
            QList<QVariant> list; \
            list.push_back(QVariant(_arg1)); \
            list.push_back(QVariant(_arg2)); \
            list.push_back(QVariant(_arg3)); \
            (*(this->_algorithmUserVectorProperties))[QString(# name)] = list; \
        } \
    } \
\
        virtual void Set ## name (type _arg[3]) \
    { \
        this->Set ## name (_arg[0], _arg[1], _arg[2]); \
    } \
\
        type name[3];
// End of ogsUserVec3PropertyMacro
 
#define ogsUserVec4PropertyMacro(name,type) \
        virtual void Set ## name (type _arg1, type _arg2, type _arg3, type _arg4) \
    { \
        vtkDebugMacro( \
                << this->GetClassName() << " (" << this << "): setting " << \
                # name " to (" << \
                _arg1 << "," << _arg2 << "," << _arg3 << "," << _arg4 << ")"); \
        if ((this->name[0] != _arg1) || (this->name[1] != _arg2) || \
            (this->name[2] != _arg3) || (this->name[3] != _arg4)) \
        { \
            this->name[0] = _arg1; \
            this->name[1] = _arg2; \
            this->name[2] = _arg3; \
            this->name[3] = _arg4; \
            this->Modified(); \
            QList<QVariant> list; \
            list.push_back(QVariant(_arg1)); \
            list.push_back(QVariant(_arg2)); \
            list.push_back(QVariant(_arg3)); \
            list.push_back(QVariant(_arg4)); \
            (*(this->_algorithmUserVectorProperties))[QString(# name)] = list; \
        } \
    } \
\
        virtual void Set ## name (type _arg[4]) \
    { \
        this->Set ## name (_arg[0], _arg[1], _arg[2], _arg[3]); \
    } \
\
        type name[4];
// End of ogsUserVec4PropertyMacro

class VtkAlgorithmProperties : public QObject
{
    Q_OBJECT
 
public:
    explicit VtkAlgorithmProperties(QObject* parent = nullptr);
 
    ~VtkAlgorithmProperties() override;

    vtkProperty* GetProperties() const { return _property; }

    vtkTexture* GetTexture() { return _texture; }

    void SetTexture(vtkTexture* t) { _texture = t; }

    vtkLookupTable* GetLookupTable(const QString& array_name);

    void RemoveLookupTable(const QString& array_name);

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

    void SetLookUpTable(const QString &array_name, const QString &filename);

    bool GetScalarVisibility() const { return _scalarVisibility; }

    void SetScalarVisibility(bool on);

    QString GetName() const { return _name; }

    void SetName(QString name) { _name = name; }

    bool IsRemovable() const { return _removable; }

    QMap<QString, QVariant>* GetAlgorithmUserProperties() const {
        return _algorithmUserProperties;
    }

    QMap<QString, QList<QVariant> >* GetAlgorithmUserVectorProperties() const {
        return _algorithmUserVectorProperties;
    }

    virtual void SetUserProperty(QString name, QVariant value)
    {
        (*_algorithmUserProperties)[name] = value;
    }

    QVariant GetUserProperty(QString name) const;

    virtual void SetUserVectorProperty(QString name, QList<QVariant> values)
    {
        (*_algorithmUserVectorProperties)[name] = values;
    }

    QList<QVariant> GetUserVectorProperty(QString name) const;

    void SetActiveAttribute(QString name);

    QString GetActiveAttribute() const { return _activeAttributeName; }
 
 
protected:
 
    // Properties set on vtkActor
    vtkProperty* _property;
    vtkTexture* _texture;
 
    // Properties set on vtkMapper
    bool _scalarVisibility;
    std::map<QString, vtkLookupTable*> _lut;
 
    // Properties used in the GUI
    QString _name;
    QString _activeAttributeName;
    bool _removable;
 
    QMap<QString, QVariant>* _algorithmUserProperties;
    QMap<QString, QList<QVariant> >* _algorithmUserVectorProperties;
 
signals:
    void ScalarVisibilityChanged(bool on);
};