Program Listing for File WebSceneNode.h

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

#pragma once
#include "Karana/Math/Defs.h"
#include "Karana/Math/UnitQuaternion.h"
#include "Karana/Scene/GraphicalSceneNode.h"
#include "Karana/WebUI/Server.h"

namespace Karana::Scene {
    class WebScene;
    /**
     * @class WebSceneNode
     * @brief GraphicalSceneNode implementation for WebScene
     *
     * See \sref{scene_layer_sec} for more discussion on
     * the scene layer.
     */
    class WebSceneNode : public virtual GraphicalSceneNode {
      public:
        /**
         * @brief WebSceneNode 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 WebSceneNode
         * @param server - Server to communicate with frontends
         * @param scene - WebScene to add the node to.
         */
        WebSceneNode(std::string_view name,
                     const kc::ks_ptr<Scene> &scene,
                     const Karana::Core::ks_ptr<Karana::WebUI::Server> &server);

        /**
         * @brief Create a WebSceneNode.
         * @param name - Name of the node.
         * @param scene - The WebScene to add the node to.
         * @return The created WebSceneNode.
         */
        static Karana::Core::ks_ptr<WebSceneNode>
        create(std::string_view name, const Karana::Core::ks_ptr<WebScene> &scene);

        void setUnitQuaternion(const Karana::Math::UnitQuaternion &quaternion) override;

        void setTranslation(const Karana::Math::Vec3 &translation) override;

        void setScale(double scale) override;

        void setTransform(const Karana::Math::SimTran &transform) override;

        void setVisible(bool visible) override;

        void attachTo(const Karana::Core::ks_ptr<SceneNode> &parent,
                      bool maintain_world_transform = false) override;

        void detach(bool maintain_world_transform = false) override;

        void showAxes(float size = 1) override;

        void trail(const Karana::Core::ks_ptr<GraphicalSceneNode> &relative_to = nullptr,
                   const Color &color = Color::WHITE) override;

        void removeTrail() override;

      protected:
        friend class WebScene; // For access to _ioHandleConn
        /**
         * @brief Handler for a new frontend connection
         * @param conn - Connection to the new frontend
         */
        virtual void _ioHandleConn(Karana::WebUI::Connection &conn) const;

        /// Server to communicate with frontends
        Karana::Core::ks_ptr<Karana::WebUI::Server> _server;

      private:
        Karana::Math::SimTran _io_object_transform{};
        std::optional<Karana::Core::id_t> _io_parent_id = std::nullopt;
        float _io_axes_size = 0;

        // nullopt indicates no trail, id 0 indicates trail with respect to origin
        std::optional<Karana::Core::id_t> _io_trail_wrt_id;
        Color _io_trail_color;

        bool _io_visible = true;

        static void
        _ioSendSetTransformMsg(const std::function<void(const uint8_t *data, size_t len)> &send,
                               long id,
                               const Karana::Math::SimTran &transform);
        static void _ioSendShowAxesMsg(
            const std::function<void(const uint8_t *data, size_t len)> &send, long id, float size);
        static void
        _ioSendAttachToMsg(const std::function<void(const uint8_t *data, size_t len)> &send,
                           long id,
                           long parent_id);
        static void
        _ioSendDetachMsg(const std::function<void(const uint8_t *data, size_t len)> &send, long id);

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

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

        static void
        _ioSendSetVisibleMsg(const std::function<void(const uint8_t *data, size_t len)> &send,
                             long id,
                             bool visible);
    };
} // namespace Karana::Scene