nv::index::Regular_heightfield_locality_query_mode Class Reference

Implements a data locality query mode for deprecated heightfield datasets. More...

#include <idistributed_data_locality.h>

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

Public Member Functions
	Regular_heightfield_locality_query_mode (const mi::neuraylib::Tag_struct &tag, const mi::math::Bbox_struct< mi::Uint32, 2 > &coverage, bool editing_mode=false)
	Instantiating a query method for regular heightfield datasets. More...
virtual	~Regular_heightfield_locality_query_mode ()
	Implements an empty default destructor. More...
virtual bool	is_editing_mode () const
	Editing and a non-editing inspection mode produce different data localities. More...
virtual const mi::neuraylib::Tag_struct &	get_distributed_data_tag () const
	The distributed heightfield dataset. More...
virtual mi::Uint32	get_query_mode_flags () const
	Implements the default query flags. More...
virtual const mi::math::Bbox_struct< mi::Uint32, 2 > &	get_spatial_coverage () const
	The locality query only considers patches that cover or intersect a given 2D spatial area. More...

Detailed Description

Implements a data locality query mode for deprecated heightfield datasets.

Deprecated:

The IRegular_heightfield has been deprecated and will be removed.

Constructor & Destructor Documentation

Regular_heightfield_locality_query_mode()

nv::index::Regular_heightfield_locality_query_mode::Regular_heightfield_locality_query_mode ( const mi::neuraylib::Tag_struct &  tag, const mi::math::Bbox_struct< mi::Uint32, 2 > &  coverage, bool  editing_mode = false  )

inline

Instantiating a query method for regular heightfield datasets.

Parameters

[in]	tag	The mi::neuraylib::Tag_struct identifies the heighfield dataset.
[in]	coverage	The bounding box specifies the region of interest for the locality query.
[in]	editing_mode	Defines if the locality mode shall consider heightfield patches for editing only or for non-editing data analysis.

~Regular_heightfield_locality_query_mode()

virtual nv::index::Regular_heightfield_locality_query_mode::~Regular_heightfield_locality_query_mode ( )

inlinevirtual

Implements an empty default destructor.

Member Function Documentation

get_distributed_data_tag()

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

inlinevirtual

The distributed heightfield dataset.

Returns

Returns the unique identifier that refers to the heightfield datset.

get_query_mode_flags()

virtual mi::Uint32 nv::index::Regular_heightfield_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::Uint32, 2 > & nv::index::Regular_heightfield_locality_query_mode::get_spatial_coverage ( ) const

inlinevirtual

The locality query only considers patches that cover or intersect a given 2D spatial area.

Returns

Returns the 2D spatial area.

is_editing_mode()

virtual bool nv::index::Regular_heightfield_locality_query_mode::is_editing_mode ( ) const

inlinevirtual

Editing and a non-editing inspection mode produce different data localities.

Returns

Returns true if the data locality query shall consider all heightfield patches, e.g., for data editing and elevation changes operations and false if only single unique patches are required for data inspection (such as the detection of a average height value of all elevation values).

---

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

• idistributed_data_locality.h