Program Listing for File Scene.h

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

#pragma once
#include "Karana/KCore/Base.h"
#include "Karana/KCore/UsageTrackingMap.h"
#include "Karana/Scene/Material.h"
#include "Karana/Scene/SceneNode.h"
#include "Karana/Scene/ScenePart.h"
#include "Karana/Scene/StaticGeometry.h"

namespace Karana::Scene {

    /**
     * @class Scene
     * @brief Base container for a hierarchy of geometries
     *
     * See \sref{scene_layer_sec} for more discussion on
     * the scene layer.
     */
    class Scene : public Karana::Core::Base {

        // For create/discard methods
        friend class SceneNode;
        friend class ScenePart;
        friend class ProxySceneNode;
        friend class ProxyScenePart;

      protected:
        /**
         * @brief Scene constructor.
         * @param name - Name of the Scene.
         */
        Scene(std::string_view name);

      public:
        virtual ~Scene();

        /**
         * @brief Get the Scene managing this one
         * @return The managing scene or nullptr
         */
        Karana::Core::ks_ptr<Scene> getManager() const;

        /**
         * @brief Assign a managing scene
         * @param manager The scene managing this one (nullable)
         */
        void setManager(const Karana::Core::ks_ptr<Scene> &manager);

      protected:
        /**
         * @brief Discard the scene. Derived scenes need to implement this with the logic required
         *        to discard their scene.
         * @param s - A pointer to the scene to discard.
         */
        void _discard(Karana::Core::ks_ptr<Karana::Core::Base> &s) override = 0;

        /**
         * @brief Helper to create a SceneNode.
         *
         * Derived scenes should implement by calling their
         * non-virtual createNode. This is to support
         * derived return types.
         *
         * @param name - Name for the SceneNode.
         * @return The created SceneNode.
         */
        virtual Karana::Core::ks_ptr<SceneNode> _createNodeBase(std::string_view name) = 0;

        /**
         * @brief Discard the provided node.
         *        Derived scenes should implement downcasting and
         *        calling their non-abstract _discardNodeBase.
         * @param node - The node to discard.
         * @param recursive - If `true`, then also discard all the children recursively. If `false`,
         * then children are moved up the tree with the same pose.
         */
        virtual void _discardNodeBase(Karana::Core::ks_ptr<SceneNode> &node,
                                      bool recursive = true) = 0;

        /**
         * @brief Helper to create a ScenePart.
         *
         * Derived scenes should implement by calling their
         * non-virtual createPart. This is to support
         * derived return types.
         *
         * @param name - Name of the ScenePart.
         * @param geometry - Geometry of the ScenePart.
         * @param material - Material of the ScenePart.
         * @param layers - Layers bitmask for the ScenePart.
         * @return The created ScenePart.
         */
        virtual Karana::Core::ks_ptr<ScenePart> _createPartBase(std::string_view name,
                                                                const VarStaticGeometry &geometry,
                                                                const VarMaterial &material,
                                                                layer_t layers) = 0;

        /**
         * @brief Helper to discard a ScenePart.
         *
         * Derived scenes should implement downcasting and
         * calling their non-abstract _discardPartBase.
         *
         * @param part - The ScenePart to discard.
         */
        virtual void _discardPartBase(Karana::Core::ks_ptr<ScenePart> &part) = 0;

        /**
         * @brief Track the usage of a SceneNode.
         * @param node - The SceneNode to track.
         */
        void _track(const Karana::Core::ks_ptr<SceneNode> &node);

        /**
         * @brief Stop tracking the usage of a SceneNode
         * @param node - The SceneNode to stop tracking.
         */
        void _untrack(Karana::Core::ks_ptr<SceneNode> &node);

      protected:
        /// The scene managing this one (if any)
        std::weak_ptr<Scene> _manager;

      private:
        Karana::Core::UsageTrackingMap<Karana::Core::id_t, SceneNode> _node_tracking_map;
    };
} // namespace Karana::Scene