object.h

/***************************************************************************
 *   Copyright (C) 2006-2011 by the FIFE team                              *
 *   http://www.fifengine.net                                              *
 *   This file is part of FIFE.                                            *
 *                                                                         *
 *   FIFE 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          *
 ***************************************************************************/

#ifndef FIFE_PROTOTYPE_H
#define FIFE_PROTOTYPE_H

// Standard C++ library includes
#include <string>
#include <map>
#include <list>

// 3rd party library includes

// FIFE includes
// These includes are split up in two parts, separated by one empty line
// First block: files included from the FIFE root src directory
// Second block: files included from the same folder
#include "util/resource/resource.h"
#include "util/math/angles.h"

namespace FIFE {

    class Action;
    class IPather;
    class IVisual;

    class Object {
    public:
        Object(const std::string& identifier, const std::string& name_space, Object* inherited=NULL);

        ~Object();

        const std::string& getId() const { return m_id; }
        const std::string& getNamespace() const { return m_namespace; }

        void setId(const std::string& id) { m_id = id; }

        Action* createAction(const std::string& identifier, bool is_default=false);

        Action* getAction(const std::string& identifier) const;

        std::list<std::string> getActionIds() const;

        Action* getDefaultAction() const { return m_defaultaction; }

        void setPather(IPather* pather);

        IPather* getPather() const { return m_pather; }

        Object* getInherited() const { return m_inherited; }

        void adoptVisual(IVisual* visual) { m_visual = visual; }

        template<typename T> T* getVisual() const { return reinterpret_cast<T*>(m_visual); }

        void setBlocking(bool blocking) { m_blocking = blocking; }

        bool isBlocking() const;

        void setStatic(bool stat) { m_static = stat; }

        bool isStatic() const;

        void setFilename(const std::string& file) { m_filename = file; }
        const std::string& getFilename() const { return m_filename; }

        bool operator==(const Object& obj) const;
        bool operator!=(const Object& obj) const;

    private:
        std::string m_id;
        std::string m_namespace;
        std::string m_filename;
        Object* m_inherited;
        std::map<std::string, Action*>* m_actions;
        bool m_blocking;
        bool m_static;
        IPather* m_pather;
        IVisual* m_visual;
        Action* m_defaultaction;
    };

} //FIFE
#endif