/*****************************************************************************************
 *                                                                                       *
 * OpenSpace                                                                             *
 *                                                                                       *
 * Copyright (c) 2014-2017                                                               *
 *                                                                                       *
 * Permission is hereby granted, free of charge, to any person obtaining a copy of this  *
 * software and associated documentation files (the "Software"), to deal in the Software *
 * without restriction, including without limitation the rights to use, copy, modify,    *
 * merge, publish, distribute, sublicense, and/or sell copies of the Software, and to    *
 * permit persons to whom the Software is furnished to do so, subject to the following   *
 * conditions:                                                                           *
 *                                                                                       *
 * The above copyright notice and this permission notice shall be included in all copies *
 * or substantial portions of the Software.                                              *
 *                                                                                       *
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED,   *
 * INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A         *
 * PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT    *
 * HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF  *
 * CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE  *
 * OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.                                         *
 ****************************************************************************************/

#include <modules/globebrowsing/chunk/chunklevelevaluator.h>

#include <modules/globebrowsing/chunk/chunk.h>
#include <modules/globebrowsing/globes/chunkedlodglobe.h>
#include <modules/globebrowsing/globes/renderableglobe.h>
#include <modules/globebrowsing/rendering/layermanager.h>
#include <modules/globebrowsing/tile/tileprovider/tileprovider.h>

namespace openspace {
namespace globebrowsing {
    
int EvaluateChunkLevelByDistance::getDesiredLevel(const Chunk& chunk,
                                                  const RenderData& data) const
{
    // Calculations are done in the reference frame of the globe
    // (model space). Hence, the camera position needs to be transformed
    // with the inverse model matrix
    glm::dmat4 inverseModelTransform = chunk.owner().inverseModelTransform();
    const RenderableGlobe& globe = chunk.owner();
    const Ellipsoid& ellipsoid = globe.ellipsoid();

    glm::dvec3 cameraPosition =
        glm::dvec3(inverseModelTransform * glm::dvec4(data.camera.positionVec3(), 1));
        
    Geodetic2 pointOnPatch = chunk.surfacePatch().closestPoint(
        ellipsoid.cartesianToGeodetic2(cameraPosition)
    );
    glm::dvec3 patchNormal = ellipsoid.geodeticSurfaceNormal(pointOnPatch);
    glm::dvec3 patchPosition = ellipsoid.cartesianSurfacePosition(pointOnPatch);
        
    Chunk::BoundingHeights heights = chunk.getBoundingHeights();
    double heightToChunk = heights.min;

    // Offset position according to height
    patchPosition += patchNormal * heightToChunk;
    
    glm::dvec3 cameraToChunk = patchPosition - cameraPosition;

    // Calculate desired level based on distance
    double distanceToPatch = glm::length(cameraToChunk);
    double distance = distanceToPatch;

    double scaleFactor =
        globe.generalProperties().lodScaleFactor * ellipsoid.minimumRadius();
    double projectedScaleFactor = scaleFactor / distance;
    int desiredLevel = ceil(log2(projectedScaleFactor));
    return desiredLevel;
}

int EvaluateChunkLevelByProjectedArea::getDesiredLevel(const Chunk& chunk,
                                                       const RenderData& data) const
{
    // Calculations are done in the reference frame of the globe
    // (model space). Hence, the camera position needs to be transformed
    // with the inverse model matrix
    glm::dmat4 inverseModelTransform = chunk.owner().inverseModelTransform();

    const RenderableGlobe& globe = chunk.owner();
    const Ellipsoid& ellipsoid = globe.ellipsoid();
    glm::dvec4 cameraPositionModelSpace = glm::dvec4(data.camera.positionVec3(), 1);
    glm::dvec3 cameraPosition =
        glm::dvec3(inverseModelTransform * cameraPositionModelSpace);
    glm::dvec3 cameraToEllipsoidCenter = -cameraPosition;

    Geodetic2 cameraGeodeticPos = ellipsoid.cartesianToGeodetic2(cameraPosition);       
        
    // Approach:
    // The projected area of the chunk will be calculated based on a small area that
    // is close to the camera, and the scaled up to represent the full area.
    // The advantage of doing this is that it will better handle the cases where the 
    // full patch is very curved (e.g. stretches from latitude 0 to 90 deg).
        
    const Geodetic2 center = chunk.surfacePatch().center();
    const Geodetic2 closestCorner = chunk.surfacePatch().closestCorner(cameraGeodeticPos);

    //  Camera
    //  |
    //  V
    //
    //  oo 
    // [  ]<
    //                     *geodetic space*
    //     
    //   closestCorner 
    //    +-----------------+  <-- north east corner
    //    |                 |
    //    |      center     |
    //    |                 |
    //    +-----------------+  <-- south east corner
        
    Chunk::BoundingHeights heights = chunk.getBoundingHeights();
    const Geodetic3 c = { center, heights.min };
    const Geodetic3 c1 = { Geodetic2(center.lat, closestCorner.lon), heights.min };
    const Geodetic3 c2 = { Geodetic2(closestCorner.lat, center.lon), heights.min };
        
    //  Camera
    //  |
    //  V
    //
    //  oo 
    // [  ]<
    //                     *geodetic space*
    //
    //    +--------c2-------+  <-- north east corner
    //    |                 |
    //    c1       c        |
    //    |                 |
    //    +-----------------+  <-- south east corner


    // Go from geodetic to cartesian space
    glm::dvec3 A = cameraToEllipsoidCenter + ellipsoid.cartesianPosition(c);
    glm::dvec3 B = cameraToEllipsoidCenter + ellipsoid.cartesianPosition(c1);
    glm::dvec3 C = cameraToEllipsoidCenter + ellipsoid.cartesianPosition(c2);

    // Project onto unit sphere
    A = glm::normalize(A);
    B = glm::normalize(B);
    C = glm::normalize(C);

    // Camera                      *cartesian space*
    // |                    +--------+---+ 
    // V             __--''   __--''    /
    //              C-------A--------- +
    // oo          /       /          /
    //[  ]<       +-------B----------+
    //

    // If the geodetic patch is small (i.e. has small width), that means the patch in
    // cartesian space will be almost flat, and in turn, the triangle ABC will roughly
    // correspond to 1/8 of the full area
    const glm::dvec3 AB = B - A;
    const glm::dvec3 AC = C - A;
    double areaABC = 0.5 * glm::length(glm::cross(AC, AB));
    double projectedChunkAreaApprox = 8 * areaABC;

    double scaledArea =
        globe.generalProperties().lodScaleFactor * projectedChunkAreaApprox;
    return chunk.tileIndex().level + round(scaledArea - 1);
}

int EvaluateChunkLevelByAvailableTileData::getDesiredLevel(const Chunk& chunk,
                                                           const RenderData& data) const
{
    auto layerManager = chunk.owner().chunkedLodGlobe()->layerManager();
    auto heightLayers = layerManager->layerGroup(LayerManager::HeightLayers).activeLayers();
    int currLevel = chunk.tileIndex().level;
        
    for (size_t i = 0; i < LayerManager::NUM_LAYER_GROUPS; ++i) {
        for (auto& layer : layerManager->layerGroup(i).activeLayers()) {
            Tile::Status tileStatus =
                layer->tileProvider()->getTileStatus(chunk.tileIndex());
            if (tileStatus == Tile::Status::OK) {
                return UNKNOWN_DESIRED_LEVEL;
            }
        }
    }

    return currLevel - 1;
}

} // namespace globebrowsing
} // namespace openspace