object.h

Go to the documentation of this file.

/***************************************************************************
 *   Copyright (C) 2006-2012 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, bool deepsearch = true) const;

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

        void setDefaultAction(const std::string& identifier);

        Action* getDefaultAction() const;

        void setPather(IPather* pather);

        IPather* getPather() const;

        Object* getInherited() const;

        void adoptVisual(IVisual* visual);

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

        void setBlocking(bool blocking);

        bool isBlocking() const;

        void setStatic(bool stat);

        bool isStatic() const;

        void setFilename(const std::string& file);
        const std::string& getFilename() const;

        void setCellStackPosition(uint8_t position);

        uint8_t getCellStackPosition() const;

        bool isSpecialCost() const;

        void setCostId(const std::string& cost);

        std::string getCostId() const;

        void setCost(double cost);

        double getCost() const;

        bool isSpecialSpeed() const;

        void setSpeed(double cost);

        double getSpeed() const;

        bool isMultiObject() const;

        void addMultiPartId(const std::string& partId);

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

        void removeMultiPartId(const std::string& partId);

        void removeAllMultiPartIds();

        bool isMultiPart() const;

        void setMultiPart(bool part);

        void addMultiPart(Object* obj);

        std::set<Object*> getMultiParts() const;

        void removeMultiPart(Object* obj);

        void removeMultiParts();

        void addMultiPartCoordinate(int32_t rotation, ModelCoordinate coord);

        std::multimap<int32_t, ModelCoordinate> getMultiPartCoordinates() const;

        std::vector<ModelCoordinate> getMultiPartCoordinates(int32_t rotation) const;

        std::vector<ModelCoordinate> getMultiObjectCoordinates(int32_t rotation) const;

        void setRotationAnchor(const ExactModelCoordinate& anchor);
        
        ExactModelCoordinate getRotationAnchor() const;

        void setRestrictedRotation(bool restrict);

        bool isRestrictedRotation() const;

        int32_t getRestrictedRotation(int32_t rotation);

        void setZStepRange(int32_t zRange);

        int32_t getZStepRange() const;

        void setArea(const std::string& id);

        std::string getArea() const;

        void addWalkableArea(const std::string& id);

        void removeWalkableArea(const std::string& id);

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

        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;

        IVisual* m_visual;

        class BasicObjectProperty {
        public:
            BasicObjectProperty();
        
            ~BasicObjectProperty();

            std::string m_area;

            std::map<std::string, Action*>* m_actions;

            Action* m_defaultAction;

            bool m_blocking;

            //remove this with a if (MovableObjectProperty)
            bool m_static;

            uint8_t m_cellStack;
        };

        class MovableObjectProperty {
        public:
            MovableObjectProperty();
        
            ~MovableObjectProperty();

            IPather* m_pather;

            std::string m_costId;

            double m_cost;

            double m_speed;

            int32_t m_zRange;
        
            std::list<std::string> m_walkableAreas;
        };

        class MultiObjectProperty {
        public:
            MultiObjectProperty();
        
            ~MultiObjectProperty();

            bool m_multiPart;

            bool m_restrictedRotation;

            std::list<std::string> m_multiPartIds;

            ExactModelCoordinate m_rotationAnchor;

            std::set<Object*> m_multiParts;

            type_angle2id m_partAngleMap;

            type_angle2id m_multiAngleMap;

            std::multimap<int32_t, ModelCoordinate> m_multiPartCoordinates;

            std::multimap<int32_t, ModelCoordinate> m_multiObjectCoordinates;
        };

        BasicObjectProperty* m_basicProperty;
        MovableObjectProperty* m_moveProperty;
        MultiObjectProperty* m_multiProperty;
    };

} //FIFE
#endif