mi::neuraylib::IPick_array Class Reference

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

#include <ipick_array.h>

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...
Public Member Functions inherited from mi::base::IInterface
virtual Uint32	retain () const =0
	Increments the reference count. More...
virtual Uint32	release () const =0
	Decrements the reference count. More...
virtual const IInterface *	get_interface (const Uuid &interface_id) const =0
	Acquires a const interface from another. More...
template<class T>
const T *	get_interface () const
	Acquires a const interface from another. More...
virtual IInterface *	get_interface (const Uuid &interface_id)=0
	Acquires a mutable interface from another. More...
template<class T>
T *	get_interface ()
	Acquires a mutable interface from another. More...
virtual Uuid	get_iid () const =0
	Returns the interface ID of the most derived interface. More...

Additional Inherited Members
Public Types inherited from mi::base::Interface_declare< 0x892cb9f3, ... >
using	Self = Interface_declare< id1, ... >
	Own type. More...
using	IID = Uuid_t< id1, ... >
	Declares the interface ID (IID) of this interface. More...
Public Types inherited from mi::base::IInterface
using	IID = Uuid_t<0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0>
	Declares the interface ID (IID) of this interface. More...
Static Public Member Functions inherited from mi::base::Interface_declare< 0x892cb9f3, ... >
static bool	compare_iid (const Uuid &iid)
	Compares the interface ID iid against the interface ID of this interface and of its ancestors. More...
Static Public Member Functions inherited from mi::base::IInterface
static bool	compare_iid (const Uuid &iid)
	Compares the interface ID iid against the interface ID of this interface. 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

get_length()

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

pure virtual

Returns the number of pick results.

get_pick_result()

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 nullptr if index is out-of-bounds.