ColormapProperty.h

Go to the documentation of this file.

/*
 * Copyright (C) 2012 by
 *   MetraLabs GmbH (MLAB), GERMANY
 * and
 *   Neuroinformatics and Cognitive Robotics Labs (NICR) at TU Ilmenau, GERMANY
 * All rights reserved.
 *
 * Contact: info@mira-project.org
 *
 * Commercial Usage:
 *   Licensees holding valid commercial licenses may use this file in
 *   accordance with the commercial license agreement provided with the
 *   software or, alternatively, in accordance with the terms contained in
 *   a written agreement between you and MLAB or NICR.
 *
 * GNU General Public License Usage:
 *   Alternatively, this file may be used under the terms of the GNU
 *   General Public License version 3.0 as published by the Free Software
 *   Foundation and appearing in the file LICENSE.GPL3 included in the
 *   packaging of this file. Please review the following information to
 *   ensure the GNU General Public License version 3.0 requirements will be
 *   met: http://www.gnu.org/copyleft/gpl.html.
 *   Alternatively you may (at your option) use any later version of the GNU
 *   General Public License if such license has been publicly approved by
 *   MLAB and NICR (or its successors, if any).
 *
 * IN NO EVENT SHALL "MLAB" OR "NICR" BE LIABLE TO ANY PARTY FOR DIRECT,
 * INDIRECT, SPECIAL, INCIDENTAL, OR CONSEQUENTIAL DAMAGES ARISING OUT OF
 * THE USE OF THIS SOFTWARE AND ITS DOCUMENTATION, EVEN IF "MLAB" OR
 * "NICR" HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 *
 * "MLAB" AND "NICR" SPECIFICALLY DISCLAIM ANY WARRANTIES, INCLUDING,
 * BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND
 * FITNESS FOR A PARTICULAR PURPOSE. THE SOFTWARE PROVIDED HEREUNDER IS
 * ON AN "AS IS" BASIS, AND "MLAB" AND "NICR" HAVE NO OBLIGATION TO
 * PROVIDE MAINTENANCE, SUPPORT, UPDATES, ENHANCEMENTS OR MODIFICATIONS.
 */

#ifndef _MIRA_COLORMAPPROPERTY_H_
#define _MIRA_COLORMAPPROPERTY_H_

#include <QVector>
#include <QColor>
#include <QComboBox>

#include <serialization/PropertyNode.h>
#include <serialization/SplitReflect.h>
#include <serialization/IsTransparentSerializable.h>

#include <image/Colormap.h>

#include <widgets/PropertyEditorDelegateUtils.h>

namespace mira {


class ColormapProperty
{
public:

    struct ColormapDesc;

    template <typename Reflector>
    void reflectRead(Reflector& r) {
        r.delegate(mColormapIdentifier);
    }

    template <typename Reflector>
    void reflectWrite(Reflector& r) {
        r.delegate(mColormapIdentifier);
        update();
    }

    MIRA_SPLIT_REFLECT_MEMBER

public:

    ColormapProperty() : mColormapDesc(NULL) {}

    ColormapProperty(const std::string& colormapIdentifier);

    bool isValid() const;

    ColormapProperty& operator=(const std::string& identifier) {
        mColormapIdentifier = identifier;
        update();
        return *this;
    }

    const std::string& str() const {
        return mColormapIdentifier;
    }

    const Colormap&  getColormap() const;

    const QVector<QRgb>& getColorTable() const;


public:

    void setFilter(boost::function<bool(const Colormap*)> filterFunction);

    bool filter(const Colormap* colormap) const;

    static bool filterContinuous(const Colormap* colormap)
    {
        // check if colormap is a ContinuousColormap
        return dynamic_cast<const ContinuousColormap*>(colormap) != NULL;
    }

private:

    void update();
    void checkValid() const;


private:

    std::string mColormapIdentifier;
    const ColormapDesc* mColormapDesc;

    boost::function<bool(const Colormap*)> mFilterFunction;
};

template <typename SerializerTag>
class IsTransparentSerializable<ColormapProperty,SerializerTag> : public std::true_type {
public:
    using DelegateTo = std::string;
};


class ColormapPropertyComboBox : public QComboBox, public IPropertyDelegate_Edit
{
    Q_OBJECT
public:
    ColormapPropertyComboBox(PropertyNode* p, QWidget* parent);

    void initFromProperty() override {}
public slots:
    void slotSetValue(int value);
signals:
    void propertyEdited() override;

private:
    class ComboBoxDelegate;
};


}

#endif