xac_interface_scene_elements_vdb_volume_doc.h

Go to the documentation of this file.

/******************************************************************************
 * Copyright 2023 NVIDIA Corporation. All rights reserved.
 *****************************************************************************/
 
namespace nv {
namespace index {
namespace xac {
 
struct Sample_info_vdb : Sample_info
{
    float3                        sample_position_object_space;
};
 
enum class VDB_grid_type : uint32_t 
{ 
    Unknown = 0,
    Float   = 1, //  single precision floating point value
    Fp4     = 13,// 4bit quantization of float point value
    Fp8     = 14,// 8bit quantization of float point value
    Fp16    = 15,// 16bit quantization of float point value
    FpN     = 16// variable bit quantization of floating point value
};
 
template<typename                   VDB_attrib_type,
         VDB_volume_filter_mode     VDB_filter_mode,
         typename                   VDB_grid_type,
         bool                       VDB_sampler_use_cache>
class VDB_sampler
{
 
public:
 
    VDB_attrib_type    fetch_sample(const float3& sample_position) const;
    
    float4              fetch_sample_classify(  const float3& sample_position,
                                                const xac::Colormap& color_map) const;
 
};
 
class VDB_volume
{
public:
    typedef Sample_info_vdb           Base_info_type;
 
    template<typename                   VDB_attrib_type,
             Volume_filter_mode         VDB_filter_mode         = default_filter_mode,
             typename                   VDB_grid_type           = default_grid_type,
             bool                       VDB_sampler_use_cache   = yes>
    VDB_sampler<VDB_attrib_type,
                VDB_filter_mode,
                VDB_grid_type,
                VDB_sampler_use_cache>       generate_sampler(
                                                        const unsigned attrib_idx = 0u) 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;
 
};
 
} // namespace xac
} // namespace index
} // namespace nv