/******************************************************************************
*       SOFA, Simulation Open-Framework Architecture, development version     *
*                (c) 2006-2017 INRIA, USTL, UJF, CNRS, MGH                    *
*                                                                             *
* This program is free software; you can redistribute it and/or modify it     *
* under the terms of the GNU Lesser General Public License as published by    *
* the Free Software Foundation; either version 2.1 of the License, or (at     *
* your option) any later version.                                             *
*                                                                             *
* This program is distributed in the hope that it will be useful, but WITHOUT *
* ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or       *
* FITNESS FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License *
* for more details.                                                           *
*                                                                             *
* You should have received a copy of the GNU Lesser General Public License    *
* along with this program. If not, see <http://www.gnu.org/licenses/>.        *
*******************************************************************************
* Authors: The SOFA Team and external contributors (see Authors.txt)          *
*                                                                             *
* Contact information: contact@sofa-framework.org                             *
******************************************************************************/
#ifndef PYTHONVISITOR_H
#define PYTHONVISITOR_H

#include "PythonCommon.h"

#include <sofa/simulation/Visitor.h>

namespace sofa
{

namespace simulation
{



class PythonVisitor : public Visitor
{
public:
    PythonVisitor(const core::ExecParams* params, PyObject *pyVisitor);

    virtual Result processNodeTopDown(simulation::Node* node);
    virtual void processNodeBottomUp(simulation::Node* node);

    /// It seems no possible to pass a reference variable to a python function, so repeat cannot be modified in python
    /// The python function must returns a code:
    /// -1 -> dag / NO_REPETITION
    ///  0 -> tree / NO_REPETITION
    ///  1 -> tree / REPEAT_ONCE
    ///  2 -> tree / REPEAT_ALL
    virtual bool treeTraversal(TreeTraversalRepetition& repeat);

protected:
    PyObject *m_PyVisitor;
};


} // namespace simulation

} // namespace sofa

#endif // PYTHONVISITOR_H
