NVIDIA IndeX API nvidia_logo_transpbg.gif Up
nv::index::IHeight_field_subset_data_descriptor Class Referenceabstract

Subset-data descriptor for tiled height-field subsets. More...

#include <iheight_field_subset.h>

Inherits mi::base::Interface_declare< 0x88014528, ... >.

Classes

struct  Data_tile_info
 Structual information regarding internal tile data representations. More...
 

Public Member Functions

virtual mi::Uint32 get_dataset_number_of_lod_levels () const =0
 Returns the number of levels-of-detail in the height-field dataset. More...
 
virtual mi::math::Bbox_struct< mi::Sint32, 3 > get_dataset_lod_level_box (mi::Uint32 lod_level) const =0
 Returns the bounding box of the requested level-of-detail in local pixel coordinates. More...
 
virtual mi::math::Vector_struct< mi::Uint32, 2 > get_dataset_lod_level_resolution (mi::Uint32 lod_level) const =0
 Returns the data resolution of the requested level-of-detail in 2d coordinates. More...
 
virtual mi::math::Vector_struct< mi::Uint32, 2 > get_subset_data_tile_dimensions () const =0
 Returns the dimensions of the height-field data tiles. More...
 
virtual mi::Uint32 get_subset_data_tile_shared_border_size () const =0
 Returns the size of the shared height-field data tile boundary. More...
 
virtual mi::math::Bbox_struct< mi::Sint32, 3 > get_subset_lod_data_bounds (mi::Uint32 lod_level) const =0
 Returns the data bounds covering all height-field data tiles required for the subset on a particular level-of-detail. More...
 
virtual mi::math::Vector_struct< mi::Uint32, 2 > get_subset_lod_level_range () const =0
 Returns the level-of-detail range used by the subset. More...
 
virtual mi::Uint32 get_subset_number_of_data_tiles () const =0
 Returns the number of height-field data-tiles available in the height-field data subset. More...
 
virtual const Data_tile_info get_subset_data_tile_info (mi::Uint32 tile_index) const =0
 Returns the height-field data tile information for a selected data tile. More...
 

Detailed Description

Subset-data descriptor for tiled height-field subsets.

This interface class is used by the NVIDIA IndeX library to communicate information about tiled height-field sub-data to an application.

Member Function Documentation

 get_dataset_lod_level_box()

virtual mi::math::Bbox_struct< mi::Sint32, 3 > nv::index::IHeight_field_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 pixel coordinates.

Parameters
[in]lod_levelLevel-of-detail for which to return the data bounding box.
Returns
The bounding box of the requested level-of-detail in local pixel coordinates.

 get_dataset_lod_level_resolution()

virtual mi::math::Vector_struct< mi::Uint32, 2 > nv::index::IHeight_field_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 2d coordinates.

Parameters
[in]lod_levelLevel-of-detail for which to return the data resolution.
Returns
The data resolution of the requested level-of-detail in 2d coordinates.

 get_dataset_number_of_lod_levels()

virtual mi::Uint32 nv::index::IHeight_field_subset_data_descriptor::get_dataset_number_of_lod_levels ( ) const
pure virtual

Returns the number of levels-of-detail in the height-field dataset.

Returns
The number of levels-of-detail in the height-field dataset

 get_subset_data_tile_dimensions()

virtual mi::math::Vector_struct< mi::Uint32, 2 > nv::index::IHeight_field_subset_data_descriptor::get_subset_data_tile_dimensions ( ) const
pure virtual

Returns the dimensions of the height-field data tiles.

 get_subset_data_tile_info()

virtual const Data_tile_info nv::index::IHeight_field_subset_data_descriptor::get_subset_data_tile_info ( mi::Uint32  tile_index) const
pure virtual

Returns the height-field data tile information for a selected data tile.

Parameters
[in]tile_indexheight-field data tile index for which to return the information.
Returns
The height-field data tile information (Data_tile_info) for the requested data tile.

 get_subset_data_tile_shared_border_size()

virtual mi::Uint32 nv::index::IHeight_field_subset_data_descriptor::get_subset_data_tile_shared_border_size ( ) const
pure virtual

Returns the size of the shared height-field data tile boundary.

 get_subset_lod_data_bounds()

virtual mi::math::Bbox_struct< mi::Sint32, 3 > nv::index::IHeight_field_subset_data_descriptor::get_subset_lod_data_bounds ( mi::Uint32  lod_level) const
pure virtual

Returns the data bounds covering all height-field data tiles required for the subset on a particular level-of-detail.

Parameters
[in]lod_levelLevel-of-detail for which to return the subset-data bounding box.
Returns
The data bounds covering all height-field data tiles required for this subset the requested level-of-detail.

 get_subset_lod_level_range()

virtual mi::math::Vector_struct< mi::Uint32, 2 > nv::index::IHeight_field_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 hightest (y-component) level-of-detail used by the subset.

 get_subset_number_of_data_tiles()

virtual mi::Uint32 nv::index::IHeight_field_subset_data_descriptor::get_subset_number_of_data_tiles ( ) const
pure virtual

Returns the number of height-field data-tiles available in the height-field data subset.


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