Program Listing for File WebScenePart.h

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

#pragma once
#include "Karana/Math/Defs.h"
#include "Karana/Scene/GraphicalScenePart.h"
#include "Karana/Scene/Material.h"
#include "Karana/Scene/StaticGeometry.h"
#include "Karana/WebScene/WebResourceManager.h"
#include "Karana/WebScene/WebSceneNode.h"

namespace Karana::Scene {
    /**
     * @class WebScenePart
     * @brief GraphicalScenePart implementation for WebScene
     *
     * See \sref{scene_layer_sec} for more discussion on
     * the scene layer.
     */
    class WebScenePart : public WebSceneNode, public GraphicalScenePart {
      public:
        /**
         * @brief WebScenePart constructor. The constructor is not meant to be called directly.
         *        Please use the create(...) method instead to create an instance.
         *
         * @param name - Name of the WebScenePart.
         * @param scene - The WebScene to add the part to.
         * @param geometry - Geometry of the WebScenePart.
         * @param material - Material for the WebScenePart.
         * @param layers - Layers to use for the WebScenePart.
         * @param server - Server to communicate with frontends.
         * @param resource_manager - Helper to manage frontend resources.
         */
        WebScenePart(std::string_view name,
                     const kc::ks_ptr<Scene> &scene,
                     const VarStaticGeometry &geometry,
                     const VarMaterial &material,
                     layer_t layers,
                     const Karana::Core::ks_ptr<Karana::WebUI::Server> &server,
                     const Karana::Core::ks_ptr<WebResourceManager> &resource_manager);

        /**
         * @brief Create a WebScenePart.
         *
         * @param name - Name of the WebScenePart.
         * @param scene - The GraphicalScene to add the WebScenePart to.
         * @param geometry - Geometry of the WebScenePart.
         * @param material - Material for the WebScenePart.
         * @param layers - Layers to use for the WebScenePart.
         * @return The new WebScene part.
         */
        static kc::ks_ptr<WebScenePart> create(std::string_view name,
                                               const kc::ks_ptr<WebScene> &scene,
                                               const VarStaticGeometry &geometry,
                                               const VarMaterial &material = defaultMaterial(),
                                               layer_t layers = LAYER_PHYSICAL);

        void setMaterial(const VarMaterial &material) override;

        void setIntrinsicScale(const Karana::Math::Vec3 &scale) override;
        const Karana::Math::Vec3 &getIntrinsicScale() const override;

        /**
         * @brief Draw an outline around the part
         */
        void outline();

        /**
         * @brief Remove a previously added outline
         */
        void removeOutline();

      private:
        friend class WebScene; // For access to _ioHandleConn
        void _ioHandleConn(Karana::WebUI::Connection &conn) const override;

        static void _ioSendSetIntrinsicScaleMsg(
            const std::function<void(const uint8_t *data, size_t len)> &send,
            long id,
            const Karana::Math::Vec3 &scale);

        static void
        _ioSendSetMaterialMsg(const std::function<void(const uint8_t *data, size_t len)> &send,
                              long id,
                              long material_id);

        static void _ioSendOutlineMsg(
            const std::function<void(const uint8_t *data, size_t len)> &send, long id, bool pulse);

        static void
        _ioSendRemoveOutlineMsg(const std::function<void(const uint8_t *data, size_t len)> &send,
                                long id);

        const Karana::Core::ks_ptr<WebResourceManager> _resource_manager;
        Karana::Math::Vec3 _io_intrinsic_scale = {1.0, 1.0, 1.0};
        VarMaterial _io_material;
        bool _io_outline;
    };
} // namespace Karana::Scene