nv::index::IHeightfield_pick_result Class Reference

Interface class that returns the heightfield specific result of a pick operation/query. More...

#include <iheightfield_pick_result.h>

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

Public Member Functions
virtual bool	is_computing_enabled () const =0
	A heightfield can also serve as a canvas for displaying compute results. More...
virtual const mi::math::Color_struct &	get_computed_color () const =0
	Returns the color value of the color value computed for the intersection point. More...

Detailed Description

Interface class that returns the heightfield specific result of a pick operation/query.

The interface class sub classes from IScene_pick_result to provide additional intersection results specific to IHeightfield scene elements.

Member Function Documentation

get_computed_color()

virtual const mi::math::Color_struct & nv::index::IHeightfield_pick_result::get_computed_color ( ) const

pure virtual

Returns the color value of the color value computed for the intersection point.

Returns

The computed color at the intersection point.

is_computing_enabled()

virtual bool nv::index::IHeightfield_pick_result::is_computing_enabled ( ) const

pure virtual

A heightfield can also serve as a canvas for displaying compute results.

The method indicates if computing is enabled for this heightfield. If so, the computed values (a color or a color index value) are provided with this pick result.

Returns

Returns if a computed value is available.

---

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

• iheightfield_pick_result.h