nv::index::IScene_pick_results Class Reference

Interface class that returns all results of a pick operation in front-to-back order. More...

#include <iscene_query_results.h>

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

Public Member Functions
virtual mi::Uint32	get_nb_results () const =0
	Returns the number of intersections between the scene elements in the scene and the cast ray. More...
virtual IScene_pick_result *	get_result (mi::Uint32 index) const =0
	Returns a single pick result determined by the given index that corresponds to the depth ordering. More...
virtual mi::Size	get_viewport_index () const =0
	Returns which viewport the pick results come from. More...

Detailed Description

Interface class that returns all results of a pick operation in front-to-back order.

The interface class enables accessing all scene query result generated by a mouse over operation (cf. IScene_pick_result). The mouse over operation computes all intersections of the cast ray with the scene elements and all query results are sorted in front to depth order in accordance to the camera position.

Member Function Documentation

get_nb_results()

virtual mi::Uint32 nv::index::IScene_pick_results::get_nb_results ( ) const

pure virtual

Returns the number of intersections between the scene elements in the scene and the cast ray.

Returns

The number of query results. If the cast ray hasn't hit any scene element in the scene then 0 is returned.

get_result()

virtual IScene_pick_result * nv::index::IScene_pick_results::get_result ( mi::Uint32  index ) const

pure virtual

Returns a single pick result determined by the given index that corresponds to the depth ordering.

Parameters

[in]

index

The index enables indexing the query results in depth sorted order. That is, the index 0 accesses the front most query result and the index [0, get_nb_results()-1] accesses the back most query result.

Returns

The query result associated with the index value.

get_viewport_index()

virtual mi::Size nv::index::IScene_pick_results::get_viewport_index ( ) const

pure virtual

Returns which viewport the pick results come from.

The returned value is the index in the IViewport_list that was passed to IIndex_scene_query::pick().

Returns

index into the list, will be 0 if only a single viewport is used.

---

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

• iscene_query_results.h