NVIDIA IndeX API nvidia_logo_transpbg.gif Up
nv::index::IScene_visitor Class Referenceabstract

Enables user-specific evaluations of the scene representation. More...

#include <iscene_visitor.h>

Public Types

enum  Scene_evaluation_mode
 The scene representation can be traversed depth-first order only today. More...
 

Public Member Functions

virtual void evaluate (mi::neuraylib::Tag scene_element, const mi::base::Uuid &uuid, IScene_visitor::Scene_evaluation_mode evaluation_mode, mi::neuraylib::IDice_transaction *transaction)=0
 When traversing the scene representation each scene element is visited. More...
 

Detailed Description

Enables user-specific evaluations of the scene representation.

The scene visitor applies to the root of the scene and will be passed through the entire scene representation. In this way, the visitor visits all scene elements (e.g., scene groups, attributes and shapes) contained in the scene automatically. When visiting a scene element, the evaluate method is called. Deriving from the visitor enables the implementation of user-specific evaluations of the scene representation. Common use-cases include the logging of the scene representation or determining the path (IScene_path) from the root to some given scene element.

Member Enumeration Documentation

 Scene_evaluation_mode

The scene representation can be traversed depth-first order only today.

When traversing in depth-first order, each node is visited twice i.e., in forward or backward directions.

Traversing the scene in breadth-first order is not yet supported.

Member Function Documentation

 evaluate()

virtual void nv::index::IScene_visitor::evaluate ( mi::neuraylib::Tag  scene_element,
const mi::base::Uuid &  uuid,
IScene_visitor::Scene_evaluation_mode  evaluation_mode,
mi::neuraylib::IDice_transaction *  transaction 
)
pure virtual

When traversing the scene representation each scene element is visited.

When visiting the scene element, the evaluate method is called by the NVIDIA IndeX library to enable application-side inspections of the scene elements.

Parameters
scene_elementThe tag of the visited scene element.
uuidThe unique identifier that represents the type of the visited class.
evaluation_modeThe scene representation can be traversed depth-first order and a node is evaluated twice in, i.e., in forward or backward directions. The method can handle the evaluation based on either one appropriately.
transactionThe transaction used when traversing the scene.

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