V-Gears/V-Gears/include/map/VGearsMapFile.h

/*
 * Copyright (C) 2022 The V-Gears Team
 *
 * This file is part of V-Gears
 *
 * V-Gears is free software: you can redistribute it and/or modify it under
 * terms of the GNU General Public License as published by the Free Software
 * Foundation, version 3.0 (GPLv3) of the License.
 *
 * V-Gears 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.
 */

#pragma once

#include "common/VGearsResource.h"
#include "core/EntityPoint.h"
#include "core/EntityTrigger.h"

namespace VGears{

    /**
     * Handles map files.
     */
    class MapFile : public Resource{
        
        public:

            /**
             * The type of resource
             */
            static const String RESOURCE_TYPE;

            /**
             * Constructor.
             *
             * @param[in] creator Pointer to the ResourceManager that is creating this resource.
             * @param[in] name The unique name of the resource.
             * @param[in] handle @todo Understand and document.
             * @param[in] group The name of the resource group to which this resource belong.
             * @param[in] is_manual True if the resource is manually loaded, false otherwise.
             * @param[in] loader Pointer to a ManualResourceLoader implementation which will be
             * called when the Resource wishes to load (should be supplied if is_manual is set to
             * true). It can be null, but the Resource will never be able to reload if anything
             * ever causes it to unload. Therefore provision of a proper ManualResourceLoader
             * instance is strongly recommended.
             */
            MapFile(
              Ogre::ResourceManager* creator, const String &name, Ogre::ResourceHandle handle,
              const String& group, bool is_manual = false, Ogre::ManualResourceLoader* loader = NULL
            );

            /**
            * Destructor.
            */
            virtual ~MapFile();

            typedef EntityPoint Point;

            typedef std::vector<Point> PointList;

            typedef EntityTrigger Trigger;

            typedef std::vector<Trigger> TriggerList;

            /**
             * Retrieves the map script name.
             *
             * @return The script name.
             */
            virtual const String& GetScriptName() const;

            /**
             * Retrieves the map background file name.
             *
             * @return The background file name.
             */
            virtual const String& GetBackground2dName() const;

            /**
             * Retrieves the map texts file name.
             *
             * @return The texts file name.
             */
            virtual const String& GetTextsName() const;

            /**
             * Retrieves the map walkmesh file name.
             *
             * @return The walkmesh file name.
             */
            virtual const String& GetWalkmeshName() const;

            /**
             * Retrieves the map forward direction.
             *
             * The forward direction is the direction the playable character moves when 'up' is
             * pressed.
             *
             * @return The forward direction.
             */
            virtual const Ogre::Real& GetForwardDirection() const;

            /**
             * Retrieves the list of entity points in the map.
             *
             * @return The list of entity points in the map.
             */
            virtual PointList& GetPoints();

            /**
             * Retrieves the map triggers.
             *
             * @return The list of triggers.
             */
            virtual TriggerList& GetTriggers();

            /**
             * Sets the map script name.
             *
             * @param[in] script_name The script name.
             */
            virtual void SetScriptName(const String& script_name);

            /**
             * Sets the map background file name.
             *
             * @param[in] background2d_name The background file name.
             */
            virtual void SetBackground2dName(const String& background2d_name);

            /**
             * Sets the map field texts file name.
             *
             * @param[in] texts The texts file name.
             */
            virtual void SetTextsName(const String& texts_name);

            /**
             * Sets the map walkmesh file name.
             *
             * @param[in] walkmesh_name The walkmesh file name.
             */
            virtual void SetWalkmeshName(const String& walkmesh_name);

            /**
             * Sets the map forward direction.
             *
             * The forward direction is the direction the playable character moves when 'up' is
             * pressed.
             *
             * @param[in] forward_direction The forward direction.
             */
            virtual void SetForwardDirection(const Ogre::Real& forward_direction);

        protected:

            /**
             * Loads the file.
             */
            virtual void loadImpl() override;

            /**
             * Unloads the file.
             */
            virtual void unloadImpl() override;

            /**
             * Calculates the size of the map.
             *
             * It's the size of the tiles, script, walkmesh and forward direction.
             *
             * @return The size of the map.
             */
            virtual size_t calculateSize() const;

        private:

            /**
             * The script file name.
             */
            String script_name_;

            /**
             * The background file name.
             */
            String background_2d_name_;

            /**
             * The background file name.
             */
            String texts_name_;

            /**
             * The walkmesh file name.
             */
            String walkmesh_name_;

            /**
             * The forward direction.
             */
            Ogre::Real forward_direction_;

            /**
             * The list of entity points.
             */
            PointList points_;

            /**
             * The list of triggers.
             */
            TriggerList triggers_;
    };
    
    typedef Ogre::SharedPtr<MapFile> MapFilePtr;
}