Interface class that enables application writers to query the scene's contents.
More...
#include <iindex_scene_query.h>
Inherits mi::base::Interface_declare< 0xd71c4a09, ... >.
|
| virtual IScene_pick_results * | pick (const mi::math::Vector_struct< mi::Uint32, 2 > &pixel_location, const nv::index::IIndex_canvas *pick_canvas, mi::neuraylib::Tag_struct session_tag, mi::neuraylib::IDice_transaction *dice_transaction) const =0 |
| | Returns all picked scene elements at a certain pixel location and their intersection with the ray cast from the center of the camera through the pixel. More...
|
| |
| virtual IScene_pick_results_list * | pick (const mi::math::Vector_struct< mi::Sint32, 2 > &pixel_location, const nv::index::IIndex_canvas *pick_canvas, IViewport_list *viewport_list, mi::neuraylib::Tag_struct session_tag) const =0 |
| | Returns a list of all picked scene elements at a certain pixel location and their intersection with the ray cast from the center of the camera through the pixel. More...
|
| |
| virtual IScene_pick_results * | pick (const mi::math::Vector_struct< mi::Uint32, 2 > &pixel_location, const nv::index::IIndex_canvas *pick_canvas, mi::neuraylib::Tag_struct session_tag, mi::neuraylib::Tag_struct query_scene_element_tag, mi::neuraylib::IDice_transaction *dice_transaction) const =0 |
| | Returns all intersections of a ray cast from the center of the camera through the pixel with the given scene element. More...
|
| |
| virtual IScene_lookup_result * | entry_lookup (mi::Uint64 entry_index, mi::neuraylib::Tag_struct scene_element_tag, mi::neuraylib::Tag_struct session_tag, mi::neuraylib::IDice_transaction *dice_transaction) const =0 |
| | Enables querying single entries of a scene dataset. More...
|
| |
Interface class that enables application writers to query the scene's contents.
Scene queries include, for instance, the pick operation, which is the task of determining which rendered scene element a user has clicked on, or entry lookup, which returns a single entry of a dataset.
◆ entry_lookup()
| virtual IScene_lookup_result * nv::index::IIndex_scene_query::entry_lookup |
( |
mi::Uint64 |
entry_index, |
|
|
mi::neuraylib::Tag_struct |
scene_element_tag, |
|
|
mi::neuraylib::Tag_struct |
session_tag, |
|
|
mi::neuraylib::IDice_transaction * |
dice_transaction |
|
) |
| const |
|
pure virtual |
Enables querying single entries of a scene dataset.
The method returns the entry that the index value refers to in the dataset. For instance, the index could represent the triangle of a triangle mesh that is distributed in the cluster environment. The lookup operation would then return all data related to the triangle such as the per-vertex information.
- Parameters
-
| [in] | entry_index | The index that refers to the entry query. |
| [in] | scene_element_tag | The given scene element. |
| [in] | session_tag | The ISession tag. |
| [in] | dice_transaction | DiCE transaction. |
- Returns
- Entry result.
◆ pick() [1/3]
Returns a list of all picked scene elements at a certain pixel location and their intersection with the ray cast from the center of the camera through the pixel.
When the picking location is covered by multiple overlapping viewports, then the multiple IScene_lookup_result entries will be returned.
- Parameters
-
| [in] | pixel_location | Pixel location on the canvas in screen space. |
| [in] | pick_canvas | Canvas that should be picked. |
| [in] | viewport_list | Viewport list for the picking viewport information. |
| [in] | session_tag | The ISession tag. |
- Returns
- List with pick results for each viewport.
- Deprecated:
◆ pick() [2/3]
| virtual IScene_pick_results * nv::index::IIndex_scene_query::pick |
( |
const mi::math::Vector_struct< mi::Uint32, 2 > & |
pixel_location, |
|
|
const nv::index::IIndex_canvas * |
pick_canvas, |
|
|
mi::neuraylib::Tag_struct |
session_tag, |
|
|
mi::neuraylib::IDice_transaction * |
dice_transaction |
|
) |
| const |
|
pure virtual |
Returns all picked scene elements at a certain pixel location and their intersection with the ray cast from the center of the camera through the pixel.
- Parameters
-
| [in] | pixel_location | Pixel location on the canvas in screen space. |
| [in] | pick_canvas | Canvas that should be picked. |
| [in] | session_tag | ISession tag. |
| [in] | dice_transaction | DiCE transaction. |
- Returns
- Pick results in front-to-back order.
- Deprecated:
◆ pick() [3/3]
| virtual IScene_pick_results * nv::index::IIndex_scene_query::pick |
( |
const mi::math::Vector_struct< mi::Uint32, 2 > & |
pixel_location, |
|
|
const nv::index::IIndex_canvas * |
pick_canvas, |
|
|
mi::neuraylib::Tag_struct |
session_tag, |
|
|
mi::neuraylib::Tag_struct |
query_scene_element_tag, |
|
|
mi::neuraylib::IDice_transaction * |
dice_transaction |
|
) |
| const |
|
pure virtual |
Returns all intersections of a ray cast from the center of the camera through the pixel with the given scene element.
- Parameters
-
| [in] | pixel_location | Pixel location on the canvas in screen space. |
| [in] | pick_canvas | Canvas that should be picked. |
| [in] | session_tag | ISession tag. |
| [in] | query_scene_element_tag | Scene element to pick. |
| [in] | dice_transaction | DiCE transaction. |
- Returns
- Pick results in front-to-back order.
- Deprecated:
The documentation for this class was generated from the following file:
