Program Listing for File CoalScene.h

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

#pragma once
#include "Karana/CoalScene/CoalGeometryCache.h"
#include "Karana/CoalScene/CoalSceneNode.h"
#include "Karana/CoalScene/CoalScenePart.h"
#include "Karana/KCore/SharedPointer.h"
#include "Karana/Scene/CollisionInfo.h"
#include "Karana/Scene/CollisionScene.h"
#include "Karana/Scene/Material.h"
#include "Karana/Scene/StaticGeometry.h"
#include <memory>

namespace coal {
    class BroadPhaseCollisionManager; // forward declaration. Full class included in the cc file.
}

namespace Karana::Scene {
    class CoalScenePart; // forward declare. Full class included in the cc file.
    /**
     * @class CoalScene
     * @brief CollisionScene implementation using the COAL library
     *
     * See \sref{scene_layer_sec} for more discussion on
     * the scene layer.
     */
    class CoalScene : public CollisionScene {
        // Access needed for create/discard
        friend class CoalSceneNode;
        friend class CoalScenePart;

      public:
        /**
         * @brief CoalScene constructor.
         * @param name - Name for the CoalScene.
         */
        CoalScene(std::string_view name);
        ~CoalScene();

        /**
         * @brief Create a CoalScene
         * @param name - Name for the CoalScene
         * @return The created CoalScene
         */
        static Karana::Core::ks_ptr<CoalScene> create(std::string_view name);

        void broadphase(std::function<void(const CollisionScenePart &, const CollisionScenePart &)>
                            callback) override;

        void sweep(const std::function<void(const CollisionInfo &collision)> &callback,
                   const std::function<bool(const CollisionScenePart &, const CollisionScenePart &)>
                       &filter = nullptr) override;

        const std::vector<CollisionInfo> &cachedCollisions() const override;

        const Karana::Core::ks_ptr<CollisionScenePart> &
            lookupPart(Karana::Core::id_t) const override;

      protected:
        /**
         * @brief This does the work to discard the CoalScene.
         * @param base - A Base pointer to the CoalScene to discard.
         */
        virtual void _discard(Karana::Core::ks_ptr<Karana::Core::Base> &base) override;

      private:
        Karana::Core::ks_ptr<SceneNode> _createNodeBase(std::string_view name) override;
        void _discardNodeBase(Karana::Core::ks_ptr<SceneNode> &node,
                              bool recursive = true) override;
        Karana::Core::ks_ptr<ScenePart> _createPartBase(std::string_view name,
                                                        const VarStaticGeometry &geometry,
                                                        const VarMaterial &material,
                                                        layer_t layers) override;
        void _discardPartBase(Karana::Core::ks_ptr<ScenePart> &part) override;

        const CoalGeometryCache _geometry_cache;
        const std::unique_ptr<coal::BroadPhaseCollisionManager> _broadphase;
        std::unordered_map<Karana::Core::id_t, Karana::Core::ks_ptr<CollisionScenePart>> _part_map;
        Karana::Core::RegistryList<CoalScenePart> _parts;
        std::vector<CollisionInfo> _cached_collisions = {};
    };
} // namespace Karana::Scene