Program Listing for File CollisionScene.h

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

#pragma once
#include "Karana/Scene/CollisionSceneNode.h"
#include "Karana/Scene/CollisionScenePart.h"
#include "Karana/Scene/Scene.h"

namespace Karana::Scene {
    /**
     * @class CollisionScene
     * @brief Scene with added collision-specific interface
     *
     * See \sref{scene_layer_sec} for more discussion on
     * the scene layer.
     */
    class CollisionScene : public Scene {
        // Access needed for create/discard
        friend class CollisionSceneNode;
        friend class CollisionScenePart;

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

      public:
        virtual ~CollisionScene();

        /**
         * @brief Do a coarse sweep over the scene check for potential
         *        collisions.
         * @param callback - Function called for each potential collision
         */
        virtual void broadphase(std::function<void(const CollisionScenePart &,
                                                   const CollisionScenePart &)> callback) = 0;

        /**
         * @brief Do a sweep over the scene checking for collisions
         * @param callback - Function called for each collision
         * @param filter - Filter function called for each potential collision pair
         */
        virtual void
        sweep(const std::function<void(const CollisionInfo &collision)> &callback,
              const std::function<bool(const CollisionScenePart &, const CollisionScenePart &)>
                  &filter = nullptr) = 0;

        /**
         * @brief Get a list of collisions from the last sweep
         * @return The cached collisions
         */
        virtual const std::vector<CollisionInfo> &cachedCollisions() const = 0;

        /**
         * @brief Fetch a part by its id
         * @return The part
         */
        virtual const Karana::Core::ks_ptr<CollisionScenePart> &
            lookupPart(Karana::Core::id_t) const = 0;
    };
} // namespace Karana::Scene