fov.h

Go to the documentation of this file.

//       _________ __                 __
//      /   _____//  |_____________ _/  |______     ____  __ __  ______
//      \_____  \\   __\_  __ \__  \\   __\__  \   / ___\|  |  \/  ___/
//      /        \|  |  |  | \// __ \|  |  / __ \_/ /_/  >  |  /\___ |
//     /_______  /|__|  |__|  (____  /__| (____  /\___  /|____//____  >
//             \/                  \/          \//_____/            \/
//  ______________________                           ______________________
//                        T H E   W A R   B E G I N S
//         Stratagus - A free fantasy real time strategy game engine
//
//
//      (c) Copyright 2020-2021 by Alyokhin
//
//      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; only version 2 of the License.
//
//      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 __FOV_H__
#define __FOV_H__
 
#include <functional>
#include <queue>
#include <set>
#include "vec2i.h"
#include "map.h"
#include "tileset.h"
#include "settings.h"
 
 
class CFieldOfView
{
public:
        void Clean()
        {
                MarkedTilesCache.clear();
        }
 
        void Refresh(const CPlayer &player, const CUnit &unit, const Vec2i &pos, const uint16_t width, 
                                 const uint16_t height, const uint16_t range, MapMarkerFunc *marker);
 
        bool SetType(const FieldOfViewTypes fov_type);
        FieldOfViewTypes GetType() const;
 
        void SetOpaqueFields(const uint16_t flags);
        uint16_t GetOpaqueFields() const;
        void ResetAdditionalOpaqueFields();
 
protected:
private:
        struct SColumnPiece {
                SColumnPiece(int16_t xValue, Vec2i top, Vec2i bottom) : col(xValue), TopVector(top), BottomVector(bottom) {}
                int16_t col;
                Vec2i TopVector;
                Vec2i BottomVector;
        };
 
        void ProceedSimpleRadial(const CPlayer &player, const Vec2i &pos, const int16_t w, const int16_t h, 
                                                         int16_t range, MapMarkerFunc *marker) const;
        void ProceedShadowCasting(const Vec2i &spectatorPos, const uint16_t width, const uint16_t height, const uint16_t range);
        void ProceedRaysCast(const uint8_t octant, const Vec2i &origin, const uint16_t width, const uint16_t range);
        void RefreshOctant(const uint8_t octant, const Vec2i &origin, const uint16_t range);
        void CalcFoVForColumnPiece(const int16_t col, Vec2i &topVector, Vec2i &bottomVector,
                                                           const uint16_t range, std::queue<SColumnPiece> &wrkQueue);
        int16_t CalcRow_ByVector(const bool isTop, const int16_t x, const Vec2i &vector) const;
 
        bool SetCurrentTile(const int16_t col, const int16_t row);
        bool IsTileOpaque() const;
        void MarkTile();
 
        void PrepareShadowCaster(const CPlayer &player, const CUnit &unit, const Vec2i &pos, MapMarkerFunc *marker);
        void ResetShadowCaster();
        void PrepareCache(const Vec2i pos, const uint16_t width, const uint16_t height, const uint16_t range);
 
        void SetEnvironment(const uint8_t octant, const Vec2i &origin);
        void ResetEnvironment();
        void ProjectCurrentTile(const int16_t col, const int16_t row);
 
private:
        struct FieldOfViewSettings 
        {
                uint16_t                 OpaqueFields {MapFieldOpaque};                                 
        } Settings;
 
        Vec2i            currTilePos  {0, 0};   
        uint8_t                  currOctant   {0};              
        Vec2i                    Origin           {0, 0};       
        uint16_t                 OpaqueFields {0};              
        
        const CPlayer   *Player           {nullptr};    
        const CUnit     *Unit             {nullptr};    
        MapMarkerFunc   *map_setFoV   {nullptr};        
 
        std::vector<uint8_t> MarkedTilesCache;  
};
 
/*----------------------------------------------------------------------------
--  Variables
----------------------------------------------------------------------------*/
 
extern CFieldOfView FieldOfView;
 
/*----------------------------------------------------------------------------
--  Functions
----------------------------------------------------------------------------*/
 
inline bool CFieldOfView::SetCurrentTile(const int16_t col, const int16_t row)
{
        ProjectCurrentTile(col, row);
        if (Map.Info.IsPointOnMap(currTilePos.x, currTilePos.y)) {
                return true;
        } else {
                currTilePos = {0, 0};
                return false;
        }
}
 
inline bool CFieldOfView::IsTileOpaque() const
{
        return (Map.Field(currTilePos.x, currTilePos.y)->Flags & OpaqueFields);
}
 
inline void CFieldOfView::MarkTile()
{
        const size_t index = Map.getIndex(currTilePos.x, currTilePos.y);
        if (!MarkedTilesCache[index]) {
                map_setFoV(*Player, index);
                MarkedTilesCache[index] = 1;
        } 
}
 
inline void CFieldOfView::ProjectCurrentTile(const int16_t col, const int16_t row)
{
        switch (currOctant) {
                case 1:  currTilePos.x =  row; currTilePos.y =  col; break;
                case 2:  currTilePos.x = -row; currTilePos.y =  col; break;
                case 3:  currTilePos.x = -col; currTilePos.y =  row; break;
                case 4:  currTilePos.x = -col; currTilePos.y = -row; break;
                case 5:  currTilePos.x = -row; currTilePos.y = -col; break;
                case 6:  currTilePos.x =  row; currTilePos.y = -col; break;
                case 7:  currTilePos.x =  col; currTilePos.y = -row; break;
                default: currTilePos.x =  col; currTilePos.y =  row;
        }
        currTilePos += Origin;
}
 
#endif // !__FOV_H__