NVIDIA IndeX API nvidia_logo_transpbg.gif Up
nv::index::xac::VDB_sampler<VDB_attrib_type, VDB_filter_mode, VDB_grid_type, VDB_sampler_use_cache> Class Template Reference

VDB volume sampler for retrieving filtered and optionally classified volume samples. More...

#include <xac_interface_scene_elements_vdb_volume_doc.h>

Public Member Functions

VDB_attrib_type fetch_sample (const float3 &sample_position) const
 Sample a VDB volume attribute at the provided sample location. More...
 
float4 fetch_sample_classify (const float3 &sample_position, const xac::Colormap &color_map) const
 Sample a VDB volume attribute at the provided sample location. More...
 

Detailed Description

template<typename VDB_attrib_type, VDB_volume_filter_mode VDB_filter_mode, typename VDB_grid_type, bool VDB_sampler_use_cache>
class nv::index::xac::VDB_sampler<VDB_attrib_type, VDB_filter_mode, VDB_grid_type, VDB_sampler_use_cache>

VDB volume sampler for retrieving filtered and optionally classified volume samples.

Member Function Documentation

 fetch_sample()

template<typename VDB_attrib_type , VDB_volume_filter_mode VDB_filter_mode, typename VDB_grid_type , bool VDB_sampler_use_cache>
VDB_attrib_type nv::index::xac::VDB_sampler< VDB_attrib_type, VDB_filter_mode, VDB_grid_type, VDB_sampler_use_cache >::fetch_sample ( const float3 &  sample_position) const

Sample a VDB volume attribute at the provided sample location.

This method always returns a filtered volume sample without classifying it using a colormap.

Parameters
[in]sample_positionSample position defined in volume local/object space.
Returns
Filtered volume sample according to the selected volume filter mode.

 fetch_sample_classify()

template<typename VDB_attrib_type , VDB_volume_filter_mode VDB_filter_mode, typename VDB_grid_type , bool VDB_sampler_use_cache>
float4 nv::index::xac::VDB_sampler< VDB_attrib_type, VDB_filter_mode, VDB_grid_type, VDB_sampler_use_cache >::fetch_sample_classify ( const float3 &  sample_position,
const xac::Colormap color_map 
) const

Sample a VDB volume attribute at the provided sample location.

This method always returns a filtered and classified volume sample using the provided colormap.

Parameters
[in]sample_positionSample position defined in volume local/object space.
[in]color_mapColormap for classification of volume sample.
Returns
Filtered and classified volume sample according to the selected volume filter mode and volume classification mode.

The documentation for this class was generated from the following file: