NVIDIA IndeX API nvidia_logo_transpbg.gif Up
Public Member Functions | List of all members
nv::index::Distributed_height_field_locality_query_mode Class Reference
NVIDIA IndeX API » Data Distribution » Data Locality

Implements the height field specific query mode height field patches. More...

#include <idistributed_data_locality.h>

Inherits mi::base::Interface_implement< nv::index::IDistributed_height_field_locality_query_mode >.

Public Member Functions

 Distributed_height_field_locality_query_mode (Height_field_locality_query_mode query_mode, const mi::neuraylib::Tag_struct &tag, const mi::math::Bbox_struct< mi::Float32, 2 > &coverage)
 Instantiating a query method using the distributed dataset unique identifier and a given region of interest. More...
 
 Distributed_height_field_locality_query_mode (Height_field_locality_query_mode query_mode, const mi::neuraylib::Tag_struct &tag, const mi::math::Bbox_struct< mi::Sint32, 2 > &coverage)
 Instantiating a query method using the distributed dataset unique identifier and a given area of interest. More...
 
virtual ~Distributed_height_field_locality_query_mode ()
 Implements an empty default destructor. More...
 
virtual Height_field_locality_query_mode get_query_mode () const
 implement the height field mode defines if globally or locally unique data subsets shall be considered for the data locality. More...
 
virtual const mi::neuraylib::Tag_struct & get_distributed_data_tag () const
 Implements the query method that applies to a height field dataset that is referred to by an unique identifier. More...
 
virtual mi::Uint32 get_query_mode_flags () const
 Implements the default query flags. More...
 
virtual const mi::math::Bbox_struct< mi::Float32, 2 > & get_spatial_coverage () const
 Implements the spatial query method to determine data localities based on a 2D coverage. More...
 

Detailed Description

Implements the height field specific query mode height field patches.

Constructor & Destructor Documentation

◆ Distributed_height_field_locality_query_mode() [1/2]

nv::index::Distributed_height_field_locality_query_mode::Distributed_height_field_locality_query_mode ( Height_field_locality_query_mode  query_mode,
const mi::neuraylib::Tag_struct &  tag,
const mi::math::Bbox_struct< mi::Float32, 2 > &  coverage 
)
inline

Instantiating a query method using the distributed dataset unique identifier and a given region of interest.

The spatial query is defined in continuous space which requires a bounding box defined using floating-point min and max values.

Parameters
[in]query_modeDefines if either locally unique or cluster-wise unique height field data shall be considered.
[in]tagThe mi::neuraylib::Tag_struct identifies the distributed dataset.
[in]coverageThe bounding box specifies the region of interest for the locality query.

◆ Distributed_height_field_locality_query_mode() [2/2]

nv::index::Distributed_height_field_locality_query_mode::Distributed_height_field_locality_query_mode ( Height_field_locality_query_mode  query_mode,
const mi::neuraylib::Tag_struct &  tag,
const mi::math::Bbox_struct< mi::Sint32, 2 > &  coverage 
)
inline

Instantiating a query method using the distributed dataset unique identifier and a given area of interest.

The 2D spatial query is defined in continuous space but the 2D area of interst here is defined using integer extents. The bounding area is converted to a floating-point bounding area first.

Parameters
[in]query_modeDefines if either locally unique or cluster-wise unique height field data shall be considered.
[in]tagThe mi::neuraylib::Tag_struct identifies the distributed dataset.
[in]coverageThe bounding box specifies the region of interest for the locality query.

◆ ~Distributed_height_field_locality_query_mode()

virtual nv::index::Distributed_height_field_locality_query_mode::~Distributed_height_field_locality_query_mode ( )
inlinevirtual

Implements an empty default destructor.

Member Function Documentation

◆ get_distributed_data_tag()

virtual const mi::neuraylib::Tag_struct & nv::index::Distributed_height_field_locality_query_mode::get_distributed_data_tag ( ) const
inlinevirtual

Implements the query method that applies to a height field dataset that is referred to by an unique identifier.

Returns
Return the mi::neuraylib::Tag_struct that uniquely identifies the height field dataset.

◆ get_query_mode()

virtual Height_field_locality_query_mode nv::index::Distributed_height_field_locality_query_mode::get_query_mode ( ) const
inlinevirtual

implement the height field mode defines if globally or locally unique data subsets shall be considered for the data locality.

Returns
Returns if locally or globally unique data subsets shall be considered in combination with the 2D area of interest.

◆ get_query_mode_flags()

virtual mi::Uint32 nv::index::Distributed_height_field_locality_query_mode::get_query_mode_flags ( ) const
inlinevirtual

Implements the default query flags.

Returns
Return the default query flags IDistributed_data_locality_query_mode::QUERY_MODE_DEFAULT

◆ get_spatial_coverage()

virtual const mi::math::Bbox_struct< mi::Float32, 2 > & nv::index::Distributed_height_field_locality_query_mode::get_spatial_coverage ( ) const
inlinevirtual

Implements the spatial query method to determine data localities based on a 2D coverage.

The 2D area represented by mi::math::Bbox_struct<mi::Float32, 2> specifies a spatial area of interest. All data subsets that are covered at least partially, will be considered in a data locality.

Returns
Returns the a bounding box that represents a region of interest for determining the data locality. An invalid bounding box will be ignored and the space that the entire distributed dataset covers will be considered instead.
The documentation for this class was generated from the following file: