Revision control
Copy as Markdown
// Copyright (C) 2020 Klaralvdalens Datakonsult AB (KDAB).
// SPDX-License-Identifier: LicenseRef-Qt-Commercial OR LGPL-3.0-only OR GPL-2.0-only OR GPL-3.0-only
#ifndef SCENE3DITEM_H
#define SCENE3DITEM_H
//
// W A R N I N G
// -------------
//
// This file is not part of the Qt API. It exists purely as an
// implementation detail. This header file may change from version to
// version without notice, or even be removed.
//
// We mean it.
//
#include <QtCore/qpointer.h>
#include <QtQuick/QQuickItem>
#include <Qt3DCore/qentity.h>
QT_BEGIN_NAMESPACE
class QOffscreenSurface;
namespace Qt3DCore {
class QAspectEngine;
class QEntity;
}
namespace Qt3DRender {
class QCamera;
class QRenderAspect;
class Scene3DRenderer;
class Scene3DCleaner;
class QFrameGraphNode;
class QRenderSurfaceSelector;
class AspectEngineDestroyer;
class Scene3DItem : public QQuickItem
{
Q_OBJECT
QML_NAMED_ELEMENT(Scene3D)
QML_ADDED_IN_VERSION(2, 0)
Q_PROPERTY(Qt3DCore::QEntity* entity READ entity WRITE setEntity NOTIFY entityChanged)
Q_PROPERTY(QStringList aspects READ aspects WRITE setAspects NOTIFY aspectsChanged)
Q_PROPERTY(bool multisample READ multisample WRITE setMultisample NOTIFY multisampleChanged)
Q_PROPERTY(CameraAspectRatioMode cameraAspectRatioMode READ cameraAspectRatioMode WRITE setCameraAspectRatioMode NOTIFY cameraAspectRatioModeChanged)
Q_PROPERTY(bool hoverEnabled READ isHoverEnabled WRITE setHoverEnabled NOTIFY hoverEnabledChanged)
Q_PROPERTY(CompositingMode compositingMode READ compositingMode WRITE setCompositingMode NOTIFY compositingModeChanged REVISION(2, 14))
Q_CLASSINFO("DefaultProperty", "entity")
public:
explicit Scene3DItem(QQuickItem *parent = 0);
~Scene3DItem();
QStringList aspects() const;
Qt3DCore::QEntity *entity() const;
bool multisample() const;
void setMultisample(bool enable);
Q_INVOKABLE void setItemAreaAndDevicePixelRatio(QSize area, qreal devicePixelRatio);
bool isHoverEnabled() const;
enum CameraAspectRatioMode {
AutomaticAspectRatio,
UserAspectRatio
};
Q_ENUM(CameraAspectRatioMode); // LCOV_EXCL_LINE
CameraAspectRatioMode cameraAspectRatioMode() const;
enum CompositingMode {
FBO,
Underlay
};
Q_ENUM(CompositingMode) // LCOV_EXCL_LINE
CompositingMode compositingMode() const;
public Q_SLOTS:
void setAspects(const QStringList &aspects);
void setEntity(Qt3DCore::QEntity *entity);
void setCameraAspectRatioMode(CameraAspectRatioMode mode);
void setHoverEnabled(bool enabled);
void setCompositingMode(CompositingMode mode);
Q_SIGNALS:
void aspectsChanged();
void entityChanged();
void multisampleChanged();
void cameraAspectRatioModeChanged(CameraAspectRatioMode mode);
void hoverEnabledChanged();
void compositingModeChanged();
private Q_SLOTS:
void applyRootEntityChange();
void requestUpdate();
private:
void synchronize();
bool prepareQt3DFrame();
QSGNode *updatePaintNode(QSGNode *node, UpdatePaintNodeData *nodeData) override;
void setWindowSurface(QObject *rootObject);
void setCameraAspectModeHelper();
void updateCameraAspectRatio();
void mousePressEvent(QMouseEvent *event) override;
bool needsRender(QRenderAspect *renderAspect);
void updateWindowSurface();
void applyAspects();
QStringList m_aspects;
Qt3DCore::QEntity *m_entity;
Qt3DCore::QAspectEngine *m_aspectEngine;
Qt3DCore::QAspectEngine *m_aspectToDelete;
QSGNode *m_lastManagerNode;
AspectEngineDestroyer *m_aspectEngineDestroyer;
bool m_multisample;
bool m_dirty;
bool m_wasFrameProcessed;
bool m_wasSGUpdated;
QPointer<Qt3DRender::QCamera> m_camera;
CameraAspectRatioMode m_cameraAspectRatioMode;
CompositingMode m_compositingMode;
QMetaObject::Connection m_windowConnection;
qint8 m_framesToRender;
static const qint8 ms_framesNeededToFlushPipeline = 3;
};
} // Qt3DRender
QT_END_NAMESPACE
#endif