xac_interface_scene_elements_sparse_volume_doc.h

Go to the documentation of this file.

/******************************************************************************
 * Copyright 2023 NVIDIA Corporation. All rights reserved.
 *****************************************************************************/
 
namespace nv {
namespace index {
namespace xac {
 
struct Sparse_volume_sample_context
{
    explicit Sparse_volume_sample_context() {}
};
 
struct Sample_info_sparse_volume : Sample_info
{
    Sparse_volume_sample_context  sample_context;
    float3                        sample_position_object_space_normalized;
    float3                        sample_position_object_space;
};
 
struct Data_point_access;
 
template<typename T> T read_native_voxel(
    const unsigned           attrib_idx,
    const Data_point_access& );
 
 
template<typename T> void write_native_voxel(
    const T&                 value,
    const unsigned           attrib_idx,
    Data_point_access&       );
}
 
struct Data_point_output_sparse_volume
{
    template<typename T>
    void write_value(const unsigned attrib_idx, const T& value) {
        xac::write_native_voxel(value, attrib_idx, dp_access);
    }
};
 
struct Data_point_info_sparse_volume
{
    xac::Data_point_access& dp_access;
 
    float3                   position;
 
    float3 get_position() const { return position; }
 
    bool   is_valid()     const { return true; }
};
 
enum class Volume_filter_mode : unsigned
{
     NEAREST,
     TRILINEAR,
     TRICUBIC_CATMUL,
     TRICUBIC_BSPLINE
};
 
enum class Volume_classification_mode : unsigned
{
     POST_INTERPOLATION,
     PRE_INTERPOLATION
};
 
template<typename                   SVOL_attrib_type,
         Volume_filter_mode         SVOL_filter_mode,
         Volume_classification_mode SVOL_classify_mode>
class Sparse_volume_sampler
{
 
public:
 
    SVOL_attrib_type    fetch_sample(const float3& sample_position) const;
    
    float4              fetch_sample_classify(  const float3& sample_position,
                                                const xac::Colormap& color_map) const;
 
};
 
class Sparse_volume
{
public:
    typedef Sample_info_sparse_volume           Base_info_type;
 
    template<typename                   SVOL_attrib_type,
             Volume_filter_mode         SVOL_filter_mode    = default_filter_mode,
             Volume_classification_mode SVOL_classify_mode  = default_classification_mode>
    Sparse_volume_sampler<SVOL_attrib_type,
                          SVOL_filter_mode,
                          SVOL_classify_mode>       generate_sampler(
                                                        const unsigned                      attrib_idx,
                                                        const Sparse_volume_sample_context& sample_context) const;
 
    template<typename                   SVOL_attrib_type,
             Volume_filter_mode         SVOL_filter_mode    = default_filter_mode,
             Volume_classification_mode SVOL_classify_mode  = default_classification_mode>
    Sparse_volume_sampler<SVOL_attrib_type,
                          SVOL_filter_mode,
                          SVOL_classify_mode>       generate_sampler(
                                                        const unsigned                      attrib_idx) const;
 
    xac::Colormap       get_colormap() const;
 
    float               get_sample_distance() const
 
    const float3&       get_volume_bbox_min() const;
 
    const float3&       get_volume_bbox_max() const;
 
    const Mat4x4f&      get_scene_to_object_transform() const;
 
    const Mat4x4f&      get_scene_to_object_transform_inverse() const;
 
    template<typename SVOL_attrib_type>
    SVOL_attrib_type    get_attribute(
                            const unsigned                          attrib_idx,
                            const Data_point_info_sparse_volume&    data_point_info) const 
{
 
};
 
} // namespace xac
} // namespace index
} // namespace nv