1 /****************************************************************************
2 **
3 ** Copyright (C) 2016 The Qt Company Ltd.
4 ** Contact: https://www.qt.io/licensing/
5 **
6 ** This file is part of the plugins of the Qt Toolkit.
7 **
8 ** $QT_BEGIN_LICENSE:LGPL$
9 ** Commercial License Usage
10 ** Licensees holding valid commercial Qt licenses may use this file in
11 ** accordance with the commercial license agreement provided with the
12 ** Software or, alternatively, in accordance with the terms contained in
13 ** a written agreement between you and The Qt Company. For licensing terms
14 ** and conditions see https://www.qt.io/terms-conditions. For further
15 ** information use the contact form at https://www.qt.io/contact-us.
16 **
17 ** GNU Lesser General Public License Usage
18 ** Alternatively, this file may be used under the terms of the GNU Lesser
19 ** General Public License version 3 as published by the Free Software
20 ** Foundation and appearing in the file LICENSE.LGPL3 included in the
21 ** packaging of this file. Please review the following information to
22 ** ensure the GNU Lesser General Public License version 3 requirements
23 ** will be met: https://www.gnu.org/licenses/lgpl-3.0.html.
24 **
25 ** GNU General Public License Usage
26 ** Alternatively, this file may be used under the terms of the GNU
27 ** General Public License version 2.0 or (at your option) the GNU General
28 ** Public license version 3 or any later version approved by the KDE Free
29 ** Qt Foundation. The licenses are as published by the Free Software
30 ** Foundation and appearing in the file LICENSE.GPL2 and LICENSE.GPL3
31 ** included in the packaging of this file. Please review the following
32 ** information to ensure the GNU General Public License requirements will
33 ** be met: https://www.gnu.org/licenses/gpl-2.0.html and
34 ** https://www.gnu.org/licenses/gpl-3.0.html.
35 **
36 ** $QT_END_LICENSE$
37 **
38 ****************************************************************************/
39 
40 #ifndef QDECLARATIVEATTENUATIONMODEL_P_H
41 #define QDECLARATIVEATTENUATIONMODEL_P_H
42 
43 //
44 //  W A R N I N G
45 //  -------------
46 //
47 // This file is not part of the Qt API.  It exists purely as an
48 // implementation detail.  This header file may change from version to
49 // version without notice, or even be removed.
50 //
51 // We mean it.
52 //
53 
54 #include <QtQml/qqml.h>
55 #include <QVector3D>
56 
57 QT_BEGIN_NAMESPACE
58 
59 class QDeclarativeAudioEngine;
60 
61 class QDeclarativeAttenuationModel : public QObject
62 {
63     Q_OBJECT
64     Q_PROPERTY(QString name READ name WRITE setName)
65 
66 public:
67     QDeclarativeAttenuationModel(QObject *parent = 0);
68     ~QDeclarativeAttenuationModel();
69 
70     QString name() const;
71     void setName(const QString& name);
72 
73     virtual qreal calculateGain(const QVector3D &listenerPosition, const QVector3D &sourcePosition) const = 0;
74 
75     virtual void setEngine(QDeclarativeAudioEngine *engine);
76 
77 protected:
78     QString m_name;
79     QDeclarativeAudioEngine *m_engine;
80 
81 private:
82     Q_DISABLE_COPY(QDeclarativeAttenuationModel);
83 };
84 
85 class QDeclarativeAttenuationModelLinear : public QDeclarativeAttenuationModel
86 {
87     Q_OBJECT
88     Q_PROPERTY(qreal start READ startDistance WRITE setStartDistance)
89     Q_PROPERTY(qreal end READ endDistance WRITE setEndDistance)
90 
91 public:
92     QDeclarativeAttenuationModelLinear(QObject *parent = 0);
93 
94     qreal startDistance() const;
95     void setStartDistance(qreal startDist);
96 
97     qreal endDistance() const;
98     void setEndDistance(qreal endDist);
99 
100     qreal calculateGain(const QVector3D &listenerPosition, const QVector3D &sourcePosition) const override;
101 
102     void setEngine(QDeclarativeAudioEngine *engine) override;
103 
104 private:
105     Q_DISABLE_COPY(QDeclarativeAttenuationModelLinear);
106     qreal m_start;
107     qreal m_end;
108 };
109 
110 class QDeclarativeAttenuationModelInverse : public QDeclarativeAttenuationModel
111 {
112     Q_OBJECT
113     Q_PROPERTY(qreal start READ referenceDistance WRITE setReferenceDistance)
114     Q_PROPERTY(qreal end READ maxDistance WRITE setMaxDistance)
115     Q_PROPERTY(qreal rolloff READ rolloffFactor WRITE setRolloffFactor)
116 
117 public:
118     QDeclarativeAttenuationModelInverse(QObject *parent = 0);
119 
120     qreal referenceDistance() const;
121     void setReferenceDistance(qreal referenceDistance);
122 
123     qreal maxDistance() const;
124     void setMaxDistance(qreal maxDistance);
125 
126     qreal rolloffFactor() const;
127     void setRolloffFactor(qreal rolloffFactor);
128 
129     qreal calculateGain(const QVector3D &listenerPosition, const QVector3D &sourcePosition) const override;
130 
131     void setEngine(QDeclarativeAudioEngine *engine) override;
132 
133 private:
134     Q_DISABLE_COPY(QDeclarativeAttenuationModelInverse);
135     qreal m_ref;
136     qreal m_max;
137     qreal m_rolloff;
138 };
139 
140 QT_END_NAMESPACE
141 
142 #endif
143