SraVisionUtility.h

Go to the documentation of this file.

#ifndef __SRAVISIONUTILITY_H
#define __SRAVISIONUTILITY_H

#include "CodeGenMacros.h"
#include "SraTypes.h"
#include "SrConstants.h"

//As of 6/20/2010, this is a legacy file that may need to be re-implemented in UnrealScript as needed

namespace SraLogic
{
    INLINE int GetThermalSmokePenalty(Vision vision)
    {
        switch(vision)
        {
            case NormalVision: return VISIBILITY_THERMALSMOKE_NORMAL;
            case LowLightVision: return VISIBILITY_THERMALSMOKE_LOWLIGHT;
            case ThermographicVision: return VISIBILITY_THERMALSMOKE_THERMOGRAPHIC;
            case AstralVision: return VISIBILITY_THERMALSMOKE_ASTRAL;

            default: return RANGED_TARGET_TOTAL_COVER;
        }
    }

    INLINE int GetHeavyFogPenalty(Vision vision)
    {
        switch(vision)
        {
            case NormalVision: return VISIBILITY_HEAVYFOG_NORMAL;
            case LowLightVision: return VISIBILITY_HEAVYFOG_LOWLIGHT;
            case ThermographicVision: return VISIBILITY_HEAVYFOG_THERMOGRAPHIC;
            case AstralVision: return VISIBILITY_HEAVYFOG_ASTRAL;

            default: return RANGED_TARGET_TOTAL_COVER;
        }
    }

    INLINE int GetLightFogPenalty(Vision vision)
    {
        switch(vision)
        {
            case NormalVision: return VISIBILITY_GLARE_NORMAL;
            case LowLightVision: return VISIBILITY_GLARE_LOWLIGHT;
            case ThermographicVision: return VISIBILITY_GLARE_THERMOGRAPHIC;
            case AstralVision: return VISIBILITY_GLARE_ASTRAL;

            default: return RANGED_TARGET_TOTAL_COVER;
        }
    }

    INLINE int GetGlarePenalty(Vision vision)
    {
        switch(vision)
        {
            case NormalVision: return VISIBILITY_GLARE_NORMAL;
            case LowLightVision: return VISIBILITY_GLARE_LOWLIGHT;
            case ThermographicVision: return VISIBILITY_GLARE_THERMOGRAPHIC;
            case AstralVision: return VISIBILITY_GLARE_ASTRAL;

            default: return RANGED_TARGET_TOTAL_COVER;
        }
    }

    INLINE int GetPartialLightPenalty(Vision vision)
    {
        switch(vision)
        {
            case NormalVision: return VISIBILITY_PARTIALLIGHT_NORMAL;
            case LowLightVision: return VISIBILITY_PARTIALLIGHT_LOWLIGHT;
            case ThermographicVision: return VISIBILITY_PARTIALLIGHT_THERMOGRAPHIC;
            case AstralVision: return VISIBILITY_PARTIALLIGHT_ASTRAL;

            default: return RANGED_TARGET_TOTAL_COVER;
        }
    }
    
    INLINE int GetTotalDarknessPenalty(Vision vision)
    {       
        switch(vision)
        {
            case NormalVision: return VISIBILITY_FULLDARK_NORMAL;
            case LowLightVision: return VISIBILITY_FULLDARK_LOWLIGHT;
            case ThermographicVision: return VISIBILITY_FULLDARK_THERMOGRAPHIC;
            case AstralVision: return VISIBILITY_FULLDARK_ASTRAL;

            default: return RANGED_TARGET_TOTAL_COVER;
        }
    }

    INLINE int GetTotalVisibilityPenalty(Visibility visibility, Vision vision)
    {
        //if there are no visbility issues, then we don't even need to calculate
        if(visibility == NoObstruction)
            return 0;

        if((visibility & TotalObstruction) || (visibility & PartialObstruction))
            return RANGED_TARGET_TOTAL_COVER;

        //if we do need to calculate, then start at zero
        int total = 0;

        //find the light-based penalty, checking darkest first
        if(visibility & FullDarkness)
            total += GetTotalDarknessPenalty(vision);
        else if(visibility & PartialLight)
            total += GetPartialLightPenalty(vision);

        //check for glare
        if(visibility & Glare)
            total += GetGlarePenalty(vision);

        //check for smoke (thermal smoke is worst, then heavy fog, then light fog)
        if(visibility & ThermalSmoke)
            total += GetThermalSmokePenalty(vision);
        else if(visibility & HeavyFog)
            total += GetHeavyFogPenalty(vision);
        else if(visibility & LightFog)
            total += GetLightFogPenalty(vision);            

        //visibility can't be worse than total cover
        if(total > RANGED_TARGET_TOTAL_COVER)
            return RANGED_TARGET_TOTAL_COVER;

        return total;
    }
}

#endif