OpenSpace/modules/base/dashboard/dashboarditemdate.cpp

/*****************************************************************************************
 *                                                                                       *
 * OpenSpace                                                                             *
 *                                                                                       *
 * Copyright (c) 2014-2021                                                               *
 *                                                                                       *
 * 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/dashboard/dashboarditemdate.h>

#include <openspace/documentation/documentation.h>
#include <openspace/documentation/verifier.h>
#include <openspace/engine/globals.h>
#include <openspace/util/spicemanager.h>
#include <openspace/util/timemanager.h>
#include <ghoul/font/font.h>
#include <ghoul/font/fontmanager.h>
#include <ghoul/font/fontrenderer.h>
#include <ghoul/logging/logmanager.h>
#include <ghoul/misc/profiling.h>

namespace {
    constexpr openspace::properties::Property::PropertyInfo FormatStringInfo = {
        "FormatString",
        "Format String",
        "The format text describing how this dashboard item renders it's text. This text "
        "must contain exactly one {} which is a placeholder that will contain the date"
    };

    constexpr openspace::properties::Property::PropertyInfo TimeFormatInfo = {
        "TimeFormat",
        "Time Format",
        "The format string used for formatting the date/time before being passed to the "
        "string in FormatString. See "
        "https://naif.jpl.nasa.gov/pub/naif/toolkit_docs/C/cspice/timout_c.html for full "
        "information about how to structure this format"
    };
} // namespace

namespace openspace {

documentation::Documentation DashboardItemDate::Documentation() {
    using namespace documentation;
    return {
        "DashboardItem Date",
        "base_dashboarditem_date",
        {
            {
                "Type",
                new StringEqualVerifier("DashboardItemDate"),
                Optional::No
            },
            {
                FormatStringInfo.identifier,
                new StringVerifier,
                Optional::Yes,
                FormatStringInfo.description
            },
            {
                TimeFormatInfo.identifier,
                new StringVerifier,
                Optional::Yes,
                TimeFormatInfo.description
            }
        }
    };
}

DashboardItemDate::DashboardItemDate(const ghoul::Dictionary& dictionary)
    : DashboardTextItem(dictionary, 15.f)
    , _formatString(FormatStringInfo, "Date: {} UTC")
    , _timeFormat(TimeFormatInfo, "YYYY MON DDTHR:MN:SC.### ::RND")
{
    documentation::testSpecificationAndThrow(
        Documentation(),
        dictionary,
        "DashboardItemDate"
    );

    if (dictionary.hasKey(FormatStringInfo.identifier)) {
        _formatString = dictionary.value<std::string>(FormatStringInfo.identifier);
    }
    addProperty(_formatString);

    if (dictionary.hasKey(TimeFormatInfo.identifier)) {
        _timeFormat = dictionary.value<std::string>(TimeFormatInfo.identifier);
    }
    addProperty(_timeFormat);
}

void DashboardItemDate::render(glm::vec2& penPosition) {
    ZoneScoped

    std::string time = SpiceManager::ref().dateFromEphemerisTime(
        global::timeManager->time().j2000Seconds(),
        _timeFormat.value().c_str()
    );
    try {
        RenderFont(*_font, penPosition, fmt::format(_formatString.value().c_str(), time));
    }
    catch (const fmt::format_error&) {
        LERRORC("DashboardItemDate", "Illegal format string");
    }
    penPosition.y -= _font->height();
}

glm::vec2 DashboardItemDate::size() const {
    ZoneScoped

    std::string_view time = global::timeManager->time().UTC();
    return _font->boundingBox(fmt::format(_formatString.value().c_str(), time));
}

} // namespace openspace