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

Interface class that returns the result of a entry lookup operation. More...

#include <iscene_query_results.h>

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

Public Member Functions

virtual mi::base::Uuid get_intersection_info_class () const =0
 Represents the interface class of the entry lookup result. More...
 

Detailed Description

Interface class that returns the result of a entry lookup operation.

The interface class represents a single scene query result generated by a mouse over operation (a.k.a. 'pick' operation), i.e., by a ray starting from the scene's camera position cast through the scene.

Each query result gives information about the scene element hit by the ray. This information includes, for instance, the scene element's tag to clearly identify it and the intersection point in the scene element's IJK space.

Member Function Documentation

 get_intersection_info_class()

virtual mi::base::Uuid nv::index::IScene_lookup_result::get_intersection_info_class ( ) const
pure virtual

Represents the interface class of the entry lookup result.

The entry lookup results usually dependent on the scene element class. For instance, the lookup of an entry of a triangle mesh returns a single triangle including its per-vertex information such as the vertices, normals, colors, etc. The lookup result interfaces class IScene_lookup_result provides just basic information. Any shape-specific information are supposed to be provided derived (interface) classes. The UUID returned by get_intersection_info_class provides the application with the necessary interface class id required for proper casting the general intersection information interface class to the shape-specific intersection information interface class if additional shape-specific details for the intersection are required.

Returns
Returns the UUID of the shape-specific lookup result interface class. By default, the UUID refers to this default lookup interface.

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