1/****************************************************************************
2**
3** Copyright (C) 2014 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 QT3DCORE_QNODEID_H
41#define QT3DCORE_QNODEID_H
42
43#include <Qt3DCore/qt3dcore_global.h>
44#include <QtCore/QDebug>
45#include <QtCore/QHashFunctions>
46
47QT_BEGIN_NAMESPACE
48
49namespace Qt3DCore {
50
51class QNodeId
52{
53 Q_DECL_CONSTEXPR explicit QNodeId(quint64 i) Q_DECL_NOTHROW
54 : m_id(i)
55 {}
56public:
57 Q_DECL_CONSTEXPR QNodeId() Q_DECL_NOTHROW
58 : m_id(0)
59 {}
60
61 QT3DCORESHARED_EXPORT static QNodeId createId() Q_DECL_NOTHROW;
62
63 Q_DECL_CONSTEXPR bool isNull() const Q_DECL_NOTHROW
64 {
65 return m_id == 0;
66 }
67
68 Q_DECL_CONSTEXPR bool operator ==(QNodeId other) const Q_DECL_NOTHROW
69 {
70 return other.m_id == m_id;
71 }
72
73 Q_DECL_CONSTEXPR bool operator !=(QNodeId other) const Q_DECL_NOTHROW
74 {
75 return !operator ==(other);
76 }
77
78 Q_DECL_CONSTEXPR bool operator <(QNodeId other) const Q_DECL_NOTHROW
79 {
80 return m_id < other.m_id;
81 }
82
83 Q_DECL_CONSTEXPR bool operator >(QNodeId other) const Q_DECL_NOTHROW
84 {
85 return m_id > other.m_id;
86 }
87
88 Q_DECL_CONSTEXPR quint64 id() const Q_DECL_NOTHROW
89 {
90 return m_id;
91 }
92
93 Q_DECL_CONSTEXPR operator bool() const Q_DECL_NOTHROW
94 {
95 return m_id != 0;
96 }
97
98private:
99 quint64 m_id;
100};
101QT3D_DECLARE_TYPEINFO(Qt3DCore, QNodeId, Q_PRIMITIVE_TYPE)
102
103typedef QVector<QNodeId> QNodeIdVector;
104
105#ifndef QT_NO_DEBUG_STREAM
106QT3DCORESHARED_EXPORT QDebug operator<<(QDebug d, QNodeId id);
107#endif
108
109inline Q_DECL_CONSTEXPR uint qHash(QNodeId id, uint seed = 0) Q_DECL_NOTHROW
110{
111 using QT_PREPEND_NAMESPACE(qHash);
112 return qHash(id.id(), seed);
113}
114
115} // Qt3DCore
116
117QT_END_NAMESPACE
118
119Q_DECLARE_METATYPE(Qt3DCore::QNodeId) // LCOV_EXCL_LINE
120
121
122#endif // QT3DCORE_QNODEID_H
123