Program Listing for File ImplDatabase.h

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

#pragma once
#include "Karana/KCore/SharedPointer.h"
#include "Karana/Scene/SceneNode.h"
#include <unordered_map>

namespace Karana::Scene {
    class ProxySceneNode;

    /// Helper to track node implementations across the ProxyScene
    class ImplDatabase {
      public:
        ImplDatabase();
        virtual ~ImplDatabase();

        /**
         * @brief Lookup the ProxySceneNode managing the given implementation
         * @param impl - The SceneNode in a client Scene
         * @return The corresponding ProxySceneNode
         */
        const Karana::Core::ks_ptr<ProxySceneNode> &lookupProxy(const SceneNode &impl) const;

        /**
         * @brief Register an implementation for a ProxySceneNode
         * @param proxy - The ProxySceneNode
         * @param impl - The client Scene implementation
         */
        void registerProxyImpl(const Karana::Core::ks_ptr<ProxySceneNode> &proxy,
                               const Karana::Core::ks_ptr<SceneNode> &impl);

        /**
         * @brief Unregister an implementation for a ProxySceneNode
         * @param proxy - The ProxySceneNode
         * @param impl - The client Scene implementation
         */
        void unregisterProxyImpl(const ProxySceneNode &proxy, const SceneNode &impl);

      private:
        std::unordered_map<Karana::Core::id_t, Karana::Core::ks_ptr<ProxySceneNode>>
            _impl_proxy_map;
    };
} // namespace Karana::Scene