Program Listing for File GraphicalScene.h

↰ Return to documentation for file (include/Karana/Scene/GraphicalScene.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 GraphicalScene class.
 */

#pragma once
#include "Karana/Scene/GraphicalSceneCamera.h"
#include "Karana/Scene/GraphicalSceneNode.h"
#include "Karana/Scene/GraphicalScenePart.h"
#include "Karana/Scene/Scene.h"
#include "Karana/Scene/Text.h"

namespace Karana::Scene {

    /// raw RGBA image data struct
    struct RGBABuffer {
        /// The raw data buffer
        std::vector<uint8_t> data;
        /// Pixel width of the image
        unsigned int width;
        /// Pixel height of the image
        unsigned int height;
    };

    /**
     * @class GraphicalScene
     * @brief Scene with an added graphics-specific interface
     *
     * See \sref{scene_layer_sec} for more discussion on
     * the scene layer.
     */
    class GraphicalScene : public Scene {

        // For create/discard
        friend class GraphicalSceneNode;
        friend class GraphicalScenePart;

      protected:
        /**
         * @brief Constructor for a GraphicalScene
         * @param name - Name of the GraphicalScene
         */
        GraphicalScene(std::string_view name);

      public:
        virtual ~GraphicalScene();

        /**
         * @brief Get the automatically created default camera
         * @return The default camera
         */
        virtual Karana::Core::ks_ptr<GraphicalSceneCamera> defaultCamera() const = 0;

        /**
         * @brief Render the scene to a file
         * @param filepath - filename to render to
         */
        virtual void renderToFile(const std::filesystem::path &filepath) = 0;

        /**
         * @brief Add text in screen space
         * @param message - The content of the overlay text
         * @param x - The horizontal position of the text between 0 and 1
         * @param y - The vertical position of the text between 0 and 1
         * @param parameters - Addition text parameters
         * @return Unique id to later update the text instance
         */
        virtual Karana::Core::id_t
        addOverlayText(std::string_view message,
                       float x,
                       float y,
                       const TextParameters &parameters = TextParameters{}) = 0;

        /**
         * @brief Update the content of an existing overlay text
         * @param id - Id for the text returned by a prior addOverlayText call
         * @param message - The new content of the overlay text
         */
        virtual void setOverlayText(const Karana::Core::id_t &id, std::string_view message) = 0;

        /**
         * @brief Delete an overlay text instance
         * @param id - Id for the text returned by a prior addOverlayText call
         */
        virtual void removeOverlayText(const Karana::Core::id_t &id) = 0;
    };
} // namespace Karana::Scene