Program Listing for File TimeDisplay.h

↰ Return to documentation for file (include/Karana/GeneralKModels/TimeDisplay.h)

/*
 * Copyright (c) 2024-2026 Karana Dynamics Pty Ltd. All rights reserved.
 *
 * NOTICE TO USER:
 *
 * This source code and/or documentation (the "Licensed Materials") is
 * the confidential and proprietary information of Karana Dynamics Inc.
 * Use of these Licensed Materials is governed by the terms and conditions
 * of a separate software license agreement between Karana Dynamics and the
 * Licensee ("License Agreement"). Unless expressly permitted under that
 * agreement, any reproduction, modification, distribution, or disclosure
 * of the Licensed Materials, in whole or in part, to any third party
 * without the prior written consent of Karana Dynamics is strictly prohibited.
 *
 * THE LICENSED MATERIALS ARE PROVIDED "AS IS" WITHOUT WARRANTY OF ANY KIND.
 * KARANA DYNAMICS DISCLAIMS ALL WARRANTIES, EXPRESS OR IMPLIED, INCLUDING
 * BUT NOT LIMITED TO WARRANTIES OF MERCHANTABILITY, NON-INFRINGEMENT, AND
 * FITNESS FOR A PARTICULAR PURPOSE.
 *
 * IN NO EVENT SHALL KARANA DYNAMICS BE LIABLE FOR ANY DAMAGES WHATSOEVER,
 * INCLUDING BUT NOT LIMITED TO LOSS OF PROFITS, DATA, OR USE, EVEN IF
 * ADVISED OF THE POSSIBILITY OF SUCH DAMAGES, WHETHER IN CONTRACT, TORT,
 * OR OTHERWISE ARISING OUT OF OR IN CONNECTION WITH THE LICENSED MATERIALS.
 *
 * U.S. Government End Users: The Licensed Materials are a "commercial item"
 * as defined at 48 C.F.R. 2.101, and are provided to the U.S. Government
 * only as a commercial end item under the terms of this license.
 *
 * Any use of the Licensed Materials in individual or commercial software must
 * include, in the user documentation and internal source code comments,
 * this Notice, Disclaimer, and U.S. Government Use Provision.
 */

/**
 * @file
 * @brief Contains the declarations for the TimeDisplay KModel.
 */

#pragma once
#include "Karana/SOADyn/KModel.h"
#include "Karana/Scene/GraphicalScene.h"

namespace Karana::Models {

    /**
     * @class TimeDisplayParams
     * @brief Parameters for the TimeDisplay KModel.
     */
    class TimeDisplayParams : public KModelParams {
      public:
        /**
         * @brief TimeDisplayParams Constructor
         * @param name - Name of the params.
         */
        TimeDisplayParams(std::string_view name);

        /**
         * @brief Used to ensure the params are ready.
         *
         * @return `true` if the params are ready, `false` otherwise.
         */
        bool isReady() const final;

        /// Color of the time text
        Karana::Scene::Color color = Karana::Scene::Color::WHITE;
    };

    /**
     * @class TimeDisplay
     * @brief The TimeDisplay model updates the visualization at each postHop.
     */
    class TimeDisplay : public KModel<TimeDisplay, TimeDisplayParams> {
      public:
        /**
         * @brief TimeDisplay constructor. The constructor is not meant to be called directly.
         *        Please use the create(...) method instead to create an instance.
         *
         * @param name The name of the model.
         * @param mm The ModelManager to register this model with.
         * @param scene The GraphicalScene to display the time in.
         */
        TimeDisplay(std::string_view name,
                    const Karana::Core::ks_ptr<Karana::Dynamics::ModelManager> &mm,
                    const Karana::Core::ks_ptr<Karana::Scene::GraphicalScene> &scene);

        /**
         * @brief Destructor for TimeDisplay.
         */
        ~TimeDisplay();

        /**
         * @brief Constructor.
         *
         * @param name The name of the model.
         * @param mm The ModelManager to register this model with.
         * @param scene The GraphicalScene to display the time in.
         * @return A ks_ptr to the newly created instance of the TimeDisplay model.
         */
        static Karana::Core::ks_ptr<TimeDisplay>
        create(std::string_view name,
               const Karana::Core::ks_ptr<Karana::Dynamics::ModelManager> &mm,
               const Karana::Core::ks_ptr<Karana::Scene::GraphicalScene> &scene);

        /**
         * @brief Update the time display
         *
         * @param t Current time. Not used.
         * @param x Current state. Not used.
         */
        void postModelStep(const Karana::Math::Ktime &t, const Karana::Math::Vec &x);

      protected:
        /**
         * @brief Unregister the model.
         */
        void _unregisterModel() override;

      private:
        /// The scene where we will display the time
        Karana::Core::ks_ptr<Karana::Scene::GraphicalScene> _scene;

        /// Id for the text overlay
        Karana::Core::id_t _overlay_id = 0;
    };
} // namespace Karana::Models