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

Interface class that returns the pick result specific to the intersection highlighting. More...

#include <iintersection_highlight_pick_result.h>

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

Public Member Functions

virtual mi::neuraylib::Tag_struct get_intersection_shape () const =0
 Returns the reference to the shape used for intersection highlighting. More...
 

Detailed Description

Interface class that returns the pick result specific to the intersection highlighting.

The interface class sub-classes from IScene_pick_result to provide additional query results that are specific to highlighting of an intersection between a shape class, such as triangle mesh or a heightfield, and a plane (IPlane).

IIntersection_highlight_pick_result represents a query result in addition to an IPlane_pick_result when an intersection highlight was hit during a pick operation on a plane. Instances of IIntersection_highlight_pick_result are always returned right before the actual plane pick results. Multiple IIntersection_highlight_pick_result instances are returned by pick operations intersecting multiple overlapping intersection highlights on the same plane. The ordering of the IIntersection_highlight_pick_result instances is top-most to bottom-most intersection highlight as defined by the order of the IIntersection_highlighting attributes given through the scene description.

Member Function Documentation

 get_intersection_shape()

virtual mi::neuraylib::Tag_struct nv::index::IIntersection_highlight_pick_result::get_intersection_shape ( ) const
pure virtual

Returns the reference to the shape used for intersection highlighting.

The intersection highlights on a plane are caused by an intersection of a shape in the scene and the plane. The pick query provides the reference to the shape if a pick operation hits the intersection highlight. The reference represents an additional query result. The pick position, color, reference to the plane, etc. are provided by the super class' interface methods.

Returns
Returns the reference to the shape that intersects with the plane and causes an intersection highlight on the plane's surface.

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