Program Listing for File WebResourceManager.h

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

#pragma once

#include <cstdint>
#include <functional>
#include <memory>
#include <unordered_map>

#include "Karana/KCore/SharedPointer.h"
#include "Karana/Scene/Material.h"
#include "Karana/Scene/StaticGeometry.h"
#include "Karana/Scene/Texture.h"
#include "Karana/WebUI/Server.h"

namespace Karana::Scene {
    /**
     * @brief Helper for sending resources such as geometries and materials to
     * frontends
     */
    class WebResourceManager {
      public:
        /**
         * @brief WebResourceManager constructor
         * @param server - Server to handle communicating with frontends
         */
        WebResourceManager(const Karana::Core::ks_ptr<Karana::WebUI::Server> &server);
        virtual ~WebResourceManager();

        /**
         * @brief Idempotently send a geometry to current and future frontends
         * @param geometry - The geometry to send
         */
        void ensureGeometry(const VarStaticGeometry &geometry);

        /**
         * @brief Idempotently send a material to current and future frontends
         * @param material - The material to send
         */
        void ensureMaterial(const VarMaterial &material);

        /**
         * @brief Handler for a new frontend connection
         * @param conn - Connection to the new frontend
         */
        void ioHandleConn(Karana::WebUI::Connection &conn) const;

      private:
        void _ioEnsureGeometry(const VarStaticGeometry &geometry);
        void _ioEnsureMaterial(const VarMaterial &material);
        void _ioEnsureTexture(const kc::ks_ptr<const Texture> &texture);
        void _ioEnsureMaterialTextures(const PhysicalMaterial &material);
        void _ioEnsureMaterialTextures(const PhongMaterial &material);

        static void
        _ioSendCreateGeometryMsg(const std::function<void(const uint8_t *data, size_t len)> &send,
                                 const BoxGeometry &box);
        static void
        _ioSendCreateGeometryMsg(const std::function<void(const uint8_t *data, size_t len)> &send,
                                 const CapsuleGeometry &capsule);
        static void
        _ioSendCreateGeometryMsg(const std::function<void(const uint8_t *data, size_t len)> &send,
                                 const ConeGeometry &cone);
        static void
        _ioSendCreateGeometryMsg(const std::function<void(const uint8_t *data, size_t len)> &send,
                                 const CylinderGeometry &cylinder);
        static void
        _ioSendCreateGeometryMsg(const std::function<void(const uint8_t *data, size_t len)> &send,
                                 const RoundFrustumGeometry &frustum);
        static void
        _ioSendCreateGeometryMsg(const std::function<void(const uint8_t *data, size_t len)> &send,
                                 const SphereGeometry &sphere);
        static void
        _ioSendCreateGeometryMsg(const std::function<void(const uint8_t *data, size_t len)> &send,
                                 const StaticMeshGeometry &mesh);
        void
        _ioSendCreateMaterialMsg(const std::function<void(const uint8_t *data, size_t len)> &send,
                                 const PhysicalMaterial &material) const;
        void
        _ioSendCreateMaterialMsg(const std::function<void(const uint8_t *data, size_t len)> &send,
                                 const PhongMaterial &material) const;
        static void
        _ioSendCreateTextureMsg(const std::function<void(const uint8_t *data, size_t len)> &send,
                                long id,
                                const kc::ks_ptr<const Texture> &texture);

        const Karana::Core::ks_ptr<Karana::WebUI::Server> _server;
        std::unordered_map<Karana::Core::id_t, VarStaticGeometry> _io_seen_geometries;
        std::unordered_map<Karana::Core::id_t, VarMaterial> _io_seen_materials;
        /// Map from Scene::Texture IDs to WebScene texture IDs
        std::unordered_map<Karana::Core::id_t, Karana::Core::id_t> _io_texture_ids;
        /// Map from Scene::Texture IDs to weak ptrs of Scene::Texture
        std::unordered_map<Karana::Core::id_t, std::weak_ptr<const Texture>> _io_textures;
    };
} // namespace Karana::Scene