/****************************************************************************
**
** Copyright (C) 2017 Klaralvdalens Datakonsult AB (KDAB).
** Contact: http://www.qt-project.org/legal
**
** This file is part of the Qt3D module of the Qt Toolkit.
**
** $QT_BEGIN_LICENSE:LGPL$
** 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 Lesser General Public License Usage
** Alternatively, this file may be used under the terms of the GNU Lesser
** General Public License version 3 as published by the Free Software
** Foundation and appearing in the file LICENSE.LGPL3 included in the
** packaging of this file. Please review the following information to
** ensure the GNU Lesser General Public License version 3 requirements
** will be met: https://www.gnu.org/licenses/lgpl-3.0.html.
**
** GNU General Public License Usage
** Alternatively, this file may be used under the terms of the GNU
** General Public License version 2.0 or (at your option) the GNU General
** Public license version 3 or any later version approved by the KDE Free
** Qt Foundation. The licenses are as published by the Free Software
** Foundation and appearing in the file LICENSE.GPL2 and LICENSE.GPL3
** 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-2.0.html and
** https://www.gnu.org/licenses/gpl-3.0.html.
**
** $QT_END_LICENSE$
**
****************************************************************************/

#include "clipblendnodevisitor_p.h"
#include <Qt3DAnimation/private/managers_p.h>
#include <Qt3DAnimation/private/clipblendnode_p.h>

QT_BEGIN_NAMESPACE

namespace Qt3DAnimation {
namespace Animation {

/*!
    \class ClipBlendNodeVisitor
    \internal
    Visits a blend tree in either pre- or post-order manner, optionally taking care
    to only visit the nodes that are dependencies of evaluating the blend
    tree.
*/
ClipBlendNodeVisitor::ClipBlendNodeVisitor(ClipBlendNodeManager *manager,
                                           TraversalOrder order,
                                           NodeFilter filter)
    : m_manager(manager)
    , m_order(order)
    , m_filter(filter)
{
}

void ClipBlendNodeVisitor::traverse(Qt3DCore::QNodeId rootId,
                                    const VisitFunction &visitFunction) const
{
    ClipBlendNode *node = m_manager->lookupNode(rootId);
    if (node != nullptr) {
        switch (m_order) {
        case PreOrder: {
            switch (m_filter) {
            case VisitAllNodes:
                visitPreOrderAllNodes(node, visitFunction);
                break;

            case VisitOnlyDependencies:
                visitPreOrderDependencyNodes(node, visitFunction);
                break;
            }

            break;
        }

        case PostOrder: {
            switch (m_filter) {
            case VisitAllNodes:
                visitPostOrderAllNodes(node, visitFunction);
                break;

            case VisitOnlyDependencies:
                visitPostOrderDependencyNodes(node, visitFunction);
                break;
            }

            break;
        }
        }
    }
}

/*!
    \internal
    Leaf to root traversal (Pre-order traversal) visiting all nodes even if
    they will not participate in current evaluation of the blend tree.
*/
void ClipBlendNodeVisitor::visitPreOrderAllNodes(ClipBlendNode *node,
                                                 const VisitFunction &visitFunction) const
{
    visitFunction(node);
    const Qt3DCore::QNodeIdVector childIds = node->allDependencyIds();
    for (const Qt3DCore::QNodeId &childId: childIds) {
        ClipBlendNode *childNode = m_manager->lookupNode(childId);
        if (childNode != nullptr)
            visitPreOrderAllNodes(childNode, visitFunction);
    }
}

/*!
    \internal
    Leaf to root traversal (Post-order traversal) visiting all nodes even if
    they will not participate in current evaluation of the blend tree.
*/
void ClipBlendNodeVisitor::visitPostOrderAllNodes(ClipBlendNode *node,
                                                  const VisitFunction &visitFunction) const
{
    const Qt3DCore::QNodeIdVector childIds = node->allDependencyIds();
    for (const Qt3DCore::QNodeId &childId: childIds) {
        ClipBlendNode *childNode = m_manager->lookupNode(childId);
        if (childNode != nullptr)
            visitPostOrderAllNodes(childNode, visitFunction);
    }
    visitFunction(node);
}

/*!
    \internal
    Leaf to root traversal (Pre-order traversal) visiting only nodes required
    to evaluate the blend tree given its current state.
*/
void ClipBlendNodeVisitor::visitPreOrderDependencyNodes(ClipBlendNode *node,
                                                        const VisitFunction &visitFunction) const
{
    visitFunction(node);
    const Qt3DCore::QNodeIdVector childIds = node->currentDependencyIds();
    for (const Qt3DCore::QNodeId &childId: childIds) {
        ClipBlendNode *childNode = m_manager->lookupNode(childId);
        if (childNode != nullptr)
            visitPreOrderDependencyNodes(childNode, visitFunction);
    }
}

/*!
    \internal
    Leaf to root traversal (Post-order traversal) visiting only nodes required
    to evaluate the blend tree given its current state.
*/
void ClipBlendNodeVisitor::visitPostOrderDependencyNodes(ClipBlendNode *node,
                                                         const VisitFunction &visitFunction) const
{
    const Qt3DCore::QNodeIdVector childIds = node->currentDependencyIds();
    for (const Qt3DCore::QNodeId &childId: childIds) {
        ClipBlendNode *childNode = m_manager->lookupNode(childId);
        if (childNode != nullptr)
            visitPostOrderDependencyNodes(childNode, visitFunction);
    }
    visitFunction(node);
}

} // Animation
} // Qt3DAnimation

QT_END_NAMESPACE
