Describes a path through the scene description to identify a specific instance of a scene element. More...
#include <iscene_query_results.h>
Inherits mi::base::Interface_declare< 0xce092e73, ... >.
Public Member Functions | |
| virtual mi::Uint32 | get_length () const =0 |
| Returns the number of nodes in the path from the scene root to the chosen scene element instance. More... | |
| virtual mi::neuraylib::Tag_struct | get_node (mi::Uint32 index) const =0 |
| Returns a node in the path from the scene root to the chosen scene element instance. More... | |
Describes a path through the scene description to identify a specific instance of a scene element.
Since most types of scene elements may be referenced multiple times in the scene, the element's tag is not sufficient to address a specific instance. This interface defines a path through the scene description to a chosen scene element instance, traversing from the scene root through all other ancestors to the actual instance.
|
pure virtual |
Returns the number of nodes in the path from the scene root to the chosen scene element instance.
|
pure virtual |
Returns a node in the path from the scene root to the chosen scene element instance.
The first node of the path is the scene root, i.e. an IScene, followed by other ancestors, with the last node being the chosen scene element instance.
The path can be used to distinguish multiple instances of the same scene element, i.e. when the same scene element is referenced by multiple scene groups. Since all instances use the same tag, it is necessary to look at the path to determine which instance was meant.
| [in] | index | Selects the node in the path, must be in the range [0, get_length() - 1]. |
