linear_world.hpp

//  SuperTuxKart - a fun racing game with go-kart
//  Copyright (C) 2004-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_LINEAR_WORLD_HPP
#define HEADER_LINEAR_WORLD_HPP
 
#include "modes/world_with_rank.hpp"
#include "utils/aligned_array.hpp"
 
#include <climits>
#include <vector>
 
class SFXBase;
 
/*
 * A 'linear world' is a subcategory of world used in 'standard' races, i.e.
 * with a start line and a road that loops. This includes management of drivelines
 * and lap counting.
 * \ingroup modes
 */
class LinearWorld : public WorldWithRank
{
private:
    SFXBase     *m_last_lap_sfx;
 
    bool         m_last_lap_sfx_played;
 
    bool         m_last_lap_sfx_playing;
 
    bool         m_check_structure_compatible;
 
    int          m_fastest_lap_ticks;
 
    core::stringw m_fastest_lap_kart_name;
 
    float       m_distance_increase;
 
    float       m_live_time_difference;
 
    bool        m_valid_reference_time;
 
    /* if set then the game will auto end after this time for networking */
    float       m_finish_timeout;
 
    void  updateLiveDifference();
 
    // ------------------------------------------------------------------------
    class KartInfo
    {
    public:
        int         m_finished_laps;
 
        int         m_ticks_at_last_lap;
 
        int         m_lap_start_ticks;
 
        float       m_estimated_finish;
 
        float       m_overall_distance;
 
        float       m_wrong_way_timer;
 
        KartInfo()  { reset(); }
        // --------------------------------------------------------------------
        void reset()
        {
            m_finished_laps     = -1;
            m_lap_start_ticks   = 0;
            m_ticks_at_last_lap = INT_MAX;
            m_estimated_finish  = -1.0f;
            m_overall_distance  = 0.0f;
            m_wrong_way_timer   = 0.0f;
        }   // reset
        // --------------------------------------------------------------------
        void saveCompleteState(BareNetworkString* bns);
        // --------------------------------------------------------------------
        void restoreCompleteState(const BareNetworkString& b);
    };
    // ------------------------------------------------------------------------
 
protected:
 
    std::vector<KartInfo> m_kart_info;
 
    virtual void  checkForWrongDirection(unsigned int i, float dt);
    virtual float estimateFinishTimeForKart(AbstractKart* kart) OVERRIDE;
 
public:
                  LinearWorld();
    virtual void  init() OVERRIDE;
    virtual      ~LinearWorld();
 
    virtual void  update(int ticks) OVERRIDE;
    virtual void  updateGraphics(float dt) OVERRIDE;
    float         getDistanceDownTrackForKart(const int kart_id,
                                            bool account_for_checklines) const;
    void          updateTrackSectors();
    void          updateRacePosition();
    float         getDistanceToCenterForKart(const int kart_id) const;
    float         getEstimatedFinishTime(const int kart_id) const;
    int           getLapForKart(const int kart_id) const;
    int           getTicksAtLapForKart(const int kart_id) const;
    float         getLiveTimeDifference() const { return m_live_time_difference; }
    bool          hasValidTimeDifference() const { return m_valid_reference_time; }
 
    virtual  void getKartsDisplayInfo(
                  std::vector<RaceGUIBase::KartIconDisplayInfo> *info) OVERRIDE;
 
    virtual unsigned int getNumberOfRescuePositions() const OVERRIDE;
    virtual unsigned int getRescuePositionIndex(AbstractKart *kart) OVERRIDE;
    virtual btTransform getRescueTransform(unsigned int index) const OVERRIDE;
    virtual void  reset(bool restart=false) OVERRIDE;
    virtual void  newLap(unsigned int kart_index) OVERRIDE;
 
    // ------------------------------------------------------------------------
    virtual bool  raceHasLaps() OVERRIDE { return true; }
    // ------------------------------------------------------------------------
    virtual bool  haveBonusBoxes() OVERRIDE { return true; }
    // ------------------------------------------------------------------------
    virtual bool useChecklineRequirements() const OVERRIDE { return true; }
    // ------------------------------------------------------------------------
    int getFinishedLapsOfKart(unsigned int kart_index) const OVERRIDE
    {
        assert(kart_index < m_kart_info.size());
        return m_kart_info[kart_index].m_finished_laps;
    }   // getkartLap
    // ------------------------------------------------------------------------
    void setLastTriggeredCheckline(unsigned int kart_index, int index);
    // ------------------------------------------------------------------------
    float getOverallDistance(unsigned int kart_index) const
    {
        return m_kart_info[kart_index].m_overall_distance;
    }   // getOverallDistance
    // ------------------------------------------------------------------------
    float getFastestLap() const
    {
        return stk_config->ticks2Time(m_fastest_lap_ticks);
    }
    // ------------------------------------------------------------------------
    stringw getFastestLapKartName() const
    {
        return m_fastest_lap_kart_name;
    }
    // ------------------------------------------------------------------------
    int getFastestLapTicks() const
    {
        return m_fastest_lap_ticks;
    }
    // ------------------------------------------------------------------------
    void setFastestLapTicks(int ticks)
    {
        m_fastest_lap_ticks = ticks;
    }
    // ------------------------------------------------------------------------
    void setFastestKartName(const stringw& name)
    {
        m_fastest_lap_kart_name = name;
    }
    // ------------------------------------------------------------------------
    virtual std::pair<uint32_t, uint32_t> getGameStartedProgress() const
        OVERRIDE;
    // ------------------------------------------------------------------------
    virtual void saveCompleteState(BareNetworkString* bns,
                                   STKPeer* peer) OVERRIDE;
    // ------------------------------------------------------------------------
    virtual void restoreCompleteState(const BareNetworkString& b) OVERRIDE;
    // ------------------------------------------------------------------------
    void updateCheckLinesServer(int check_id, int kart_id);
    // ------------------------------------------------------------------------
    void updateCheckLinesClient(const BareNetworkString& b);
    // ------------------------------------------------------------------------
    void handleServerCheckStructureCount(unsigned count);
    // ------------------------------------------------------------------------
    virtual bool showLapsTarget() OVERRIDE { return true; }
};   // LinearWorld
 
#endif