SG_Node.h

Go to the documentation of this file.

/*
 * $Id: SG_Node.h 35082 2011-02-22 19:30:37Z jesterking $
 *
 * ***** BEGIN GPL LICENSE BLOCK *****
 *
 * This program is free software; you can redistribute it and/or
 * modify it under the terms of the GNU General Public License
 * as published by the Free Software Foundation; either version 2
 * 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 General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program; if not, write to the Free Software Foundation,
 * Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
 *
 * The Original Code is Copyright (C) 2001-2002 by NaN Holding BV.
 * All rights reserved.
 *
 * The Original Code is: all of this file.
 *
 * Contributor(s): none yet.
 *
 * ***** END GPL LICENSE BLOCK *****
 */

#ifndef __SG_NODE_H
#define __SG_NODE_H

#include "SG_Spatial.h"
#include <vector>

typedef std::vector<SG_Node*> NodeList;

class SG_Node : public SG_Spatial
{
public:
        SG_Node(
                void* clientobj,
                void* clientinfo,
                SG_Callbacks& callbacks
        );

        SG_Node(
                const SG_Node & other
        );

        virtual ~SG_Node();


                void    
        AddChild(
                SG_Node* child
        );

                void    
        RemoveChild(
                SG_Node* child
        );

                bool
        IsAncessor(
                const SG_Node* child
        ) const;
        NodeList& GetSGChildren()
        {
                return this->m_children;
        }

        const NodeList& GetSGChildren() const
        {
                return this->m_children;
        }

        void ClearSGChildren()
        {
                m_children.clear();
        }

        SG_Node* GetSGParent() const 
        { 
                return m_SGparent;
        }

        void SetSGParent(SG_Node* parent)
        {
                m_SGparent = parent;
        }

        const 
                SG_Node* 
        GetRootSGParent(
        ) const;

                void                            
        DisconnectFromParent(
        );

        bool IsVertexParent()
        {
                if (m_parent_relation)
                {
                        return m_parent_relation->IsVertexRelation();
                }
                return false;
        }


        bool IsSlowParent()
        {
                if (m_parent_relation)
                {
                        return m_parent_relation->IsSlowRelation();
                }
                return false;
        }




                void            
        UpdateWorldData(
                double time,
                bool parentUpdated=false
        );

                void            
        SetSimulatedTime(
                double time,
                bool recurse
        );

        bool Schedule(SG_QList& head)
        {
                // Put top parent in front of list to make sure they are updated before their
                // children => the children will be udpated and removed from the list before
                // we get to them, should they be in the list too.
                return (m_SGparent)?head.AddBack(this):head.AddFront(this);
        }

        static SG_Node* GetNextScheduled(SG_QList& head)
        {
                return static_cast<SG_Node*>(head.Remove());
        }

        bool Reschedule(SG_QList& head)
        {
                return head.QAddBack(this);
        }

        static SG_Node* GetNextRescheduled(SG_QList& head)
        {
                return static_cast<SG_Node*>(head.QRemove());
        }

                SG_Node*        
        GetSGReplica(
        );

                void            
        Destruct(
        );
        
private:

                void            
        ProcessSGReplica(
                SG_Node** replica
        );

        NodeList m_children;

        SG_Node* m_SGparent;


#ifdef WITH_CXX_GUARDEDALLOC
public:
        void *operator new(size_t num_bytes) { return MEM_mallocN(num_bytes, "GE:SG_Node"); }
        void operator delete( void *mem ) { MEM_freeN(mem); }
#endif
};

#endif //__SG_NODE_H