Data descriptor for sparse volume data subsets.
More...
#include <isparse_volume_subset.h>
Inherits mi::base::Interface_declare< 0xad2ab72c, ... >.
Data descriptor for sparse volume data subsets.
This interface class is used by the NVIDIA IndeX library to communicate information about sparse volume sub-data to an application. NVIDIA IndeX is storing sparse volume data in a bricked format internally. This interface class gives detailed information about volume-brick data contained in the subset. The application is free to fill volume-data bricks or leave them empty, hence creating a sparse volume layout.
For level-of-detail volumes this interface requests volume-data bricks for potentially multiple levels-of-detail. The application is responsible to fill in all requested volume-data bricks in order to enable correct level-of-detail volume representation and rendering.
◆ get_dataset_lod_level_box()
| virtual mi::math::Bbox_struct< mi::Sint32, 3 > nv::index::ISparse_volume_subset_data_descriptor::get_dataset_lod_level_box |
( |
mi::Uint32 |
lod_level | ) |
const |
|
pure virtual |
Returns the bounding box of the requested level-of-detail in local voxel coordinates.
- Parameters
-
| [in] | lod_level | Level-of-detail for which to return the data bounding box. |
- Returns
- The bounding box of the requested level-of-detail in local voxel coordinates.
◆ get_dataset_lod_level_resolution()
| virtual mi::math::Vector_struct< mi::Uint32, 3 > nv::index::ISparse_volume_subset_data_descriptor::get_dataset_lod_level_resolution |
( |
mi::Uint32 |
lod_level | ) |
const |
|
pure virtual |
Returns the data resolution of the requested level-of-detail in local voxel coordinates.
- Parameters
-
| [in] | lod_level | Level-of-detail for which to return the data resolution. |
- Returns
- The data resolution of the requested level-of-detail in local voxel coordinates.
◆ get_dataset_number_of_lod_levels()
| virtual mi::Uint32 nv::index::ISparse_volume_subset_data_descriptor::get_dataset_number_of_lod_levels |
( |
| ) |
const |
|
pure virtual |
Returns the number of levels-of-detail in the volume dataset.
- Returns
- The number of levels-of-detail in the volume dataset
◆ get_lod_subset_data_brick_index()
| virtual mi::Uint32 nv::index::ISparse_volume_subset_data_descriptor::get_lod_subset_data_brick_index |
( |
mi::Uint32 |
lod_brick_index | ) |
const |
|
pure virtual |
Returns the subset-local volume-data brick index for a LOD data-brick in the view-dependent LOD working-set of the volume-data subset.
The subset-local index then is to be used to get the brick information using the get_subset_data_brick_info() method.
- Note
- LOD subset-information is not available during importer invocations. Such information will be available for distributed compute tasks on volume scene elements (i.e.,
IDistributed_compute_technique).
- Parameters
-
| [in] | lod_brick_index | LOD working-set brick index for which to return the subset-local index. |
- Returns
- The subset-local volume-data brick index for the requested data LOD brick.
◆ get_lod_subset_number_of_data_bricks()
| virtual mi::Uint32 nv::index::ISparse_volume_subset_data_descriptor::get_lod_subset_number_of_data_bricks |
( |
| ) |
const |
|
pure virtual |
Returns the number of volume-data bricks available in the view-dependent LOD working-set of the volume-data subset.
◆ get_subset_data_brick_dimensions()
| virtual mi::math::Vector_struct< mi::Uint32, 3 > nv::index::ISparse_volume_subset_data_descriptor::get_subset_data_brick_dimensions |
( |
| ) |
const |
|
pure virtual |
Returns the dimensions of the volume-data bricks.
◆ get_subset_data_brick_info()
| virtual const Data_brick_info nv::index::ISparse_volume_subset_data_descriptor::get_subset_data_brick_info |
( |
mi::Uint32 |
brick_index | ) |
const |
|
pure virtual |
Returns the volume-data brick information for a selected data brick in the complete non-view-dependent volume subset.
- Parameters
-
| [in] | brick_index | Volume-data brick index for which to return the information. |
- Returns
- The volume-data brick information (
Data_brick_info) for the requested data brick.
◆ get_subset_data_brick_shared_border_size()
| virtual mi::Uint32 nv::index::ISparse_volume_subset_data_descriptor::get_subset_data_brick_shared_border_size |
( |
| ) |
const |
|
pure virtual |
Returns the size of the shared volume-data brick boundary.
◆ get_subset_lod_data_bounds()
| virtual mi::math::Bbox_struct< mi::Sint32, 3 > nv::index::ISparse_volume_subset_data_descriptor::get_subset_lod_data_bounds |
( |
mi::Uint32 |
lod_level | ) |
const |
|
pure virtual |
Returns the data bounds covering all volume-data bricks required for the subset on a particular level-of-detail.
- Parameters
-
| [in] | lod_level | Level-of-detail for which to return the subset-data bounding box. |
- Returns
- The data bounds covering all volume-data bricks required for this subset the requested level-of-detail.
◆ get_subset_lod_level_range()
| virtual mi::math::Vector_struct< mi::Uint32, 2 > nv::index::ISparse_volume_subset_data_descriptor::get_subset_lod_level_range |
( |
| ) |
const |
|
pure virtual |
Returns the level-of-detail range used by the subset.
The components of the returned vector indicate the lowest (x-component) and highest (y-component) level-of-detail used by the subset.
◆ get_subset_number_of_data_bricks()
| virtual mi::Uint32 nv::index::ISparse_volume_subset_data_descriptor::get_subset_number_of_data_bricks |
( |
| ) |
const |
|
pure virtual |
Returns the number of volume-data bricks available in the complete non-view-dependent volume-data subset.
The documentation for this class was generated from the following file:
