FireworksLocationConfiguration.h

// Copyright eeGeo Ltd (2012-2014), All Rights Reserved

#pragma once

#include "Fireworks.h"
#include "VectorMath.h"
#include "Camera.h"
#include "LatLongAltitude.h"
#include "Types.h"

namespace Eegeo
{
    namespace Fireworks
    {
        struct FireworksLocationConfiguration
        {
            FireworksLocationConfiguration()
            : location(0, 0)
            , chanceOfAppearing(0.0f)
            , startTimeHour(0)
            , endTimeHour(0)
            , loopDisplay(true)
            {}
            
            /* \param location A LatLong object specifying the latitude and longitude of the fireworks display.
             * \param chance A float defining the chance of a fireworks display appearing when you visit said location. Valid range is 0 < X <= 1.0
             * \param startTimeHour Specifies the start time in terms of hours on a 24-hour clock the fireworks will play. Valid range is 0 <= X <= 23
             * \param endTimeHour Specifies the end time in terms of hours on a 24-hour clock the fireworks will end. Valid range is 0 <= X <= 23. If it matches startTimeHour, will play indefinitely.
             */
            FireworksLocationConfiguration(Space::LatLong location, float chance, u32 startTimeHour, u32 endTimeHour)
            : location(location)
            , chanceOfAppearing(chance)
            , startTimeHour(startTimeHour)
            , endTimeHour(endTimeHour)
            , loopDisplay(true)
            {}
            
            bool IsAllDayFireworks() const { return startTimeHour == endTimeHour; }
            
            Space::LatLong location;
            
            float chanceOfAppearing;
            
            u32 startTimeHour;
            
            u32 endTimeHour;
            
            bool loopDisplay;
        };
    }
}