instance.h

/***************************************************************************
 *   Copyright (C) 2005-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_INSTANCE_H
#define FIFE_INSTANCE_H

// Standard C++ library includes
#include <vector>

// 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/base/fifeclass.h"

#include "model/metamodel/object.h"
#include "model/metamodel/ivisual.h"

#include "location.h"


namespace FIFE {

    class Layer;
    class Action;
    class Instance;
    class ActionInfo;
    class SayInfo;
    class TimeProvider;

    class InstanceActionListener {
    public:
        virtual ~InstanceActionListener() {};
        virtual void onInstanceActionFinished(Instance* instance, Action* action) = 0;
        virtual void onInstanceActionFrame(Instance* instance, Action* action, int32_t frame) = 0;
    };

    enum InstanceChangeType {
        ICHANGE_NO_CHANGES = 0x0000,
        ICHANGE_LOC = 0x0001,
        ICHANGE_FACING_LOC = 0x0002,
        ICHANGE_SPEED = 0x0004,
        ICHANGE_ACTION = 0x0008,
        ICHANGE_TIME_MULTIPLIER = 0x0010,
        ICHANGE_SAYTEXT = 0x0020,
        ICHANGE_ROTATION = 0x0040,
        ICHANGE_BLOCK = 0x0080,
        ICHANGE_CELL = 0x0100
    };
    typedef uint32_t InstanceChangeInfo;

    class InstanceChangeListener {
    public:
        virtual ~InstanceChangeListener() {};
        virtual void onInstanceChanged(Instance* instance, InstanceChangeInfo info) = 0;
    };


    class InstanceDeleteListener {
    public:
        virtual ~InstanceDeleteListener() {};
        virtual void onInstanceDeleted(Instance* instance) =0;
    };

    class Instance : public FifeClass, public InstanceDeleteListener {
    public:

        Instance(Object* object, const Location& location, const std::string& identifier="");

        virtual ~Instance();

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

        void setId(const std::string& identifier="");

        Object* getObject() { return m_object; }

        void setLocation(const Location& loc);

        Location getLocation() const { return m_location; }

        Location& getLocationRef() { return m_location; }

        Location getTargetLocation() const;

        void setFacingLocation(const Location& loc);

        Location getFacingLocation();

        void setRotation(int32_t rotation);

        int32_t getRotation() const { return m_rotation; }

        Location& getFacingLocationRef();

        void setBlocking(bool blocking);

        bool isBlocking() const;

        void setOverrideBlocking(bool overblock) { m_override_blocking = overblock; }

        bool isOverrideBlocking() const { return m_override_blocking; }

        void callOnActionFrame(Action* action, int32_t frame);

        void addActionListener(InstanceActionListener* listener);

        void removeActionListener(InstanceActionListener* listener);

        void addChangeListener(InstanceChangeListener* listener);

        void removeChangeListener(InstanceChangeListener* listener);

        void addDeleteListener(InstanceDeleteListener* listener);

        void removeDeleteListener(InstanceDeleteListener* listener);

        Action* getCurrentAction() const;

        double getMovementSpeed() const;

        uint32_t getActionRuntime();

        void setActionRuntime(uint32_t time_offset);

        void move(const std::string& action_name, const Location& target, const double speed);

        void act(const std::string& action_name, const Location& direction, bool repeating=false);

        void say(const std::string& text, uint32_t duration=0);

        void follow(const std::string& action_name, Instance* leader, const double speed);

        const std::string* getSayText() const;

        InstanceChangeInfo update();

        bool isActive() const;

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

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

        void setTimeMultiplier(float multip);

        float getTimeMultiplier();

        float getTotalTimeMultiplier();

        uint32_t getRuntime();

        void refresh();

        inline InstanceChangeInfo getChangeInfo();

        void onInstanceDeleted(Instance* instance);

    private:
        std::string m_id;

        // The rotation offset of this instance. This is in addition to possible camera rotation and
        // intended for setting, for example, a rotation of a tile.
        int32_t m_rotation;

        class InstanceActivity {
        public:
            InstanceActivity(Instance& source);
            ~InstanceActivity();

            // ----- Fields related to change tracking -----
            // updates cached variables, marks changes
            void update(Instance& source);
            // location on previous round
            Location m_location;
            // rotation on previous round
            int32_t m_rotation;
            // facing location on previous round
            Location m_facinglocation;
            // action on previous round. @NOTE: might become invalid, only used for address comparison
            Action* m_action;
            // speed on previous round
            double m_speed;
            // time multiplier on previous round
            float m_timemultiplier;
            // say text on previous round
            std::string m_saytxt;
            // listeners for changes
            std::vector<InstanceChangeListener*> m_changelisteners;

            // ----- Fields related to generic activity -----
            // listeners for action related events
            std::vector<InstanceActionListener*> m_actionlisteners;
            // action information, allocated when actions are bind
            ActionInfo* m_actioninfo;
            // text to say + duration, allocated when something is said
            SayInfo* m_sayinfo;
            // time scaler for this instance
            TimeProvider* m_timeprovider;
            // blocking status on previous round
            bool m_blocking;
        };
        InstanceActivity* m_activity;
        // bitmask stating current changes
        InstanceChangeInfo m_changeinfo;
        // listeners for deletion of the instance
        std::vector<InstanceDeleteListener*> m_deletelisteners;

        // object where instantiated from
        Object* m_object;
        // current location
        Location m_location;
        // current facing location. Just a pointer to save space e.g. on tiles
        Location* m_facinglocation;
        // instance visualization
        IVisual* m_visual;
        // instance blocking info
        bool m_blocking;
        // allow to override the blocking property
        bool m_override_blocking;

        Instance(const Instance&);
        Instance& operator=(const Instance&);
        // Finalize current action
        void finalizeAction();
        // Initialize action for use
        void initializeAction(const std::string& action_name);
        // Moves instance. Returns true if finished
        bool process_movement();
        // Calculates movement based current location and speed
        void calcMovement();
        // rebinds time provider based on new location
        void bindTimeProvider();
        // called when instance has been changed. Causes instance to create InstanceActivity
        void initializeChanges();
    };

    inline InstanceChangeInfo Instance::getChangeInfo() {
        if (m_activity) {
            return m_changeinfo;
        }
        return ICHANGE_NO_CHANGES;
    }
} // FIFE

#endif