isession.h

Go to the documentation of this file.

/******************************************************************************
 * Copyright 2023 NVIDIA Corporation. All rights reserved.
 *****************************************************************************/
 
#ifndef NVIDIA_INDEX_ISESSION_H
#define NVIDIA_INDEX_ISESSION_H
 
#include <mi/dice.h>
#include <mi/base/interface_declare.h>
#include <mi/base/handle.h>
 
#include <mi/math/vector.h>
#include <mi/math/matrix.h>
 
#include <nv/index/icamera.h>
#include <nv/index/iindex.h>
#include <nv/index/iscene_convenience_manipulation.h>
#include <nv/index/iscene_visitor.h>
#include <nv/index/isubdivision.h>
 
namespace nv {
 
namespace index {
 
class IViewport;
class IViewport_list;
 
class ISession :
    public mi::base::Interface_declare<0x21638be2,0xab6b,0x4396,0x9a,0xb7,0x3b,0xa5,0xe2,0xc9,0xe0,0xe6,
                                       mi::neuraylib::IElement>
{
public:
 
    virtual mi::neuraylib::Tag_struct create_scene(
        mi::neuraylib::IDice_transaction* dice_transaction) = 0;
 
    virtual mi::neuraylib::Tag_struct get_scene() const = 0;
 
 
 
 
    virtual void visit(
        IScene_visitor*                         visitor,
        mi::neuraylib::IDice_transaction*       dice_transaction) const = 0;
 
 
    virtual mi::neuraylib::Tag_struct create_camera(
        mi::neuraylib::IDice_transaction*       dice_transaction,
        const mi::base::Uuid&                   camera_type_uuid = IPerspective_camera::IID(),
        const char*                             camera_name = 0) const = 0;
 
 
 
    virtual mi::neuraylib::Tag_struct get_config() const = 0;
 
    
 
    virtual mi::neuraylib::Tag_struct get_data_access_factory() const = 0;
 
    virtual mi::neuraylib::Tag_struct get_distribution_layout() const = 0;
 
 
 
 
    virtual ISubdivision* get_spatial_subdivision(
        mi::neuraylib::IDice_transaction*   dice_transaction) const = 0;
 
 
 
    virtual IViewport* create_viewport() const = 0;
 
    virtual IViewport_list* create_viewport_list() const = 0;
 
    virtual ICanvas_viewport_list* create_canvas_viewport_list() const = 0;
 
 
 
 
    virtual IScene_convenience_manipulation* get_conveniences() const = 0;
 
 
 
 
    enum Export_mode {
        EXPORT_FORMAT_PRJ  = 0x01,
        EXPORT_FORMAT_JSON = 0x02,
        EXPORT_SYSINFO     = 0x10,
        EXPORT_MEMORY      = 0x20,
        EXPORT_VERBOSE     = 0x40,
        EXPORT_DEBUG       = 0x80,
        EXPORT_HINTS       = 0x100,
        EXPORT_USER_DATA   = 0x200,
        EXPORT_DEFAULT     = EXPORT_FORMAT_PRJ | EXPORT_SYSINFO | EXPORT_MEMORY | EXPORT_VERBOSE | EXPORT_DEBUG
    };
 
    virtual void export_session(
        mi::Uint32                        export_mode,
        mi::IString*                      output,
        mi::neuraylib::IDice_transaction* dice_transaction,
        const IViewport_list*             viewport_list = 0) const = 0;
 
    //
    virtual void export_scene_element(
        mi::neuraylib::Tag_struct         scene_element_tag,
        mi::Uint32                        export_mode,
        mi::IString*                      output,
        mi::neuraylib::IDice_transaction* dice_transaction) const = 0;
        
};
 
}} // namespace index / nv
 
#endif // NVIDIA_INDEX_ISESSION_H