This interface represents a single object hit by a pick operation. More...

Inheritance diagram for mi::neuraylib::IPick_result:

Public Member Functions
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. 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_path (Uint32 index) const =0
	Returns the name of an element on the path from the picked object to the root group. 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< 0x1d9690d1, ... >
typedef Interface_declare< id1, ... >	Self
	Own type. More...

typedef Uuid_t< id1, ... >	IID
	Declares the interface ID (IID) of this interface. More...

Public Types inherited from mi::base::IInterface
typedef Uuid_t<0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0>	IID
	Declares the interface ID (IID) of this interface. More...

Static Public Member Functions inherited from mi::base::Interface_declare< 0x1d9690d1, ... >
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 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.

Member Function Documentation

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.

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

Returns the length of the path from the picked object to the root group.

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.