create_line_set.cpp

Go to the documentation of this file.

/******************************************************************************
 * Copyright 2023 NVIDIA Corporation. All rights reserved.
 *****************************************************************************/
 
#include <mi/dice.h>
 
// Include code shared by all examples.
#include "utility/example_shared.h"
 
#include <nv/index/icamera.h>
#include <nv/index/iindex.h>
#include <nv/index/iline_set.h>
#include <nv/index/iscene.h>
#include <nv/index/isession.h>
 
#include <nv/index/app/index_connect.h>
#include <nv/index/app/string_dict.h>
 
#include "utility/canvas_utility.h"
#include "utility/app_rendering_context.h"
 
#include <iostream>
#include <sstream>
 
//----------------------------------------------------------------------
class Create_line_set:
    public nv::index::app::Index_connect
{
public:
    Create_line_set()
        :
        Index_connect()
    {
        // INFO_LOG << "DEBUG: Create_line_set() ctor";
    }
 
    virtual ~Create_line_set()
    {
        // Note: Index_connect::~Index_connect() will be called after here.
        // INFO_LOG << "DEBUG: ~Create_line_set() dtor";
    }
 
    // launch application
    mi::Sint32 launch();
 
protected:
    virtual bool evaluate_options(nv::index::app::String_dict& sdict) CPP11_OVERRIDE;
    // override
    virtual bool initialize_networking(
        mi::neuraylib::INetwork_configuration* network_configuration,
        nv::index::app::String_dict&           options) CPP11_OVERRIDE
    {
        check_success(network_configuration != 0);
 
        check_success(options.is_defined("unittest"));
        const bool is_unittest = nv::index::app::get_bool(options.get("unittest"));
        if (is_unittest)
        {
            info_cout("NETWORK: disabled networking mode.", options);
            network_configuration->set_mode(mi::neuraylib::INetwork_configuration::MODE_OFF);
            return true;
        }
 
        return initialize_networking_as_default_udp(network_configuration, options);
    }
 
private:
    // get a color value from an integer
    // \param[in] attrib attribute value
    // \return a color associated with an attribute
    mi::math::Color_struct get_color_from_attribute(mi::Sint32 attrib) const;
    
    // get a width value from an integer
    // \param[in] attrib attribute value
    // \return a width value associated with an attribute
    mi::Float32 get_width_from_attribute(mi::Float32 attrib) const;
    
    // create line set in the scene.
    //
    // \param[in] scene_edit       IScene for the scene edit.
    // \param[in] dice_transaction dice transaction
    // \return true when success
    bool create_line_set(
        nv::index::IScene*                scene_edit,
        mi::neuraylib::IDice_transaction* dice_transaction) const;
    
    // setup camera to see this example scene
    //
    // \param[in] cam              a camera
    void setup_camera(nv::index::IPerspective_camera* cam) const;
    
    nv::index::IFrame_results* render_frame(const std::string& output_fname) const;
    
    
    // This session tag
    mi::neuraylib::Tag                                                                m_session_tag;
    // NVIDIA IndeX cluster configuration
    mi::base::Handle<nv::index::ICluster_configuration>                               m_cluster_configuration;
    // Application layer image file canvas (a render target)
    mi::base::Handle<nv::index::app::canvas_infrastructure::IIndex_image_file_canvas> m_image_file_canvas;    
    // Create_icons options
    std::string                                                                       m_outfname;
    bool                                                                              m_is_unittest;
    std::string                                                                       m_verify_image_fname;
};
 
//----------------------------------------------------------------------
mi::Sint32 Create_line_set::launch()
{
    mi::Sint32 exit_code = 0;
 
    // Get DiCE database components
    {
        m_cluster_configuration =
            get_index_interface()->get_api_component<nv::index::ICluster_configuration>();
        check_success(m_cluster_configuration.is_valid_interface());
 
        // create image canvas in application_layer
        m_image_file_canvas = create_image_file_canvas(get_application_layer_interface());
        check_success(m_image_file_canvas.is_valid_interface());
 
        // Verifying that local host has joined
        // This may fail when there is a license problem.
        check_success(is_local_host_joined(m_cluster_configuration.get()));
        {
            // DiCE database access
            mi::base::Handle<mi::neuraylib::IDice_transaction> dice_transaction(
                m_global_scope->create_transaction<mi::neuraylib::IDice_transaction>());
            check_success(dice_transaction.is_valid_interface());
            {
                // Setup session information
                m_session_tag =
                    m_index_session->create_session(dice_transaction.get());
                check_success(m_session_tag.is_valid());
                mi::base::Handle< nv::index::ISession const > session(
                    dice_transaction->access< nv::index::ISession const >(
                        m_session_tag));
                check_success(session.is_valid_interface());
 
                mi::base::Handle< nv::index::IScene > scene_edit(
                    dice_transaction->edit<nv::index::IScene>(session->get_scene()));
                check_success(scene_edit.is_valid_interface());
 
                //----------------------------------------------------------------------
                // Scene setup: add line set shape, scene parameters, camera.
                //----------------------------------------------------------------------
                // Add line set shape to the scene
                check_success(create_line_set(scene_edit.get(), dice_transaction.get()));
 
                // Create and edit a camera. Data distribution is based on
                // the camera. (Because only visible massive data are
                // considered)
                mi::base::Handle< nv::index::IPerspective_camera > cam(
                    scene_edit->create_camera<nv::index::IPerspective_camera>());
                check_success(cam.is_valid_interface());
                setup_camera(cam.get());
                const mi::neuraylib::Tag camera_tag = dice_transaction->store(cam.get());
                check_success(camera_tag.is_valid());
 
                const mi::math::Vector<mi::Uint32, 2> buffer_resolution(512, 512);
                m_image_file_canvas->set_resolution(buffer_resolution);
 
                // Set up the scene
                mi::math::Bbox_struct< mi::Float32, 3 > const xyz_roi_st = {
                    {   0.0f,   0.0f,   0.0f, },
                    { 500.0f, 500.0f, 500.0f, },
                };
 
                // set the region of interest
                const mi::math::Bbox< mi::Float32, 3 > xyz_roi(xyz_roi_st);
                check_success(xyz_roi.is_volume());
                scene_edit->set_clipped_bounding_box(xyz_roi_st);
 
                // Set the scene global transformation matrix.
                // only change the coordinate system
                mi::math::Matrix<mi::Float32, 4, 4> transform_mat(
                    1.0f,  0.0f,  0.0f,  0.0f,
                    0.0f,  1.0f,  0.0f,  0.0f,
                    0.0f,  0.0f, -1.0f,  0.0f,
                    0.0f,  0.0f,  0.0f,  1.0f
                    );
                scene_edit->set_transform_matrix(transform_mat);
 
                // Set the current camera to the scene.
                check_success(camera_tag.is_valid());
                scene_edit->set_camera(camera_tag);
            }
            dice_transaction->commit();
        }
 
        // Rendering
        {
            const mi::Sint32  frame_idx = 0;
            const std::string fname = get_output_file_name(m_outfname, frame_idx);
            mi::base::Handle<nv::index::IFrame_results> frame_results(render_frame(fname));
            const mi::base::Handle<nv::index::IError_set> err_set(frame_results->get_error_set());
            if (err_set->any_errors())
            {
                std::ostringstream os;
                const mi::Uint32 nb_err = err_set->get_nb_errors();
                for (mi::Uint32 e = 0; e < nb_err; ++e)
                {
                    if (e != 0) os << '\n';
                    const mi::base::Handle<nv::index::IError> err(err_set->get_error(e));
                    os << err->get_error_string();
                }
 
                ERROR_LOG << "IIndex_rendering rendering call failed with the following error(s): " << '\n'
                          << os.str();
                exit_code = 1;
            }
 
 
            // verify the generated frame
            if (!(verify_canvas_result(get_application_layer_interface(),
                                       m_image_file_canvas.get(), m_verify_image_fname, get_options())))
            {
                exit_code = 1;
            }
        }
    }
    // index_connect shutdown
    return exit_code;
}
 
//----------------------------------------------------------------------
bool Create_line_set::evaluate_options(nv::index::app::String_dict& sdict)
{
    const std::string com_name = sdict.get("command:", "<unknown_command>");
    m_is_unittest = nv::index::app::get_bool(sdict.get("unittest", "false"));
    
    if (m_is_unittest)
    {
        if (nv::index::app::get_bool(sdict.get("is_call_from_test", "false")))
        {
            sdict.insert("is_dump_comparison_image_when_failed", "0");
        }
        sdict.insert("outfname", "");  // turn off file output in the unit test mode
        sdict.insert("dice::verbose", "2");
    }
 
    m_outfname           = sdict.get("outfname", "");
    m_verify_image_fname = sdict.get("verify_image_fname", "");
 
    info_cout(std::string("running ") + com_name, sdict);
    info_cout("outfname = ["              + m_outfname +
              "], verify_image_fname = [" + m_verify_image_fname +
              "], dice::verbose = "       + sdict.get("dice::verbose"), sdict);
 
    // print help and exit if -h
    if(sdict.is_defined("h"))
    {
        std::cout
            << "info: Usage: " << com_name << " [option]\n"
            << "Option: [-h]\n"
            << "            printout this message\n"
            << "        [-dice::verbose severity_level]\n"
            << "            verbose severity level (3 is info.). (default: " + sdict.get("dice::verbose")
            << ")\n"
            << "        [-outfname string]\n"
            << "            output ppm file base name. When empty, no output.\n"
            << "            A frame number and extension (.ppm) will be added.\n"
            << "            (default: [" << m_outfname << "])\n"
            << "        [-verify_image_fname [image_fname]]\n"
            << "            when image_fname exist, verify the rendering image. (default: ["
            << m_verify_image_fname << "])\n"
            << "        [-unittest bool]\n"
            << "            when true, unit test mode (create smaller volume). "
            << "(default: " << m_is_unittest << ")"
            << std::endl;
        exit(1);
    }
    return true;
}
 
//----------------------------------------------------------------------
mi::math::Color_struct Create_line_set::get_color_from_attribute(mi::Sint32 attrib) const
{
    mi::math::Color_struct col;
    const mi::Float32 coef = 1.0f / 15.0f;
    col.r = coef * static_cast< mi::Float32 >(attrib & 15);
    col.g = coef * static_cast< mi::Float32 >((attrib >> 4) & 15);
    col.b = coef * static_cast< mi::Float32 >((attrib >> 8) & 15);
    col.a = 1.0;
 
    return col;
}
 
//----------------------------------------------------------------------
mi::Float32 Create_line_set::get_width_from_attribute(mi::Float32 attrib) const
{
    const mi::Float32 width =
        static_cast< mi::Float32 >(static_cast< mi::Sint32 >(fabs(attrib)) % 16);
    return width;
}
 
//----------------------------------------------------------------------
bool Create_line_set::create_line_set(
    nv::index::IScene*                scene_edit,
    mi::neuraylib::IDice_transaction* dice_transaction) const
{
    check_success(scene_edit       != 0);
    check_success(dice_transaction != 0);
 
    // hierarchical scene description node for the point set
    mi::base::Handle<nv::index::ITransformed_scene_group> group_node(
        scene_edit->create_scene_group<nv::index::ITransformed_scene_group>());
    check_success(group_node.is_valid_interface());
 
    // Line coordinates and its attributes. According to the
    // attributes, color and width are defined.
    // Here, we create two line sets.
    std::vector< mi::math::Vector_struct< mi::Float32, 3> > line_seg_vec[2];
    std::vector< mi::math::Color_struct > color_vec[2];    
    std::vector< mi::Float32 > width_vec[2];    
 
    // Square shaped positions
    const mi::Sint32  column_count       = 20;
    const mi::Sint32  line_segment_count = 200;
    const mi::Sint32  line_set_count     = 2;
    const mi::Float32 x_org              =  0.0;
    const mi::Float32 y_org              =  0.0;
    const mi::Float32 x_mag              = 25.0;
    const mi::Float32 y_mag              = 25.0;
    const mi::Float32 z                  = 30.0;
    const mi::Float32 y_offset[2]        = { 0.0f, 280.0f }; 
    mi::Sint32 idx_p = 0; // point index
 
    for(mi::Sint32 i = 0; i < line_segment_count; ++i)
    {
        // one segment has two points
        for(mi::Sint32 k = 0; k < 2; ++k){
            mi::math::Vector_struct< mi::Float32, 3> pos[2];
            for(mi::Sint32 j = 0; j < line_set_count; ++j){
                pos[j].x = x_org + static_cast< mi::Float32 >(idx_p % column_count) * x_mag;
                pos[j].y = y_org + static_cast< mi::Float32 >(idx_p / column_count) * y_mag + y_offset[j];
                pos[j].z = z;
                line_seg_vec[j].push_back(pos[j]);
            }
            ++idx_p;
        }
        for(mi::Sint32 j = 0; j < line_set_count; ++j){
            color_vec[j].push_back(get_color_from_attribute(i));
            width_vec[j].push_back(get_width_from_attribute(static_cast<mi::Float32>(i)));
        }
    }
 
    // Create two line sets
    for(mi::Sint32 j = 0; j < 2; ++j)
    {
        // Create attribute_line_set scene element and add it to the scene
        mi::base::Handle<nv::index::ILine_set> line_set(scene_edit->create_shape<nv::index::ILine_set>());
        check_success(line_set.is_valid_interface());
        line_set->set_line_type(nv::index::ILine_set::LINE_TYPE_SEGMENTS);
 
        check_success((line_seg_vec[j].size()) > 0);
        line_set->set_lines(&(line_seg_vec[j][0]), line_seg_vec[j].size() / 2); // may cut the last point
        line_set->set_colors(&(color_vec[j][0]), color_vec[j].size());
        line_set->set_widths(&(width_vec[j][0]), width_vec[j].size());
 
        // Add the line segments to the database
        const mi::neuraylib::Tag line_set_tag = dice_transaction->store_for_reference_counting(line_set.get());
        // if you are not registered Attribute_line_set, the next check fails.
        check_success(line_set_tag.is_valid());
        // Add to the scene description
        group_node->append(line_set_tag, dice_transaction);
        INFO_LOG << "Added line_set (size: " << line_set_count << ") to the scene (tag id: "
                 << line_set_tag.id << ").";
    }
 
    mi::neuraylib::Tag group_node_tag = dice_transaction->store_for_reference_counting(group_node.get());
    check_success(group_node_tag.is_valid());
    scene_edit->append(group_node_tag, dice_transaction);
 
    return true;
}
 
//----------------------------------------------------------------------
void Create_line_set::setup_camera(nv::index::IPerspective_camera* cam) const
{
    check_success(cam != 0);
 
    // Set the camera parameters to see the whole scene.
    mi::math::Vector< mi::Float32, 3 > const from( 254.0f, 254.0f,  550.0f);
    mi::math::Vector< mi::Float32, 3 > const to  ( 255.0f, 255.0f, -255.0f);
    mi::math::Vector< mi::Float32, 3 > const up  ( 0.0f,   1.0f,   0.0f);
    mi::math::Vector<mi::Float32, 3> viewdir = to - from;
    viewdir.normalize();
 
    cam->set(from, viewdir, up);
    cam->set_aperture(0.033f);
    cam->set_aspect(1.0f);
    cam->set_focal(0.03f);
    cam->set_clip_min(10.0f);
    cam->set_clip_max(5000.0f);
}
 
//----------------------------------------------------------------------
nv::index::IFrame_results* Create_line_set::render_frame(
    const std::string& output_fname) const
{
    check_success(m_index_rendering.is_valid_interface());
 
    // set output filename, empty string is valid
    m_image_file_canvas->set_rgba_file_name(output_fname.c_str());
 
    check_success(m_session_tag.is_valid());
 
    mi::base::Handle<mi::neuraylib::IDice_transaction> dice_transaction(
        m_global_scope->create_transaction<mi::neuraylib::IDice_transaction>());
    check_success(dice_transaction.is_valid_interface());
 
    m_index_session->update(m_session_tag, dice_transaction.get());
 
    mi::base::Handle<nv::index::IFrame_results> frame_results(
        m_index_rendering->render(
            m_session_tag,
            m_image_file_canvas.get(),
            dice_transaction.get()));
    check_success(frame_results.is_valid_interface());
 
    dice_transaction->commit();
 
    frame_results->retain();
    return frame_results.get();
}
 
//----------------------------------------------------------------------
// This example shows how to create line set shape in the scene.
int main(int argc, const char* argv[])
{
    nv::index::app::String_dict sdict;
    sdict.insert("dice::verbose", "3");                         // log level
    sdict.insert("outfname", "frame_create_line_set");          // output file base name
    sdict.insert("verify_image_fname", "");                     // for unit test
    sdict.insert("unittest", "0");                              // default mode
    sdict.insert("is_dump_comparison_image_when_failed", "1");  // default: dump images when failed.
    sdict.insert("is_call_from_test", "0");                     // default: not call from make check.
 
    // Load IndeX library via Index_connect
    sdict.insert("dice::network::mode", "OFF");
 
    // index setting
    sdict.insert("index::config::set_monitor_performance_values", "true");
    sdict.insert("index::service", "rendering_and_compositing");
    sdict.insert("index::cuda_debug_checks", "false");
 
    // application_layer component loading
    sdict.insert("index::app::components::application_layer::component_name_list",
                  "canvas_infrastructure image io");
 
    // Initialize application
    Create_line_set create_line_set;
    create_line_set.initialize(argc, argv, sdict);
    check_success(create_line_set.is_initialized());
 
    // launch the application. creating the scene and rendering.
    const mi::Sint32 exit_code = create_line_set.launch();
    INFO_LOG << "Shutting down ...";
        
    return exit_code;
}