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

Interface class that returns the triangle mesh specific result of a pick operation/query. More...

#include <itriangle_mesh_query_results.h>

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

Public Member Functions

virtual mi::Uint64 get_triangle_index () const =0
 Returns triangle index of the hit triangle. More...
 
virtual mi::Uint32 get_local_triangle_index () const =0
 Returns the local triangle index; the local index refers to the triangle order on the machine where the data is stored. More...
 
virtual mi::math::Vector_struct< mi::Float32, 3 > get_normal () const =0
 Returns the averaged normal at the pick position. More...
 
virtual mi::math::Color_struct get_color_value () const =0
 Returns the average per-vertex color at the pick location or transparent black if not per-vertex color values have been set. More...
 
virtual mi::math::Color_struct get_colormap_value () const =0
 Returns the average colormap color value at the pick location or transparent black if not colormap nor colormap indices have been set. More...
 
virtual mi::math::Vector_struct< mi::Float32, 3 > get_barycentric_coordinates () const =0
 Returns the barycentric coordinate at the pick location. More...
 

Detailed Description

Interface class that returns the triangle mesh specific result of a pick operation/query.

The interface class sub classes from IScene_pick_result to provide additional intersection results specific to ITriangle_mesh_scene_element.

Member Function Documentation

 get_barycentric_coordinates()

virtual mi::math::Vector_struct< mi::Float32, 3 > nv::index::ITriangle_mesh_pick_result::get_barycentric_coordinates ( ) const
pure virtual

Returns the barycentric coordinate at the pick location.

These could be used to average per-vertex attributes stored at the triangle's vertices.

Returns
Returns the barycentric coordinates.

 get_color_value()

virtual mi::math::Color_struct nv::index::ITriangle_mesh_pick_result::get_color_value ( ) const
pure virtual

Returns the average per-vertex color at the pick location or transparent black if not per-vertex color values have been set.

Returns
Returns the averaged per-vertex color.

 get_colormap_value()

virtual mi::math::Color_struct nv::index::ITriangle_mesh_pick_result::get_colormap_value ( ) const
pure virtual

Returns the average colormap color value at the pick location or transparent black if not colormap nor colormap indices have been set.

Returns
Returns the average colormap color.

 get_local_triangle_index()

virtual mi::Uint32 nv::index::ITriangle_mesh_pick_result::get_local_triangle_index ( ) const
pure virtual

Returns the local triangle index; the local index refers to the triangle order on the machine where the data is stored.

Returns
Returns the local triangle index.

 get_normal()

virtual mi::math::Vector_struct< mi::Float32, 3 > nv::index::ITriangle_mesh_pick_result::get_normal ( ) const
pure virtual

Returns the averaged normal at the pick position.

Returns
Returns the averaged normal.

 get_triangle_index()

virtual mi::Uint64 nv::index::ITriangle_mesh_pick_result::get_triangle_index ( ) const
pure virtual

Returns triangle index of the hit triangle.

The triangle index is defined globally in the triangle mesh regardless of the machine where the triangle of the triangle mesh is stored and rendered. The global triangle index allows querying the triangle's specific details using NVIDIA IndeX's lookup query, which then returns an instance of the interface class ITriangle_mesh_lookup_result.

Returns
Returns the global triangle index.

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