Program Listing for File CoalGeometryCache.h

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

#pragma once
#include "Karana/KCore/Id.h"
#include "Karana/KCore/SharedPointer.h"
#include "Karana/Scene/StaticGeometry.h"
#include <map>
#include <memory>
#include <utility>

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

namespace Karana::Scene {
    /// Helper to cache and reuse native COAL geometries
    class CoalGeometryCache {
      public:
        CoalGeometryCache() = default;
        ~CoalGeometryCache() = default;

        // Scene parts retain a reference to this cache, so its identity must
        // remain stable throughout the owning scene's lifetime.
        CoalGeometryCache(const CoalGeometryCache &) = delete;
        CoalGeometryCache &operator=(const CoalGeometryCache &) = delete;
        CoalGeometryCache(CoalGeometryCache &&) = delete;
        CoalGeometryCache &operator=(CoalGeometryCache &&) = delete;

        /**
         * @brief Get the native COAL geometry for a Scene Geometry.
         *
         * NaN holes in HeightFieldGeometry are filled with
         * HeightFieldGeometry::fillHoles() before creating the finite native
         * COAL heightfield. The supplied Scene geometry is not modified.
         *
         * @param geometry A Scene Geometry.
         * @param scale Positive uniform scale baked into the native geometry.
         * @return A corresponding COAL geometry.
         */
        Karana::Core::ks_ptr<coal::CollisionGeometry> get(const VarStaticGeometry &geometry,
                                                          double scale = 1.0) const;

      private:
        // Scale changes are infrequent and produce only a few entries per source geometry, so an
        // ordered map uses the pair's native lexicographic comparison and avoids a custom hash.
        // Expired weak entries are pruned whenever a geometry is requested.
        mutable std::map<std::pair<Karana::Core::id_t, double>,
                         std::weak_ptr<coal::CollisionGeometry>>
            _geometry_map;
    };
} // namespace Karana::Scene