height_manager.h

Go to the documentation of this file.

#pragma once
 
#include "core/types.h"
#include <array>
#include <iostream>
#include <vector>
 
namespace HeightManagement
{
 
    class HeightManager
    {
      public:
        struct heightdata
        {
            double x;
            double y;
            double z;
        };
 
        /// \brief Constructor of HeightManager class.
        ///
        /// \returns No object.
        HeightManager();
 
        /// \brief Function to update the origin point. Running this will also
        /// trigger the population of height data for the chosen subset of the
        /// GeoTiff file.
        ///
        /// \param x X coordinate used for GeoTiff subset origin.
        /// \param y Y coordinate used for GeoTiff subset origin.
        /// \returns No object, but will update the origin for this instance of
        /// HeightManager and will populate the instance with height data.
        void UpdateOrigin(Core::UTMCoordinate UTMCoord, int size);
 
        /// \brief Function to return the whole "height_management" for a given
        /// point.
        ///
        /// \param inputRelativeX The X coordinate in the relative system (where
        /// 0,0 is the top left corner of the system). \param inputRelativeY The
        /// Y coordinate in the relative system. \returns A height_management,
        /// containing the geographic (absolute) x, y and z coordinates.
        bool GetVertex(int inputRelativeX, int inputRelativeY,
                       heightdata& vertex);
 
        /// \brief Function to return height, given relative coordinates (from a
        /// system where 0, 0 is in the upper left corner)
        ///
        /// \param inputRelativeX The relative X value of the point.
        /// \param inputRelativeY The relative Y value of the point.
        /// \returns A float containing the height value of the point in metres.
        bool GetHeight(int inputRelativeX, int inputRelativeY, float& height);
 
        /// \brief Function to get the height_management of an absolute
        /// (geographic) coordinate, using the same coordinate system of the
        /// dataset.
        ///
        /// \param inputX The absolute X value of the point.
        /// \param inputY The absolute Y value of the point.
        /// \returns A float containing the height of the point in metres.
        bool GetVertexAbsolute(double inputX, double inputY,
                               heightdata& vertex);
 
        /// \brief Function to get the height of an absolute (geographic)
        /// coordinate, using the same coordinate system of the dataset.
        ///
        /// \param inputX The absolute X value of the point.
        /// \param inputY The absolute Y value of the point.
        /// \returns A float containing the height of the point in metres.
        float GetHeightAbsolute(double inputX, double inputY);
 
        /// \brief Function to allow user to change GeoTiff file used in
        /// planning. If this function is not run, the user can still update the
        /// origin and Hivemind will run using the cached GeoTiff file.
        ///
        /// \param filePath Complete file path of the file to be used.
        /// \param x X coordinate used for GeoTiff subset origin. Height data
        /// will be populated in a 500x500 pixel centered on the origin point.
        /// This is hard coded into the class. \param y Y coordinate used for
        /// GeoTiff subset origin. \returns No object, but will update the path
        /// for the cached tif.
        void LoadTif(const char* filePath, double x, double y);
 
      private:
        /// \brief Function that will open the GeoTiff file and extract all
        /// heights for the given subset of the dataset used.
        ///
        /// \returns No object, but after this has run, all heights will have
        /// been imported into the instance of the class and the various
        /// GetHeight methods can be run.
        void PopulateVertices();
 
        /// \brief Function to test whether a point exists within the scope of
        /// the selected data subset.
        ///
        /// \param x the X value of the coordinate to be tested.
        /// \param y the Y value of the coordinate to be tested.
        /// \returns A bool indicating whether or not the input exists in the
        /// subset and is valid.
        bool ValidInput(int x, int y);
 
        /// \brief Function to test whether a point exists within the scope of
        /// the elected data subset. Overloaded version of ValidInput() that
        /// takes doubles.
        ///
        /// \param x The X value of the coordinate to be tested.
        /// \param y The Y value of the coordinate to be tested.
        /// \returns A bool indicating whether or not the input exists in the
        /// subset and is valid.
        bool ValidInput(double x, double y);
 
        /// \brief Function that tests whether the selected origin point is
        /// within the bounds of the currently active data set, given the buffer
        /// size required to extract the subset.
        ///
        /// \param x The X value of the origin point.
        /// \param y The Y value of the origin point.
        /// \returns A bool indicating whether or not the origin point is within
        /// bounds.
        bool OrigoWithinBounds(double x, double y);
 
        /// \brief Function to update the corner coordinates saved within the
        /// member instance of the chosen dataset.
        ///
        /// \returns No object, but the corner coordinates will be updated,
        /// given there were no problems opening the GeoTiff file.
        void UpdateCornerCoords();
 
      private:
        const char* m_CachedTifName = "../res/Kongsberg.tif";
        const char* m_CoordinateSystem{ "UTM33" };
        int m_Resolution{ 1 };
        int m_Size;
        long m_UpperLeftX;
        long m_UpperLeftY;
        long m_LowerRightX;
        long m_LowerRightY;
        heightdata* m_Vertices;
        heightdata m_Origo{ 0, 0, 0 };
        heightdata m_SelectionCorner;
    };
 
} // namespace HeightManagement