| 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_QBACKENDNODE_H |
| 41 | #define QT3DCORE_QBACKENDNODE_H |
| 42 | |
| 43 | #include <Qt3DCore/qnodecreatedchange.h> |
| 44 | #include <Qt3DCore/qnodeid.h> |
| 45 | #include <Qt3DCore/qnodecommand.h> |
| 46 | #include <Qt3DCore/qscenechange.h> |
| 47 | #include <Qt3DCore/qt3dcore_global.h> |
| 48 | |
| 49 | QT_BEGIN_NAMESPACE |
| 50 | |
| 51 | namespace Qt3DCore { |
| 52 | |
| 53 | class QBackendNodePrivate; |
| 54 | class QBackendNode; |
| 55 | class QAspectEngine; |
| 56 | |
| 57 | #if defined(QT_BUILD_INTERNAL) |
| 58 | class QBackendNodeTester; |
| 59 | #endif |
| 60 | |
| 61 | class Q_3DCORESHARED_EXPORT QBackendNodeMapper |
| 62 | { |
| 63 | public: |
| 64 | virtual ~QBackendNodeMapper(); |
| 65 | virtual QBackendNode *create(const QNodeCreatedChangeBasePtr &change) const = 0; // TODO QT6 change to only take a NodeId |
| 66 | virtual QBackendNode *get(QNodeId id) const = 0; |
| 67 | virtual void destroy(QNodeId id) const = 0; |
| 68 | }; |
| 69 | |
| 70 | typedef QSharedPointer<QBackendNodeMapper> QBackendNodeMapperPtr; |
| 71 | |
| 72 | class Q_3DCORESHARED_EXPORT QBackendNode |
| 73 | { |
| 74 | public: |
| 75 | enum Mode { |
| 76 | ReadOnly = 0, |
| 77 | ReadWrite |
| 78 | }; |
| 79 | |
| 80 | explicit QBackendNode(Mode mode = ReadOnly); |
| 81 | virtual ~QBackendNode(); |
| 82 | |
| 83 | QNodeId peerId() const Q_DECL_NOEXCEPT; |
| 84 | |
| 85 | void setEnabled(bool enabled) Q_DECL_NOEXCEPT; |
| 86 | bool isEnabled() const Q_DECL_NOEXCEPT; |
| 87 | |
| 88 | Mode mode() const Q_DECL_NOEXCEPT; |
| 89 | |
| 90 | protected: |
| 91 | Q_DECLARE_PRIVATE(QBackendNode) |
| 92 | explicit QBackendNode(QBackendNodePrivate &dd); |
| 93 | Q3D_DECL_DEPRECATED void notifyObservers(const QSceneChangePtr &e); |
| 94 | Q3D_DECL_DEPRECATED QNodeCommand::CommandId sendCommand(const QString &name, const QVariant &data, |
| 95 | QNodeCommand::CommandId replyTo = QNodeCommand::CommandId()); |
| 96 | Q3D_DECL_DEPRECATED void sendReply(const QNodeCommandPtr &command); |
| 97 | Q3D_DECL_DEPRECATED virtual void sceneChangeEvent(const QSceneChangePtr &e); |
| 98 | |
| 99 | QBackendNodePrivate *d_ptr; |
| 100 | |
| 101 | private: |
| 102 | Q_DISABLE_COPY(QBackendNode) |
| 103 | void setPeerId(QNodeId id) Q_DECL_NOEXCEPT; |
| 104 | Q3D_DECL_DEPRECATED virtual void initializeFromPeer(const QNodeCreatedChangeBasePtr &change); |
| 105 | |
| 106 | friend class QBackendNodePropertyChange; |
| 107 | friend class QAbstractAspectPrivate; |
| 108 | #if defined(QT_BUILD_INTERNAL) |
| 109 | friend class QBackendNodeTester; |
| 110 | #endif |
| 111 | }; |
| 112 | |
| 113 | } // namespace Qt3DCore |
| 114 | |
| 115 | QT_END_NAMESPACE |
| 116 | |
| 117 | #endif // QT3DCORE_QBACKENDNODE_H |
| 118 |