track_manager.hpp

//
//  SuperTuxKart - a fun racing game with go-kart
//  Copyright (C) 2006-2015 SuperTuxKart-Team
//
//  This program is free software; you can redistribute it and/or
//  modify it under the terms of the GNU General Public License
//  as published by the Free Software Foundation; either version 3
//  of the License, or (at your option) any later version.
//
//  This program 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.
//
//  You should have received a copy of the GNU General Public License
//  along with this program; if not, write to the Free Software
//  Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.
 
#ifndef HEADER_TRACK_MANAGER_HPP
#define HEADER_TRACK_MANAGER_HPP
 
#include "config/favorite_status.hpp"
 
#include <string>
#include <vector>
#include <map>
 
class Track;
 
class TrackManager
{
private:
    enum TrackGroupType
    {
        RACING_TRACK = 0,
        BATTLE_ARENA,
        SOCCER_ARENA
    };
 
    static std::vector<std::string>          m_track_search_path;
 
    std::vector<std::string>                 m_all_track_dirs;
 
    typedef std::vector<Track*>              Tracks;
 
    Tracks                                   m_tracks;
 
    typedef std::map<std::string, std::vector<int> > Group2Indices;
    Group2Indices                            m_track_groups;
 
    Group2Indices                            m_arena_groups;
 
    Group2Indices                            m_soccer_arena_groups;
 
    std::vector<std::string>                 m_track_group_names;
 
    std::vector<std::string>                 m_arena_group_names;
 
    std::vector<std::string>                 m_soccer_arena_group_names;
 
    Group2Indices                            m_track_groups_no_custom;
    Group2Indices                            m_arena_groups_no_custom;
    Group2Indices                            m_soccer_arena_groups_no_custom;
 
    std::vector<bool>                        m_track_avail;
 
    FavoriteStatus                     *m_current_favorite_status;
 
    void updateAllGroups(const Track* track);
    void updateGroups(TrackGroupType type, const Track* track);
    void removeTrackFromGroups(TrackGroupType type, const Track* track);
 
public:
                TrackManager();
               ~TrackManager();
    static void removeTrackSearchDirs();
    static void addTrackSearchDir(const std::string &dir);
 
    void setFavoriteTrackStatus(FavoriteStatus *status);
 
    void clearFavoriteTrackStatus();
 
    std::vector<std::string> getAllTrackIdentifiers();
 
    void  loadTrackList();
    void  removeTrack(const std::string &ident);
    bool  loadTrack(const std::string& dirname);
    void  removeAllCachedData();
    int   getNumberOfRaceTracks() const;
    Track* getTrack(const std::string& ident) const;
    // ------------------------------------------------------------------------
    void setUnavailableTracks(const std::vector<std::string> &tracks);
    // ------------------------------------------------------------------------
    const std::vector<std::string>* getAllTrackDirs() const
    {
        return &m_all_track_dirs;
    }   // getAllTrackDirs
    // ------------------------------------------------------------------------
    const std::vector<std::string>& getAllTrackGroups() const
    {
        return m_track_group_names;
    }   // getAllTrackGroups
    // ------------------------------------------------------------------------
    const std::vector<std::string>&
                  getAllArenaGroups(bool soccer_arena=false) const
    {
        return soccer_arena ? m_soccer_arena_group_names : m_arena_group_names;
    }   // getAllArenaGroups
    // ------------------------------------------------------------------------
    size_t getNumberOfTracks() const { return m_tracks.size(); }
    // ------------------------------------------------------------------------
    Track* getTrack(unsigned int index) const { return m_tracks[index];}
    // ------------------------------------------------------------------------
    int getTrackIndexByIdent(const std::string& ident) const;
    // ------------------------------------------------------------------------
    bool isAvailable(unsigned int n) const {return m_track_avail[n];}
    // ------------------------------------------------------------------------
    const std::vector<int>& getTracksInGroup(const std::string& g)
    {
        return m_track_groups[g];
    }   // getTracksInGroup
    // ------------------------------------------------------------------------
    const std::vector<int>&
        getArenasInGroup(const std::string& g, bool soccer_arena=false)
    {
        return soccer_arena ? m_soccer_arena_groups[g] : m_arena_groups[g];
    }   // getArenasInGroup
    // ------------------------------------------------------------------------
    void onDemandLoadTrackScreenshots();
    // ------------------------------------------------------------------------
    void updateScreenshotCache();
};   // TrackManager
 
extern TrackManager* track_manager;
 
#endif   // HEADER_TRACK_MANAGER_HPP