Composite.hpp

Go to the documentation of this file.

/*
SagaEngine library
Copyright (c) 2002-2006 Skalden Studio AS

This software is provided 'as-is', without any express or implied 
warranty. In no event will the authors be held liable for any 
damages arising from the use of this software.

Permission is granted to distribute the library under the terms of the 
Q Public License version 1.0. Be sure to read and understand the license
before using the library. It should be included here, or you may read it
at http://www.trolltech.com/products/qt/licenses/licensing/qpl

The original version of this library can be located at:
http://www.sagaengine.com/

Rune Myrland
rune@skalden.com
*/


#ifndef Composite_hpp
#define Composite_hpp

#include "comp.hpp"
#include "RefPtr.hpp"
#include "comp/list/ComponentList.hpp"
#include "comp/list/CompositeList.hpp"


namespace se_core {
    class _SeCoreExport Composite {
    public:
        typedef RefPtr<Composite> RefPtr;
        typedef Composite* id_type;

        Composite(const CompositeFactory* factory);
        Composite(const CompositeFactory* factory, const char* name);
        virtual ~Composite();

        RefPtr& ref() { return ptr_; }

        const char* name() const;
        int type() const;

        id_type id() const { return (id_type)this; }

        void init(bool doTraverseChildren = true);
        void cleanup(bool doTraverseChildren = true);

        Component* component(int type);
        const Component* component(int type) const;

        const CompositeFactory* factory() { return factory_; }
        void setFactory(const CompositeFactory* f) { factory_ = f; }

        bool hasParent() const { return parent_ != 0; }

        Composite* parent() {
            return parent_;
        }

        void setParent(Composite& p);

        void resetParent();

        const CompositeList& children() const { return children_; }


        void setActive(bool state, bool doTraverseChildren = true);


        bool isActive() const { return isActive_; }

        void setTag(int t) { tag_ = t; }
        int tag() const { return tag_; }

        virtual void scheduleForDestruction();

        bool isDead() const { return isDead_; }

        void zoneChanged(int type, Composite* newZone, Composite* oldZone);

        void releaseComponents();

    private:
        friend class Component;
        // The Component adds and removes itself
        void addComponent(Component& c);
        void removeComponent(Component& c);


    protected:

        void addChild(Composite& node);

        void removeChild(Composite& node);

        const char* name_;
        const CompositeFactory* factory_;
        int tag_;
        bool isActive_;
        bool isDead_;

        ComponentList components_;

        Composite* parent_;
        CompositeList children_;
        enum { FAST_COMPONENT_COUNT = 16 };
        Component* fastComponents_[16];


        RefPtr ptr_;

    };

}


#endif

---

Home Page | SagaEngine trunk (updated nightly) reference generated Sun Dec 2 20:06:10 2007 by Doxygen version 1.3.9.1.