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

Interface class that represents the path specific entry lookup result. More...

#include <ipath_query_results.h>

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

Public Member Functions

virtual const mi::math::Vector_struct< mi::Float32, 3 > & get_vertex () const =0
 The set of vertices defines the path in 3D space. More...
 
virtual const mi::math::Color_struct & get_color () const =0
 The color values defined with the vertices defines a path's appearance. More...
 
virtual mi::Uint32 get_color_index () const =0
 The color index values defined with the vertices are used to index color maps that determine a color which then defines a path's appearance. More...
 
virtual mi::Float32 get_radius () const =0
 A radius defines the path's shape and is currently set per path. More...
 

Detailed Description

Interface class that represents the path specific entry lookup result.

The interface class sub classes from IScene_lookup_result to provide additional results related to an entry of a IPath_2d or IPath_3d scene elements. Each entry or lookup index refers to a single vertex of the path and the values stored along with the vertex, such as the per-vertex color or the radius.

Member Function Documentation

 get_color()

virtual const mi::math::Color_struct & nv::index::IPath_lookup_result::get_color ( ) const
pure virtual

The color values defined with the vertices defines a path's appearance.

Each vertex has assigned a color that can be queried.

Returns
Returns the per-vertex color.

 get_color_index()

virtual mi::Uint32 nv::index::IPath_lookup_result::get_color_index ( ) const
pure virtual

The color index values defined with the vertices are used to index color maps that determine a color which then defines a path's appearance.

The per-vertex color index is exposed by the query.

Returns
Returns the per-vertex color index.

 get_radius()

virtual mi::Float32 nv::index::IPath_lookup_result::get_radius ( ) const
pure virtual

A radius defines the path's shape and is currently set per path.

The radius is exposed by the query.

Returns
Returns the radius defined for the path.

 get_vertex()

virtual const mi::math::Vector_struct< mi::Float32, 3 > & nv::index::IPath_lookup_result::get_vertex ( ) const
pure virtual

The set of vertices defines the path in 3D space.

The per-vertex color values are exposed by the query.

Returns
Returns the vertex's 3D position in the path's local space.

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