IPointOnMap.h

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

#pragma once

#include "Positioning.h"
#include "Types.h"
#include "VectorMathDecl.h"
#include "Space.h"
#include "PositioningTypes.h"
#include "Interiors.h"
#include "IEvent.h"
#include "IPositioningViewComponent.h"
#include "InteriorId.h"

#include <string>

namespace Eegeo
{
    namespace Positioning
    {
        class IPointOnMap
        {
        public:
            typedef int IdType;

            typedef Helpers::IEvent0 ChangedEvent;
            
            const static int InvalidId = -1;
            
            virtual ~IPointOnMap() {}
            
            // accessors
            
            virtual IdType GetId() const = 0;
            
            virtual ChangedEvent& Changed() = 0;

            virtual bool IsIndoor() const = 0;
            
            virtual Resources::Interiors::InteriorId GetIndoorMapId() const = 0;

            virtual int GetIndoorMapFloorId() const = 0;
            
            virtual ElevationMode::Type GetElevationMode() const = 0;
            
            virtual double GetElevation() const = 0;
            
            virtual Space::LatLong GetCoordinate() const = 0;
            
            // query derived state
            
            virtual Space::LatLongAltitude GetDerivedCoordinate() const = 0;
            
            // For static-earth model, altitude above sea level of this point - may rely on other resources streaming in eg indoor map, terrain.
            // Define 'static-earth model' as map with neutral/identity transform - i.e no environemnt flattening, no indoor map 'concertina' expand.
            virtual double GetDerivedAltitude() const = 0;
            
            // Altitude that is affected by environemnt flattening scale. Typically the same as GetDerivedAltitude(), but for indoor maps is the
            // altitude of the indoor map base plane, rather than the altitude of a point on a floor.
            virtual double GetDerivedCollapsibleAltitude() const = 0;
            
            virtual int GetDerivedIndoorMapFloorIndex() const = 0;
            
            // mutate state
            
            virtual void SetCoordinate(double latitudeDegrees, double longitudeDegrees) = 0;
            
            virtual void SetElevation(double elevation) = 0;
            
            virtual void SetElevationMode(ElevationMode::Type elevationMode) = 0;
            
            virtual void SetIndoorMapId(const Resources::Interiors::InteriorId& indoorMapId) = 0;
            
            virtual void SetIndoorMapFloorId(int indoorMapFloorId) = 0;
            
            
        };
    }
}