GNode.h

Go to the documentation of this file.

/******************************************************************************
*       SOFA, Simulation Open-Framework Architecture, version 1.0 beta 3      *
*                (c) 2006-2008 MGH, INRIA, USTL, UJF, CNRS                    *
*                                                                             *
* This library 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 library 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 library; if not, write to the Free Software Foundation,     *
* Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301 USA.          *
*******************************************************************************
*                               SOFA :: Modules                               *
*                                                                             *
* Authors: The SOFA Team and external contributors (see Authors.txt)          *
*                                                                             *
* Contact information: contact@sofa-framework.org                             *
******************************************************************************/
#ifndef SOFA_SIMULATION_TREE_GNODE_H
#define SOFA_SIMULATION_TREE_GNODE_H

#include <sofa/simulation/common/Node.h>
#include <sofa/simulation/tree/MutationListener.h>
#include <sofa/simulation/tree/xml/NodeElement.h>
#include <stdlib.h>
#include <vector>
#include <string>
#include <iostream>


using std::cout;
using std::endl;

namespace sofa
{

namespace simulation
{
class Visitor;
class VisitorScheduler;

namespace tree
{

class MutationListener;

class GNode : public simulation::Node, public core::objectmodel::BaseNode
{
public:
    GNode( const std::string& name="", GNode* parent=NULL  );

    virtual ~GNode();

    //virtual const char* getTypeName() const { return "GNODE"; }
    void reinit();
    
    virtual void addChild(GNode* node);

    virtual void removeChild(GNode* node);

    virtual void addChild(BaseNode* node);

    virtual void removeChild(BaseNode* node);

    virtual void moveChild(GNode* obj);



//    virtual void executeVisitor(Visitor* action);

    core::objectmodel::BaseNode* getParent();

    const core::objectmodel::BaseNode* getParent() const;
    
    sofa::helper::vector< core::objectmodel::BaseNode* > getChildren();

    const sofa::helper::vector< core::objectmodel::BaseNode* > getChildren() const;


    GNode* getChild(const std::string& name) const;
    
    
    GNode* getTreeNode(const std::string& name) const;

    

    virtual bool addObject(core::objectmodel::BaseObject* obj){ return simulation::Node::addObject(obj); }

    virtual bool removeObject(core::objectmodel::BaseObject* obj){ return simulation::Node::removeObject(obj); }
    
    virtual void moveObject(core::objectmodel::BaseObject* obj){ simulation::Node::moveObject(obj); }
        
    virtual core::objectmodel::BaseObject* getMechanicalState() const;
    
    virtual core::componentmodel::topology::Topology* getTopology() const;
    
    virtual core::componentmodel::topology::BaseMeshTopology* getMeshTopology() const;

    virtual core::objectmodel::BaseObject* getShader() const;

    const BaseContext* getContext() const { return simulation::Node::getContext(); }
    BaseContext* getContext() { return simulation::Node::getContext(); }




    virtual void initVisualContext();
    
    virtual void updateContext();

    virtual void updateVisualContext(int FILTER=0);
    
    virtual void updateSimulationContext();
    

    void addTime(ctime_t t, const std::string& s, core::objectmodel::BaseObject* obj);

    ctime_t endTime(ctime_t t0, const std::string& s, core::objectmodel::BaseObject* obj);

    void addTime(ctime_t t, const std::string& s, core::objectmodel::BaseObject* obj, core::objectmodel::BaseObject* parent);

    ctime_t endTime(ctime_t t0, const std::string& s, core::objectmodel::BaseObject* obj, core::objectmodel::BaseObject* parent);
    



    std::string getPathName() const;

    virtual void* getObject(const sofa::core::objectmodel::ClassInfo& class_info, SearchDirection dir = SearchUp) const;

    virtual void* getObject(const sofa::core::objectmodel::ClassInfo& class_info, const std::string& path) const;

    virtual void getObjects(const sofa::core::objectmodel::ClassInfo& class_info, GetObjectsCallBack& container, SearchDirection dir = SearchUp) const;

    void addListener(MutationListener* obj);

    void removeListener(MutationListener* obj);
    
    
    // should this be public ?
    Single<GNode> parent;
    Sequence<GNode> child;
    typedef Sequence<GNode>::iterator ChildIterator;
    


    static void create(GNode*& obj, xml::Element<core::objectmodel::BaseNode>* arg)
    {
    obj = new GNode();
    obj->parse(arg);
    }

protected:


    virtual void doAddChild(GNode* node);
    void doRemoveChild(GNode* node);

    void notifyAddChild(GNode* node);
    void notifyRemoveChild(GNode* node);
    void notifyMoveChild(GNode* node, GNode* prev);

    void doExecuteVisitor(simulation::Visitor* action);
    // VisitorScheduler can use doExecuteVisitor() method
    friend class simulation::VisitorScheduler;

    Sequence<MutationListener> listener;

    
protected:
/*    virtual void doAddObject(core::objectmodel::BaseObject* obj);
    virtual void doRemoveObject(core::objectmodel::BaseObject* obj);*/
    void notifyAddObject(core::objectmodel::BaseObject* obj);
    void notifyRemoveObject(core::objectmodel::BaseObject* obj);
    void notifyMoveObject(core::objectmodel::BaseObject* obj, GNode* prev);
};

} // namespace tree

} // namespace simulation

} // namespace sofa

#endif