mi::neuraylib::IPick_array Class Reference

This interface represents the return value of a pick operation. More...

Inheritance diagram for mi::neuraylib::IPick_array:

Public Member Functions
virtual Uint32	get_length () const =0
	Returns the number of pick results. More...
virtual IPick_result *	get_pick_result (Uint32 index) const =0
	Returns the pick result at index. More...

Additional Inherited Members
Public Types inherited from mi::base::Interface_declare< 0x892cb9f3, 0xbf56, 0x4668, 0x91, 0x6e, 0x87, 0xa5, 0xab, 0x63, 0x31, 0x74 >
typedef Interface_declare< id1, id2, id3, id4, id5, id6, id7, id8, id9, id10, id11, IInterface >	Self
	Own type. More...
typedef Uuid_t< id1, id2, id3, id4, id5, id6, id7, id8, id9, id10, id11 >	IID
	Declares the interface ID (IID) of this interface. More...
Static Public Member Functions inherited from mi::base::Interface_declare< 0x892cb9f3, 0xbf56, 0x4668, 0x91, 0x6e, 0x87, 0xa5, 0xab, 0x63, 0x31, 0x74 >
static bool	compare_iid (const Uuid &iid)
	Compares the interface ID iid against the interface ID of this interface and of its ancestors. More...

Detailed Description

This interface represents the return value of a pick operation.

Essentially it represents an array of interfaces of type mi::neuraylib::IPick_result, which describe the individual objects hit by the pick operation.

See Also

mi::neuraylib::IRender_context::pick()

Member Function Documentation

virtual Uint32 mi::neuraylib::IPick_array::get_length ( ) const

pure virtual

Returns the number of pick results.

virtual IPick_result* mi::neuraylib::IPick_array::get_pick_result ( Uint32  index) const

pure virtual

Returns the pick result at index.

Returns

The pick result at index, or NULL if index is out-of-bounds.