remove_occluded_instances.h

/*
 * Copyright 2026 Adobe. All rights reserved.
 * This file is licensed to you under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License. You may obtain a copy
 * of the License at http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software distributed under
 * the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR REPRESENTATIONS
 * OF ANY KIND, either express or implied. See the License for the specific language
 * governing permissions and limitations under the License.
 */
#pragma once
 
#include <lagrange/raycasting/api.h>
#include <lagrange/scene/SimpleScene.h>
#include <lagrange/utils/ProgressCallback.h>
#include <lagrange/utils/function_ref.h>
#include <lagrange/utils/value_ptr.h>
 
#include <atomic>
 
namespace lagrange::raycasting {


template <typename Scalar, typename Index>
class LA_RAYCASTING_API OccludedInstanceSampler
{
public:
    explicit OccludedInstanceSampler(
        const scene::SimpleScene<Scalar, Index, 3>& scene,
        function_ref<bool(Index mesh_index, Index instance_index)> is_occluder = [](Index, Index) {
            return true;
        });
 
    ~OccludedInstanceSampler();
    OccludedInstanceSampler(OccludedInstanceSampler&&) noexcept;
    OccludedInstanceSampler& operator=(OccludedInstanceSampler&&) noexcept;

    void run_batch(uint64_t num_rays);

    bool is_visible(Index global_index) const;

    uint64_t num_rays_cast(Index global_index) const;

    Index num_instances() const;
 
private:
    struct Impl;
    value_ptr<Impl> m_impl;
};

struct OccludedInstanceEstimateOptions
{
    uint64_t num_rays = 1600000000ULL;

    uint64_t batch_size = 20000000ULL;

    bool until_converged = false;
};

template <typename Scalar, typename Index>
LA_RAYCASTING_API void estimate_occluded_instances(
    OccludedInstanceSampler<Scalar, Index>& sampler,
    const OccludedInstanceEstimateOptions& options,
    ProgressCallback& progress,
    const std::atomic_bool* cancel = nullptr);

template <typename Scalar, typename Index>
LA_RAYCASTING_API void estimate_occluded_instances(
    const scene::SimpleScene<Scalar, Index, 3>& scene,
    function_ref<void(Index mesh_index, Index instance_index)> callback,
    const OccludedInstanceEstimateOptions& options,
    ProgressCallback& progress,
    function_ref<bool(Index mesh_index, Index instance_index)> is_occluder =
        [](Index, Index) { return true; },
    const std::atomic_bool* cancel = nullptr);

template <typename Scalar, typename Index>
LA_RAYCASTING_API scene::SimpleScene<Scalar, Index, 3> remove_occluded_instances(
    const scene::SimpleScene<Scalar, Index, 3>& scene,
    const OccludedInstanceEstimateOptions& options,
    ProgressCallback& progress,
    function_ref<bool(Index mesh_index, Index instance_index)> is_occluder =
        [](Index, Index) { return true; },
    const std::atomic_bool* cancel = nullptr);

 
} // namespace lagrange::raycasting