V-Gears/QGearsMain/include/core/XmlMapFile.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 "XmlFile.h"

/**
 * Handles XML map files.
 */
class XmlMapFile : public XmlFile{

    public:

        /**
         * Constructor.
         *
         * @param file[in] Path to the XML map file.
         */
        explicit XmlMapFile(const Ogre::String& file);

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

        /**
         * Parses the file and loads the map data.
         */
        void LoadMap();

        /**
         * Retrieves the path to the map walkmesh file.
         *
         * @return The path to the map walkmesh file. If there is no walkmesh
         * associated to the map, an error  message will be written to console
         * and an empty string will be returned.
         */
        const Ogre::String GetWalkmeshFileName();
};