mi::neuraylib::IPick_result Class Reference
[Rendering and Picking]
Description
This interface represents a single object hit by a pick operation. All objects hit by a pick operation are stored in an object of type mi::neuraylib::IPick_array, whose elements are instances of this interface.
Public Member Functions
- virtual const char* get_path( Uint32 index) const =0
- Returns the name of an element on the path from the picked object to the root group. More...
- virtual Uint32 get_path_length() const =0
- Returns the length of the path from the picked object to the root group. More...
- virtual const char* get_picked_object_name() const =0
- Returns the name of the picked object. More...
- virtual const Float64_3_struct& get_world_point() const =0
- Returns the world point of the pick operation.
Member Functions
- virtual const char* mi::neuraylib::IPick_result::get_path( Uint32 index) const [pure virtual]
-
Returns the name of an element on the path from the picked object to the root group.
See also:
Parameters
- index
- Identifies the element on the path. The value zero corresponds to the picked object, get_path_length()-1 corresponds to the root group.
Returns
The name of the element indicated by index , or NULL if index is out-of-bounds.
- virtual Uint32 mi::neuraylib::IPick_result::get_path_length() const [pure virtual]
- virtual const char* mi::neuraylib::IPick_result::get_picked_object_name() const [pure virtual]
-
Returns the name of the picked object. Identical to get_path(0).
- virtual const Float64_3_struct& mi::neuraylib::IPick_result::get_world_point() const [pure virtual]
-
Returns the world point of the pick operation.