/****************************************************************************
**
** Copyright (C) 2019 Klaralvdalens Datakonsult AB (KDAB).
** Contact: https://www.qt.io/licensing/
**
** This file is part of the Qt3D module of the Qt Toolkit.
**
** $QT_BEGIN_LICENSE:COMM$
**
** 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.
**
** $QT_END_LICENSE$
**
**
**
**
**
**
**
**
**
**
**
**
**
**
**
**
**
**
**
****************************************************************************/

#ifndef QT3DRENDER_RENDER_ENTITYVISITOR_H
#define QT3DRENDER_RENDER_ENTITYVISITOR_H

//
//  W A R N I N G
//  -------------
//
// This file is not part of the Qt API.  It exists for the convenience
// of other Qt classes.  This header file may change from version to
// version without notice, or even be removed.
//
// We mean it.
//

#include <qglobal.h>

QT_BEGIN_NAMESPACE

namespace Qt3DRender {
namespace Render {

class Entity;
class NodeManagers;

class Q_AUTOTEST_EXPORT EntityVisitor
{
public:
    enum Operation {
        Continue,   //! continue traversal
        Prune,      //! don't traverse children
        Stop        //! abort traversal
    };

    EntityVisitor(NodeManagers *manager);
    virtual ~EntityVisitor();

    virtual Operation visit(Entity *entity = nullptr);

    bool pruneDisabled() const;
    void setPruneDisabled(bool pruneDisabled);

    bool apply(Entity *root);

protected:
    NodeManagers *m_manager;

private:
    bool m_pruneDisabled;
};

} // namespace Render
} // namespace Qt3DRender

QT_END_NAMESPACE

#endif // QT3DRENDER_RENDER_ENTITYVISITOR_H