qt-creator/share/qtcreator/qml/qmlpuppet/qml2puppet/instances/quick3dnodeinstance.cpp

/****************************************************************************
**
** Copyright (C) 2019 The Qt Company Ltd.
** Contact: https://www.qt.io/licensing/
**
** This file is part of Qt Creator.
**
** Commercial License Usage
** Licensees holding valid commercial Qt licenses may use this file in
** accordance with the commercial license agreement provided with the
** Software or, alternatively, in accordance with the terms contained in
** a written agreement between you and The Qt Company. For licensing terms
** and conditions see https://www.qt.io/terms-conditions. For further
** information use the contact form at https://www.qt.io/contact-us.
**
** GNU General Public License Usage
** Alternatively, this file may be used under the terms of the GNU
** General Public License version 3 as published by the Free Software
** Foundation with exceptions as appearing in the file LICENSE.GPL3-EXCEPT
** included in the packaging of this file. Please review the following
** information to ensure the GNU General Public License requirements will
** be met: https://www.gnu.org/licenses/gpl-3.0.html.
**
****************************************************************************/

#include "quick3dnodeinstance.h"
#include "qt5nodeinstanceserver.h"

#include <qmlprivategate.h>

#include <QDebug>
#include <QHash>
#include <QQmlExpression>
#include <QQmlProperty>

#include <cmath>

#ifdef QUICK3D_MODULE
#include <private/qquick3dnode_p.h>
#include <private/qquick3dmodel_p.h>
#include <private/qquick3dnode_p_p.h>
#endif

namespace QmlDesigner {
namespace Internal {

Quick3DNodeInstance::Quick3DNodeInstance(QObject *node)
   : ObjectNodeInstance(node)
{
}

Quick3DNodeInstance::~Quick3DNodeInstance()
{
}

void Quick3DNodeInstance::initialize(const ObjectNodeInstance::Pointer &objectNodeInstance,
                                     InstanceContainer::NodeFlags flags)
{
    ObjectNodeInstance::initialize(objectNodeInstance, flags);
    setPickable(true, true, false);
}

Qt5NodeInstanceServer *Quick3DNodeInstance::qt5NodeInstanceServer() const
{
    return qobject_cast<Qt5NodeInstanceServer *>(nodeInstanceServer());
}

QQuick3DNode *Quick3DNodeInstance::quick3DNode() const
{
#ifdef QUICK3D_MODULE
    return qobject_cast<QQuick3DNode *>(object());
#else
    return nullptr;
#endif
}

void Quick3DNodeInstance::setPickable(bool enable, bool checkParent, bool applyToChildInstances)
{
#ifdef QUICK3D_MODULE
    auto node = quick3DNode();
    if (node) {
        QQuick3DObject::Type nodeType = node->type();
        bool parentHidden = false;
        if (checkParent) {
            // First check if any parent node is already hidden. Never set pickable on that case.
            auto parentNode = node->parentNode();
            while (parentNode && !parentHidden) {
                parentHidden = QQuick3DNodePrivate::get(parentNode)->m_isHiddenInEditor;
                parentNode = parentNode->parentNode();
            }

        }
        if (!parentHidden) {
            auto getQuick3DInstance = [this](QQuick3DObject *obj) -> Quick3DNodeInstance * {
                if (nodeInstanceServer()->hasInstanceForObject(obj)) {
                    ServerNodeInstance instance = nodeInstanceServer()->instanceForObject(obj);
                    if (instance.isValid() && qobject_cast<QQuick3DNode *>(instance.internalObject()))
                        return static_cast<Quick3DNodeInstance *>(instance.internalInstance().data());
                }
                return nullptr;
            };
            const auto childItems = node->childItems();
            for (auto childItem : childItems) {
                if (auto quick3dInstance = getQuick3DInstance(childItem)) {
                    if (applyToChildInstances) {
                        // Don't override explicit block in children
                        if (!QQuick3DNodePrivate::get(quick3dInstance->quick3DNode())->m_isHiddenInEditor)
                            quick3dInstance->setPickable(enable, false, true);
                    }
                } else {
                    // Children of components do not have instances, but will still need to be
                    // pickable. These need to be set even if applyToChildInstances is false.
                    std::function<void(QQuick3DNode *)> checkChildren;
                    checkChildren = [&](QQuick3DNode *checkNode) {
                        const auto childItems = checkNode->childItems();
                        for (auto child : childItems) {
                            if (auto childNode = qobject_cast<QQuick3DNode *>(child))
                                checkChildren(childNode);
                        }
                        if (auto checkModel = qobject_cast<QQuick3DModel *>(checkNode)) {
                            QVariant value;
                            if (enable)
                                value = QVariant::fromValue(node);
                            // Specify the actual pick target with dynamic property
                            checkModel->setProperty("_pickTarget", value);
                            checkModel->setPickable(enable);
                        }
                    };
                    checkChildren(node);
                }
            }
            if (nodeType == QQuick3DObject::Model)
                setPropertyVariant("pickable", enable); // allow 3D objects to receive mouse clicks
        }
    }
#else
    Q_UNUSED(enable)
    Q_UNUSED(checkParent)
    Q_UNUSED(applyToChildInstances)
#endif
}

Quick3DNodeInstance::Pointer Quick3DNodeInstance::create(QObject *object)
{
    Pointer instance(new Quick3DNodeInstance(object));
    instance->populateResetHashes();
    return instance;
}

void Quick3DNodeInstance::setHideInEditor(bool b)
{
#ifdef QUICK3D_MODULE
    QQuick3DNodePrivate *privateNode = QQuick3DNodePrivate::get(quick3DNode());
    if (privateNode) {
        privateNode->setIsHiddenInEditor(b);

        // Hidden objects should not be pickable
        setPickable(!b, true, true);
    }
#else
    Q_UNUSED(b)
#endif
}

} // namespace Internal
} // namespace QmlDesigner