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

The base class of all distributed datasets. More...

#include <idistributed_data.h>

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

Public Member Functions

virtual mi::math::Bbox_struct< mi::Float32, 3 > get_bounding_box () const =0
 A distributed data has an extent in 3D space and thus defines a 3D bounding box. More...
 
virtual mi::math::Matrix_struct< mi::Float32, 4, 4 > get_transform () const =0
 Returns the transformation matrix applied to the distributed data. More...
 
virtual void set_clip_region (const mi::math::Bbox_struct< mi::Float32, 3 > &clip_region)=0
 A distributed dataset's extent in 3D space that shall be considered for rendering or computing can be restricted by a clip region. More...
 
virtual mi::math::Bbox_struct< mi::Float32, 3 > get_clip_region () const =0
 A distributed dataset's extent in 3D space that shall be considered for rendering or computing can be restricted by a clip region. More...
 
virtual bool get_pickable () const =0
 Each distributed dataset may be pickable, so that the ray cast through the scene can intersect and query the data. More...
 
virtual void set_pickable (bool pickable)=0
 Sets the pickable state of the distributed data scene element. More...
 

Detailed Description

The base class of all distributed datasets.

Member Function Documentation

 get_bounding_box()

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

A distributed data has an extent in 3D space and thus defines a 3D bounding box.

The bounding box is always defined in the distributed dataset's local coordinate system. The rendering traversals require the bounding box for accurate and efficient rendering.

Returns
The bounding box of the dataset in its local coordinate system.

 get_clip_region()

virtual mi::math::Bbox_struct< mi::Float32, 3 > nv::index::IDistributed_data::get_clip_region ( ) const
pure virtual

A distributed dataset's extent in 3D space that shall be considered for rendering or computing can be restricted by a clip region.

Returns
The clip region of the dataset in its local coordinate system.

 get_pickable()

virtual bool nv::index::IDistributed_data::get_pickable ( ) const
pure virtual

Each distributed dataset may be pickable, so that the ray cast through the scene can intersect and query the data.

The intersection information will be returned by the pick query operation.

Returns
The distributed data may or may not be pickable.

 get_transform()

virtual mi::math::Matrix_struct< mi::Float32, 4, 4 > nv::index::IDistributed_data::get_transform ( ) const
pure virtual

Returns the transformation matrix applied to the distributed data.

Returns
Transformation matrix from the local to the global space.

 set_clip_region()

virtual void nv::index::IDistributed_data::set_clip_region ( const mi::math::Bbox_struct< mi::Float32, 3 > &  clip_region)
pure virtual

A distributed dataset's extent in 3D space that shall be considered for rendering or computing can be restricted by a clip region.

The NVIDIA IndeX library only takes into account those parts of the distributed dataset that lie inside of this. All parts outside of the region will be ignored. Changing the clip region, e.g., increasing its size, might result in a repartitioning of the spatial subdivision or might trigger importer calls.

Parameters
[in]

The clip region of the dataset in its local coordinate system.

 set_pickable()

virtual void nv::index::IDistributed_data::set_pickable ( bool  pickable)
pure virtual

Sets the pickable state of the distributed data scene element.

Parameters
[in]pickableThe distributed data is pickable.

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