/****************************************************************************
**
** Copyright (C) 2018 The Qt Company Ltd.
** Contact: https://www.qt.io/licensing/
**
** This file is part of Qt 3D Studio.
**
** $QT_BEGIN_LICENSE:GPL$
** Commercial License Usage
** Licensees holding valid commercial Qt 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 The Qt Company. For licensing terms
** and conditions see https://www.qt.io/terms-conditions. For further
** information use the contact form at https://www.qt.io/contact-us.
**
** GNU General Public License Usage
** Alternatively, this file may be used under the terms of the GNU
** General Public License version 3 or (at your option) any later version
** approved by the KDE Free Qt Foundation. The licenses are 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 requirements will
** be met: https://www.gnu.org/licenses/gpl-3.0.html.
**
** $QT_END_LICENSE$
**
****************************************************************************/

#ifndef Q3DSDATAINPUT_H
#define Q3DSDATAINPUT_H

#include <QtStudio3D/qstudio3dglobal.h>
#include <QtCore/qobject.h>
#include <QtCore/qvariant.h>

QT_BEGIN_NAMESPACE

class Q3DSDataInputPrivate;
class Q3DSPresentation;

class Q_STUDIO3D_EXPORT Q3DSDataInput : public QObject
{
    Q_OBJECT
    Q_DECLARE_PRIVATE(Q3DSDataInput)

    Q_PROPERTY(QString name READ name WRITE setName NOTIFY nameChanged)
    Q_PROPERTY(QVariant value READ value WRITE setValue NOTIFY valueChanged)
    Q_PROPERTY(float max READ max CONSTANT)
    Q_PROPERTY(float min READ min CONSTANT)
    Q_PROPERTY(QStringList metadataKeys READ metadataKeys CONSTANT)
public:
    explicit Q3DSDataInput(QObject *parent = nullptr);
    explicit Q3DSDataInput(const QString &name, QObject *parent = nullptr);
    explicit Q3DSDataInput(Q3DSPresentation *presentation, const QString &name,
                           QObject *parent = nullptr);

    virtual ~Q3DSDataInput();

    enum class ValueRole {
        Value = 0,
        Min = 1,
        Max = 2
    };

    QString name() const;
    QVariant value() const;
    float min() const;
    float max() const;
    bool isValid() const;

    Q_INVOKABLE QString metadata(const QString &key) const;
    QStringList metadataKeys() const;

public Q_SLOTS:
    void setName(const QString &name);
    void setValue(const QVariant &value);

Q_SIGNALS:
    void nameChanged();
    void valueChanged();

protected:
    explicit Q3DSDataInput(Q3DSDataInputPrivate *d, Q3DSPresentation *presentation,
                           const QString &name, QObject *parent = nullptr);
    Q3DSDataInputPrivate *d_ptr;

private:
    Q_DISABLE_COPY(Q3DSDataInput)
    friend class Q3DSPresentationPrivate;
    friend class Q3DSRenderer;
};

QT_END_NAMESPACE

Q_DECLARE_METATYPE(Q3DSDataInput*)

#endif // Q3DSDATAINPUT_H