OpenSpace/modules/base/rendering/renderabletrailtrajectory.cpp

/*****************************************************************************************
 *                                                                                       *
 * OpenSpace                                                                             *
 *                                                                                       *
 * Copyright (c) 2014-2024                                                               *
 *                                                                                       *
 * 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/base/rendering/renderabletrailtrajectory.h>

#include <openspace/documentation/documentation.h>
#include <openspace/documentation/verifier.h>
#include <openspace/scene/translation.h>
#include <openspace/util/spicemanager.h>
#include <openspace/util/updatestructures.h>
#include <optional>

// This class creates the entire trajectory at once and keeps it in memory the entire
// time. This means that there is no need for updating the trail at runtime, but also that
// the whole trail has to fit in memory.
// Opposed to the RenderableTrailOrbit, no index buffer is needed as the vertex can be
// written into the vertex buffer object continuously and then selected by using the
// count variable from the RenderInformation struct to toggle rendering of the entire path
// or subpath.
// In addition, this RenderableTrail implementation uses an additional RenderInformation
// bucket that contains the line from the last shown point to the current location of the
// object iff not the entire path is shown and the object is between _startTime and
// _endTime. This buffer is updated every frame.

namespace {
    constexpr openspace::properties::Property::PropertyInfo StartTimeInfo = {
        "StartTime",
        "Start Time",
        "The start time for the range of this trajectory. The date must be in ISO 8601 "
        "format: YYYY MM DD HH:mm:ss.xxx.",
        openspace::properties::Property::Visibility::AdvancedUser
    };

    constexpr openspace::properties::Property::PropertyInfo EndTimeInfo = {
        "EndTime",
        "End Time",
        "The end time for the range of this trajectory. The date must be in ISO 8601 "
        "format: YYYY MM DD HH:mm:ss.xxx.",
        openspace::properties::Property::Visibility::AdvancedUser
    };

    constexpr openspace::properties::Property::PropertyInfo SampleIntervalInfo = {
        "SampleInterval",
        "Sample Interval",
        "The interval between samples of the trajectory. This value (together with "
        "'TimeStampSubsampleFactor') determines how far apart (in time) the samples are "
        "spaced along the trajectory. The time interval between 'StartTime' and "
        "'EndTime' is split into 'SampleInterval' * 'TimeStampSubsampleFactor' segments.",
        openspace::properties::Property::Visibility::AdvancedUser
    };

    constexpr openspace::properties::Property::PropertyInfo TimeSubSampleInfo = {
        "TimeStampSubsampleFactor",
        "Time Stamp Subsampling Factor",
        "The factor that is used to create subsamples along the trajectory. This value "
        "(together with 'SampleInterval') determines how far apart (in time) the samples "
        "are spaced along the trajectory. The time interval between 'StartTime' and "
        "'EndTime' is split into 'SampleInterval' * 'TimeStampSubsampleFactor' segments.",
        openspace::properties::Property::Visibility::AdvancedUser
    };

    constexpr openspace::properties::Property::PropertyInfo RenderFullPathInfo = {
        "ShowFullTrail",
        "Render Full Trail",
        "If true, the entire trail will be rendered. If false, only the trail until "
        "the current time in the application will be shown.",
        openspace::properties::Property::Visibility::NoviceUser
    };

    constexpr openspace::properties::Property::PropertyInfo SweepChunkSizeInfo = {
        "SweepChunkSize",
        "Sweep Chunk Size",
        "The number of vertices that will be calculated each frame whenever the trail "
        "needs to be recalculated. A greater value will result in more calculations per "
        "frame.",
        openspace::properties::Property::Visibility::AdvancedUser
    };

    constexpr openspace::properties::Property::PropertyInfo EnableSweepChunkingInfo = {
        "EnableSweepChunking",
        "Use Sweep Chunking",
        "Enable or Disable the use of iterative calculations (chunking) during full "
        "sweep vertex calculations. When enabled, small part of the trail will be "
        "calculated each frame instead of calculating the entire trail in one go. "
        "The size of each 'chunk' can be altered by changing the sweep chunk size "
        "property.",
        openspace::properties::Property::Visibility::AdvancedUser
    };

    constexpr openspace::properties::Property::PropertyInfo AccurateTrailPositionsInfo = {
        "AccurateTrailPositions",
        "Number of Accurate Trail Points",
        "The number of vertices, each side of the object, that will be recalculated "
        "for greater accuracy. This also ensures that the object connects with the "
        "trail.",
        openspace::properties::Property::Visibility::AdvancedUser
    };

    struct [[codegen::Dictionary(RenderableTrailTrajectory)]] Parameters {
        // [[codegen::verbatim(StartTimeInfo.description)]]
        std::string startTime [[codegen::annotation("A valid date in ISO 8601 format")]];

        // [[codegen::verbatim(EndTimeInfo.description)]]
        std::string endTime [[codegen::annotation("A valid date in ISO 8601 format")]];

        // [[codegen::verbatim(SampleIntervalInfo.description)]]
        double sampleInterval;

        // [[codegen::verbatim(TimeSubSampleInfo.description)]]
        std::optional<int> timeStampSubsampleFactor;

        // [[codegen::verbatim(RenderFullPathInfo.description)]]
        std::optional<bool> showFullTrail;

        // [[codegen::verbatim(SweepChunkSizeInfo.description)]]
        std::optional<int> sweepChunkSize;

        // [[codegen::verbatim(SweepChunkSizeInfo.description)]]
        std::optional<int> enableSweepChunking;

        // [[codegen::verbatim(AccurateTrailPositionsInfo.description)]]
        std::optional<int> accurateTrailPositions;
    };
#include "renderabletrailtrajectory_codegen.cpp"
} // namespace

namespace openspace {

documentation::Documentation RenderableTrailTrajectory::Documentation() {
    return codegen::doc<Parameters>(
        "base_renderable_renderabletrailtrajectory",
        RenderableTrail::Documentation()
    );
}

RenderableTrailTrajectory::RenderableTrailTrajectory(const ghoul::Dictionary& dictionary)
    : RenderableTrail(dictionary)
    , _startTime(StartTimeInfo)
    , _endTime(EndTimeInfo)
    , _sampleInterval(SampleIntervalInfo, 2.0, 2.0, 1e6)
    , _timeStampSubsamplingFactor(TimeSubSampleInfo, 1, 1, 1000000000)
    , _renderFullTrail(RenderFullPathInfo, false)
    , _maxVertex(glm::vec3(-std::numeric_limits<float>::max()))
    , _minVertex(glm::vec3(std::numeric_limits<float>::max()))
    , _sweepChunkSize(SweepChunkSizeInfo, 200, 50, 5000)
    , _enableSweepChunking(EnableSweepChunkingInfo, false)
    , _numberOfReplacementPoints(AccurateTrailPositionsInfo, 100, 0, 1000)
{
    const Parameters p = codegen::bake<Parameters>(dictionary);

    _translation->onParameterChange([this]() { reset(); });

    _renderFullTrail = p.showFullTrail.value_or(_renderFullTrail);
    addProperty(_renderFullTrail);

    _startTime = p.startTime;
    _startTime.onChange([this] { reset(); });
    addProperty(_startTime);

    _endTime = p.endTime;
    _endTime.onChange([this] { reset(); });
    addProperty(_endTime);

    _sampleInterval = p.sampleInterval;
    _sampleInterval.onChange([this] { reset(); });
    addProperty(_sampleInterval);

    _timeStampSubsamplingFactor =
        p.timeStampSubsampleFactor.value_or(_timeStampSubsamplingFactor);
    _timeStampSubsamplingFactor.onChange([this] { _subsamplingIsDirty = true; });
    addProperty(_timeStampSubsamplingFactor);

    _numberOfReplacementPoints = p.accurateTrailPositions.value_or(
        _numberOfReplacementPoints
    );
    addProperty(_numberOfReplacementPoints);

    _enableSweepChunking = p.enableSweepChunking.value_or(_enableSweepChunking);
    addProperty(_enableSweepChunking);

    _sweepChunkSize = p.sweepChunkSize.value_or(_sweepChunkSize);
    addProperty(_sweepChunkSize);

    // We store the vertices with ascending temporal order
    _primaryRenderInformation.sorting = RenderInformation::VertexSorting::OldestFirst;
    _secondaryRenderInformation.sorting = RenderInformation::VertexSorting::OldestFirst;

    // Activate special render mode for renderableTrailTrajectory
    _useSplitRenderMode = true;
}

void RenderableTrailTrajectory::initializeGL() {
    RenderableTrail::initializeGL();

    // We don't need an index buffer, so we keep it at the default value of 0
    glGenVertexArrays(1, &_primaryRenderInformation._vaoID);
    glGenBuffers(1, &_primaryRenderInformation._vBufferID);

    // We do need an additional render information bucket for the additional line from the
    // last shown permanent line to the current position of the object
    glGenVertexArrays(1, &_floatingRenderInformation._vaoID);
    glGenBuffers(1, &_floatingRenderInformation._vBufferID);
    _floatingRenderInformation.sorting = RenderInformation::VertexSorting::OldestFirst;

    _secondaryRenderInformation._vaoID = _primaryRenderInformation._vaoID;
    _secondaryRenderInformation._vBufferID = _primaryRenderInformation._vBufferID;
}

void RenderableTrailTrajectory::deinitializeGL() {
    glDeleteVertexArrays(1, &_primaryRenderInformation._vaoID);
    glDeleteBuffers(1, &_primaryRenderInformation._vBufferID);

    glDeleteVertexArrays(1, &_floatingRenderInformation._vaoID);
    glDeleteBuffers(1, &_floatingRenderInformation._vBufferID);

    RenderableTrail::deinitializeGL();
}

void RenderableTrailTrajectory::reset() {
    _needsFullSweep = true;
    _sweepIteration = 0;
    _maxVertex = glm::vec3(-std::numeric_limits<float>::max());
    _minVertex = glm::vec3(std::numeric_limits<float>::max());
}

void RenderableTrailTrajectory::update(const UpdateData& data) {
    if (_needsFullSweep) {

        if (_sweepIteration == 0) {
            // Max number of vertices
            constexpr unsigned int maxNumberOfVertices = 1000000;

            // Convert the start and end time from string representations to J2000 seconds
            _start = SpiceManager::ref().ephemerisTimeFromDate(_startTime);
            _end = SpiceManager::ref().ephemerisTimeFromDate(_endTime);
            const double timespan = _end - _start;

            _totalSampleInterval = _sampleInterval / _timeStampSubsamplingFactor;

            // Cap _numberOfVertices in order to prevent overflow and extreme performance
            // degredation/RAM usage
            _numberOfVertices = std::min(
                static_cast<unsigned int>(std::ceil(timespan / _totalSampleInterval)),
                maxNumberOfVertices
            );

            // We need to recalcuate the _totalSampleInterval if _numberOfVertices eqals
            // maxNumberOfVertices. If we don't do this the position for each vertex
            // will not be correct for the number of vertices we are doing along the trail
            _totalSampleInterval = (_numberOfVertices == maxNumberOfVertices) ?
                (timespan / _numberOfVertices) : _totalSampleInterval;

            // Make space for the vertices
            _vertexArray.clear();
            _dVertexArray.clear();
            _timeVector.clear();
            _vertexArray.resize(_numberOfVertices + 1);
            _dVertexArray.resize(_numberOfVertices + 1);
            _timeVector.resize(_numberOfVertices + 1);
        }

        // Calculate sweeping range for this iteration
        const unsigned int startIndex = _sweepIteration * _sweepChunkSize;
        const unsigned int nextIndex = (_sweepIteration + 1) * _sweepChunkSize;
        unsigned int stopIndex = std::min(nextIndex, _numberOfVertices);

        // If iterative calculations are disabled
        if (!_enableSweepChunking) {
            stopIndex = _numberOfVertices;
        }

        // Calculate all vertex positions
        for (unsigned int i = startIndex; i < stopIndex; i++) {
            const glm::dvec3 dp = _translation->position({
                {},
                Time(_start + i * _totalSampleInterval),
                Time(0.0)
            });
            const glm::vec3 p(dp.x, dp.y, dp.z);
            _vertexArray[i] = { p.x, p.y, p.z };
            _timeVector[i] = Time(_start + i * _totalSampleInterval).j2000Seconds();
            _dVertexArray[i] = {dp.x, dp.y, dp.z};

            // Set max and min vertex for bounding sphere calculations
            _maxVertex = glm::max(_maxVertex, dp);
            _minVertex = glm::min(_minVertex, dp);
        }
        ++_sweepIteration;

        // Full sweep is complete here.
        // Adds the last point in time to the _vertexArray so that we
        // ensure that points for _start and _end always exists
        if (stopIndex == _numberOfVertices) {
            const glm::dvec3 dp = _translation->position({
                {},
                Time(_end),
                Time(0.0)
                });
            const glm::vec3 p(dp.x, dp.y, dp.z);
            _vertexArray[stopIndex] = { p.x, p.y, p.z };
            _timeVector[stopIndex] = Time(_end).j2000Seconds();
            _dVertexArray[stopIndex] = { dp.x, dp.y, dp.z };

            _sweepIteration = 0;
            setBoundingSphere(glm::distance(_maxVertex, _minVertex) / 2.0);
        }
        else {
            // Early return as we don't need to render if we are still
            // doing full sweep calculations
            return;
        }

        // Upload vertices to the GPU
        glBindVertexArray(_primaryRenderInformation._vaoID);
        glBindBuffer(GL_ARRAY_BUFFER, _primaryRenderInformation._vBufferID);
        glBufferData(
            GL_ARRAY_BUFFER,
            _vertexArray.size() * sizeof(TrailVBOLayout<float>),
            _vertexArray.data(),
            GL_STATIC_DRAW
        );

        glEnableVertexAttribArray(0);
        glVertexAttribPointer(0, 3, GL_FLOAT, GL_FALSE, 0, nullptr);

        // We clear the indexArray just in case. The base class will take care not to use
        // it if it is empty
        _indexArray.clear();

        _subsamplingIsDirty = true;
        _needsFullSweep = false;
    }

    // This has to be done every update step;
    const double j2k = data.time.j2000Seconds();

    if (j2k >= _start && j2k < _end) {
        _replacementPoints.clear();

        // Calculates number of vertices for the first segment (start point to object)
        _primaryRenderInformation.count = static_cast<GLsizei>(
            std::distance(
                _timeVector.begin(),
                std::lower_bound(_timeVector.begin(), _timeVector.end(), j2k)
            )
        );

        if (_renderFullTrail) {
            // Calculates number of vertices for the second segment (object to end point)
            _secondaryRenderInformation.first = _primaryRenderInformation.count;
            _secondaryRenderInformation.count = static_cast<GLsizei>(
                _vertexArray.size() - (_primaryRenderInformation.count)
            );

            // Calculate number of vertices in the trail
            _numberOfUniqueVertices = static_cast<GLsizei>(
                std::distance(_timeVector.begin(), _timeVector.end())
            );
        }
        else {
            // If we don't render full trail there's no trail after the object
            _secondaryRenderInformation.first = 0;
            _secondaryRenderInformation.count = 0;

            // Set number of vertices in the trail
            _numberOfUniqueVertices = _primaryRenderInformation.count;
        }

        // Determine the number of points to be recalculated
        int prePaddingDelta = 0;
        if (!_renderFullTrail && _numberOfReplacementPoints == 0) {
            // Enables trail from last point to current position
            // if we don't do any replacement points
            prePaddingDelta = 1;
        }
        else {
            prePaddingDelta = std::min(
                static_cast<int>(_primaryRenderInformation.count),
                static_cast<int>(_numberOfReplacementPoints)
            );
        }
        int postPaddingDelta = std::min(
            static_cast<int>(_secondaryRenderInformation.count),
            static_cast<int>(_numberOfReplacementPoints)
        );

        // Get current position of the object
        const glm::dvec3 p = _translation->position(data);

        // Calculates all replacement points before the object
        glm::dvec3 v = p;
        for (int i = 0; i < prePaddingDelta; ++i) {
            const int floatPointIndex =
                _primaryRenderInformation.count - prePaddingDelta + i;

            glm::dvec3 fp = glm::dvec3(
                _vertexArray[floatPointIndex].x,
                _vertexArray[floatPointIndex].y,
                _vertexArray[floatPointIndex].z
            );

            glm::dvec3 dp = glm::dvec3(
                _dVertexArray[floatPointIndex].x,
                _dVertexArray[floatPointIndex].y,
                _dVertexArray[floatPointIndex].z
            );

            glm::dvec3 dv = fp - dp;
            glm::dvec3 newPoint = dp - v;

            // Scales position offset for smooth transition from '
            // original points to accurate points
            double mult = 0.0;
            if (i == prePaddingDelta - 1) {
                mult = (i == 0) ? 1.0 : 0.0;
            }
            else {
                mult = (prePaddingDelta - i) / static_cast<double>(prePaddingDelta);
            }

            newPoint = newPoint + dv * mult;
            _replacementPoints.push_back({
                static_cast<float>(newPoint.x),
                static_cast<float>(newPoint.y),
                static_cast<float>(newPoint.z)
            });
        }

        // Mid-point (model-space position for the object)
        if (_numberOfReplacementPoints > 0 || !_renderFullTrail) {
            _replacementPoints.push_back({ 0.f, 0.f, 0.f });
        }

        // Calculates all replacement points after the object
        v = glm::dvec3(p.x, p.y, p.z);
        for (int i = 0; i < postPaddingDelta; ++i) {
            const int floatPointIndex = _secondaryRenderInformation.first + i;

            glm::dvec3 fp = glm::dvec3(
                _vertexArray[floatPointIndex].x,
                _vertexArray[floatPointIndex].y,
                _vertexArray[floatPointIndex].z
            );

            glm::dvec3 dp = glm::dvec3(
                _dVertexArray[floatPointIndex].x,
                _dVertexArray[floatPointIndex].y,
                _dVertexArray[floatPointIndex].z
            );

            glm::dvec3 dv = fp - dp;
            glm::dvec3 newPoint = dp - v;

            // Scales position offset for smooth transition from '
            // original points to accurate points
            double mult = (i == postPaddingDelta - 1) ?
                1.0 :
                1.0 - (postPaddingDelta - i) / static_cast<double>(postPaddingDelta);

            newPoint = newPoint + dv * mult;
            _replacementPoints.push_back({
                static_cast<float>(newPoint.x),
                static_cast<float>(newPoint.y),
                static_cast<float>(newPoint.z)
            });
        }

        // Set variables for floating segments
        _floatingRenderInformation.first = 0;
        _floatingRenderInformation.count =
            static_cast<GLsizei>(_replacementPoints.size());

        _floatingRenderInformation._localTransform = glm::translate(
            glm::dmat4(1.0),
            p
        );

        // Adjusts number of unique vertices if we have inserted a new mid point
        if (_floatingRenderInformation.count > 0 && _renderFullTrail) {
            _numberOfUniqueVertices++;
        }

        // Recalculate .count and .first based on the recalculated (floating) vertices
        _primaryRenderInformation.count -= std::max(0, prePaddingDelta - 1);
        _secondaryRenderInformation.first += std::max(0, postPaddingDelta - 1);
        _secondaryRenderInformation.count -= std::max(0, postPaddingDelta - 1);

        // Adjusts count such that it takes into account if we don't have any line
        // connecting with the object
        if (_renderFullTrail && _numberOfReplacementPoints == 0) {
            _primaryRenderInformation.count += 1;
        }


        glBindVertexArray(_floatingRenderInformation._vaoID);
        glBindBuffer(GL_ARRAY_BUFFER, _floatingRenderInformation._vBufferID);
        glBufferData(
            GL_ARRAY_BUFFER,
            _replacementPoints.size() * sizeof(TrailVBOLayout<float>),
            _replacementPoints.data(),
            GL_DYNAMIC_DRAW
        );
        glEnableVertexAttribArray(0);
        glVertexAttribPointer(0, 3, GL_FLOAT, GL_FALSE, 0, nullptr);
    }
    else if (j2k >= _end || (j2k < _start && _renderFullTrail)) {
        // Renders the whole trail if time has passed the end time
        _primaryRenderInformation.first = 0;
        _primaryRenderInformation.count = static_cast<GLsizei>(_vertexArray.size());
        _numberOfUniqueVertices = _primaryRenderInformation.count;
        _secondaryRenderInformation.first = 0;
        _secondaryRenderInformation.count = 0;
        _floatingRenderInformation.first = 0;
        _floatingRenderInformation.count = 0;
    }
    else {
        _primaryRenderInformation.first = 0;
        _primaryRenderInformation.count = 0;
        _secondaryRenderInformation.first = 0;
        _secondaryRenderInformation.count = 0;
        _floatingRenderInformation.first = 0;
        _floatingRenderInformation.count = 0;
    }

    if (_subsamplingIsDirty) {
        // If the subsampling information has changed (either by a property change or by
        // a request of a full sweep) we update it here

        _primaryRenderInformation.stride = _timeStampSubsamplingFactor;
        _secondaryRenderInformation.stride = _timeStampSubsamplingFactor;
        _floatingRenderInformation.stride = _timeStampSubsamplingFactor;

        _subsamplingIsDirty = false;
    }

    glBindVertexArray(0);

}

} // namespace openspace