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

Defines the vertices and attributes of a subset (sub-grid) of a corner-point grid. More...

#include <icorner_point_grid_subset.h>

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

Public Member Functions

virtual const mi::math::Bbox_struct< mi::Float32, 3 > & get_bounding_box () const =0
 Returns the bounding box of the subset. More...
 
virtual const mi::math::Vector_struct< mi::Uint32, 2 > get_patch_size () const =0
 Returns the general (non-clipped) size of the patches into which each layer in this subset is further subdivided. More...
 
virtual mi::Uint32 get_number_of_patch_stacks () const =0
 Returns the number of patch stacks available in the subset. More...
 
virtual mi::math::Vector_struct< mi::Sint32, 2 > get_patch_stack_position (mi::Uint32 stack_index) const =0
 Returns the xy-position of the selected patch stack. More...
 
virtual bool add_empty_layer (int layer) const =0
 Adding an empty layer. More...
 
virtual mi::Float32 * add_patch (mi::Uint32 layer, mi::Uint32 stack_index, const mi::math::Vector_struct< mi::Uint32, 2 > &patch_size) const =0
 Adding a patch to a given layer. More...
 
virtual mi::Float32 * add_patch_data (mi::Uint32 layer, mi::Uint32 stack_index, mi::Uint32 property_id) const =0
 Adding a patch data to a given layer. More...
 
virtual bool add_empty_patch (mi::Uint32 layer, mi::Uint32 stack_index) const =0
 Adding a empty patch to a given layer. More...
 

Detailed Description

Defines the vertices and attributes of a subset (sub-grid) of a corner-point grid.

The part of each layer that intersects with a subregion is further subdivided into patches, each having the same xy-size. Patches from different layers that have the same xy-coordinates are organized as a patch stack.

Member Function Documentation

 add_empty_layer()

virtual bool nv::index::ICorner_point_grid_subset::add_empty_layer ( int  layer) const
pure virtual

Adding an empty layer.

Parameters
[in]layerThe index of the layer that shall be added.
Returns
Returns true if successful, otherwise false.

 add_empty_patch()

virtual bool nv::index::ICorner_point_grid_subset::add_empty_patch ( mi::Uint32  layer,
mi::Uint32  stack_index 
) const
pure virtual

Adding a empty patch to a given layer.

Parameters
[in]layerThe index of the given layer.
[in]stack_indexThe stack index.
Returns
Returns true if successful, otherwise false.

 add_patch()

virtual mi::Float32 * nv::index::ICorner_point_grid_subset::add_patch ( mi::Uint32  layer,
mi::Uint32  stack_index,
const mi::math::Vector_struct< mi::Uint32, 2 > &  patch_size 
) const
pure virtual

Adding a patch to a given layer.

Parameters
[in]layerThe index of the given layer.
[in]stack_indexThe stack index.
[in]patch_sizeThe size of the patch.
Returns
Returns a internal value to operate on.

 add_patch_data()

virtual mi::Float32 * nv::index::ICorner_point_grid_subset::add_patch_data ( mi::Uint32  layer,
mi::Uint32  stack_index,
mi::Uint32  property_id 
) const
pure virtual

Adding a patch data to a given layer.

Parameters
[in]layerThe index of the given layer.
[in]stack_indexThe stack index.
[in]property_idThe property to be added to the given patch.
Returns
Returns a internal value to operate on.

 get_bounding_box()

virtual const mi::math::Bbox_struct< mi::Float32, 3 > & nv::index::ICorner_point_grid_subset::get_bounding_box ( ) const
pure virtual

Returns the bounding box of the subset.

Returns
Bounding box in the local coordinate system.

 get_number_of_patch_stacks()

virtual mi::Uint32 nv::index::ICorner_point_grid_subset::get_number_of_patch_stacks ( ) const
pure virtual

Returns the number of patch stacks available in the subset.

 get_patch_size()

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

Returns the general (non-clipped) size of the patches into which each layer in this subset is further subdivided.

Returns
xy-size of a patch.

 get_patch_stack_position()

virtual mi::math::Vector_struct< mi::Sint32, 2 > nv::index::ICorner_point_grid_subset::get_patch_stack_position ( mi::Uint32  stack_index) const
pure virtual

Returns the xy-position of the selected patch stack.

Parameters
[in]stack_indexIndex of the patch stack for which to return the information, must be less than get_number_of_patch_stacks().
Returns
xy-position of the patch stack.

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