1/****************************************************************************
2**
3** Copyright (C) 2017 Klaralvdalens Datakonsult AB (KDAB).
4** Contact: https://www.qt.io/licensing/
5**
6** This file is part of the Qt3D module 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 QT3DANIMATION_QCHANNEL_H
41#define QT3DANIMATION_QCHANNEL_H
42
43#include <QtCore/qscopedpointer.h>
44#include <QtCore/qstring.h>
45#include <Qt3DAnimation/qt3danimation_global.h>
46#include <Qt3DAnimation/qchannelcomponent.h>
47
48QT_BEGIN_NAMESPACE
49
50namespace Qt3DAnimation {
51
52class QChannelPrivate;
53
54class Q_3DANIMATIONSHARED_EXPORT QChannel
55{
56public:
57 QChannel();
58 explicit QChannel(const QString &name);
59 QChannel(const QChannel &);
60 QChannel &operator=(const QChannel &);
61 ~QChannel();
62
63 void setName(const QString &name);
64 QString name() const;
65
66 void setJointIndex(int jointIndex);
67 int jointIndex() const;
68
69 int channelComponentCount() const;
70 void appendChannelComponent(const QChannelComponent &component);
71 void insertChannelComponent(int index, const QChannelComponent &component);
72 void removeChannelComponent(int index);
73 void clearChannelComponents();
74
75 // Iterator API
76 typedef const QChannelComponent *const_iterator;
77 typedef std::reverse_iterator<const_iterator> const_reverse_iterator;
78
79 const_iterator begin() const Q_DECL_NOTHROW;
80 const_iterator cbegin() const Q_DECL_NOTHROW { return begin(); }
81 const_iterator end() const Q_DECL_NOTHROW;
82 const_iterator cend() const Q_DECL_NOTHROW { return end(); }
83 const_reverse_iterator rbegin() const Q_DECL_NOTHROW { return const_reverse_iterator(end()); }
84 const_reverse_iterator crbegin() const Q_DECL_NOTHROW { return rbegin(); }
85 const_reverse_iterator rend() const Q_DECL_NOTHROW { return const_reverse_iterator(begin()); }
86 const_reverse_iterator crend() const Q_DECL_NOTHROW { return rend(); }
87
88 friend bool operator==(const QChannel &,
89 const QChannel &) Q_DECL_NOTHROW;
90 friend bool operator!=(const QChannel &,
91 const QChannel &) Q_DECL_NOTHROW;
92
93private:
94 QScopedPointer<QChannelPrivate> d;
95};
96
97} // namespace Qt3DAnimation
98
99QT_END_NAMESPACE
100
101#endif // QT3DANIMATION_QCHANNEL_H
102