create_label_auto_width.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/iconfig_settings.h>
#include <nv/index/idepth_offset.h>
#include <nv/index/idepth_test.h>
#include <nv/index/iindex.h>
#include <nv/index/ilabel.h>
#include <nv/index/ilight.h>
#include <nv/index/imaterial.h>
#include <nv/index/iscene.h>
#include <nv/index/iscene_group.h>
#include <nv/index/isession.h>
 
#include <nv/index/app/index_connect.h>
#include <nv/index/app/string_dict.h>
#include <nv/index/app/time_functions.h>
 
#include "utility/app_rendering_context.h"
#include "utility/canvas_utility.h"
 
#include <algorithm>
#include <iostream>
#include <sstream>
 
//----------------------------------------------------------------------
class Create_label_auto_width:
    public nv::index::app::Index_connect
{
public:
    Create_label_auto_width()
        :
        Index_connect()
    {
        // INFO_LOG << "DEBUG: Create_label_auto_width() ctor";
    }
 
    virtual ~Create_label_auto_width()
    {
        // Note: Index_connect::~Index_connect() will be called after here.
        // INFO_LOG << "DEBUG: ~Create_label_auto_width() 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:
    void create_append_material_to_group(
        nv::index::IScene*                   scene_edit,
        nv::index::ITransformed_scene_group* group_node,
        const mi::math::Color &              ambient_color,
        const mi::math::Color &              diffuse_color,
        const mi::math::Color &              specular_color,
        const mi::Float32                    shiness,
        mi::neuraylib::IDice_transaction*    dice_transaction) const;
 
    // depth offset attribute test: labels
    //
    // \param[in] scene_edit the editable IndeX scene
    // \param[in] group_node   parent group node
    // \param[in] label_point  label's corner position in the object space
    // \param[in] label_str    label contents string
    // \param[in] label_height label height in the object space
    // \param[in] label_width  label width in the object space
    // \param[in] fg_col       label foreground color
    // \param[in] bg_col       label background color
    // \param[in] dice_transaction db transaction
    // \return created group node tag
    void create_append_label_to_group(
        nv::index::IScene*                      scene_edit,
        nv::index::ITransformed_scene_group*    group_node,
        const mi::math::Vector<mi::Float32, 3>& label_point,
        const std::string&                      label_str,
        const mi::Float32                       label_height,
        const mi::Float32                       label_width,
        const mi::math::Color_struct&           fg_col,
        const mi::math::Color_struct&           bg_col,
        mi::neuraylib::IDice_transaction*       dice_transaction) const;
 
    // create test scene
    //
    // \param[in] scene_edit       IScene for the scene edit.
    // \param[in] dice_transaction dice transaction
    void create_scene(
        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;
 
    // render a frame
    //
    // \param[in] output_fname     output rendering image filename
    // \return performance values
    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_label_auto_width
    std::string                                                                       m_outfname;
    std::string                                                                       m_font_fpath;
    bool                                                                              m_is_unittest;
    std::string                                                                       m_verify_image_fname;
};
 
//----------------------------------------------------------------------
mi::Sint32 Create_label_auto_width::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
        const int max_retry = 3;
        for (int retry = 0; retry < max_retry; ++retry)
        {
            if (m_cluster_configuration->get_number_of_hosts() == 0)
            {
                INFO_LOG << "no host joined yet, retry "
                         << (retry + 1) << "/" << max_retry;
                nv::index::app::util::time::sleep(0.3f);
            }
        }
        check_success(m_cluster_configuration->get_number_of_hosts() != 0);
 
        {
            // Obtain a DiCE transaction
            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<const nv::index::ISession> session(
                    dice_transaction->access<nv::index::ISession>(
                        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 textured planes
                //----------------------------------------------------------------------
                create_scene(scene_edit.get(), dice_transaction.get());
 
                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(1024, 1024);
                m_image_file_canvas->set_resolution(buffer_resolution);
 
                // Set up the scene and define the region of interest
                const mi::math::Bbox_struct<mi::Float32, 3> xyz_roi_st = {
                    { -500.0f, -500.0f, -500.0f, },
                    {  500.0f,  500.0f,  500.0f, },
                };
 
                // scope for a scene edit
                {
                    mi::base::Handle< nv::index::IScene > scene(
                        dice_transaction->edit< nv::index::IScene >(session->get_scene()));
                    check_success(scene.is_valid_interface());
 
                    // set the region of interest
                    const mi::math::Bbox< mi::Float32, 3 > xyz_roi(xyz_roi_st);
                    check_success(xyz_roi.is_volume());
                    scene->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->set_transform_matrix(transform_mat);
 
                    // Set the current camera to the scene.
                    check_success(camera_tag.is_valid());
                    scene->set_camera(camera_tag);
                }
            }
            // Commit the transaction used for initialization
            dice_transaction->commit();
        }
 
        // Rendering
        {
            // Render the frame to a file
            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;
            }
        }
    }
 
    return exit_code;
}
 
 
//----------------------------------------------------------------------
bool Create_label_auto_width::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_font_fpath = sdict.get("font_fpath", "");
    m_verify_image_fname = sdict.get("verify_image_fname", "");
 
    info_cout(std::string("running ") + com_name, sdict);
    info_cout("outfname = ["        + m_outfname +
              "], 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"
 
            << "        [-font_fpath FONT_FILE_PATH]\n"
            << "            font file path. (default: " << m_font_fpath << ")\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. " << m_is_unittest
            << std::endl;
        exit(1);
    }
    return true;
}
 
//----------------------------------------------------------------------
void Create_label_auto_width::create_append_material_to_group(
    nv::index::IScene*                   scene_edit,
    nv::index::ITransformed_scene_group* group_node,
    const mi::math::Color &              ambient_color,
    const mi::math::Color &              diffuse_color,
    const mi::math::Color &              specular_color,
    const mi::Float32                    shiness,
    mi::neuraylib::IDice_transaction*    dice_transaction) const
{
    check_success(scene_edit != 0);
    check_success(group_node != 0);
    check_success(dice_transaction != 0);
 
    // Add a fully ambient material for the planes, so that lighting doesn't matter
    mi::base::Handle<nv::index::IPhong_gl> phong_1(
        scene_edit->create_attribute<nv::index::IPhong_gl>());
 
    check_success(phong_1.is_valid_interface());
    phong_1->set_ambient(ambient_color);
    phong_1->set_diffuse(diffuse_color);
    phong_1->set_specular(specular_color);
    phong_1->set_shininess(shiness);
    
    mi::neuraylib::Tag phong_1_tag = dice_transaction->store_for_reference_counting(phong_1.get());
    check_success(phong_1_tag.is_valid());
    group_node->append(phong_1_tag, dice_transaction);
}
 
 
//----------------------------------------------------------------------
void Create_label_auto_width::create_append_label_to_group(
    nv::index::IScene*                      scene_edit,
    nv::index::ITransformed_scene_group*    group_node,
    const mi::math::Vector<mi::Float32, 3>& label_point,
    const std::string&                      label_str,
    const mi::Float32                       label_height,
    const mi::Float32                       label_width,
    const mi::math::Color_struct&           fg_col,
    const mi::math::Color_struct&           bg_col,
    mi::neuraylib::IDice_transaction*       dice_transaction) const
{
    // Add font to the scene description
    mi::base::Handle<nv::index::IFont> font(scene_edit->create_attribute<nv::index::IFont>());
    check_success(font.is_valid_interface());
    check_success(!m_font_fpath.empty());
 
    if (font->set_file_name(m_font_fpath.c_str()))
    {
        INFO_LOG << "set the font path [" << m_font_fpath << "]";
    }
    else
    {
        ERROR_LOG << "Can not find the font path [" << m_font_fpath << "], "
                  << "the rendering result may not correct.";
    }
    font->set_font_resolution(64.0f);
    const mi::neuraylib::Tag font_tag = dice_transaction->store_for_reference_counting(font.get());
    check_success(font_tag.is_valid());
    group_node->append(font_tag, dice_transaction);
 
    // Add a label
    {
        mi::base::Handle<nv::index::ILabel_layout> label_layout(
            scene_edit->create_attribute<nv::index::ILabel_layout>());
        check_success(label_layout.is_valid_interface());
        const mi::Float32 padding = 20.0f;
        label_layout->set_padding(padding);
        label_layout->set_color(fg_col, bg_col);
        const mi::neuraylib::Tag label_layout_tag = 
            dice_transaction->store_for_reference_counting(label_layout.get());
        check_success(label_layout_tag.is_valid());
        group_node->append(label_layout_tag, dice_transaction);
 
        mi::base::Handle<nv::index::ILabel_3D> label(scene_edit->create_shape<nv::index::ILabel_3D>());
        check_success(label.is_valid_interface());
        label->set_text(label_str.c_str());
 
        const mi::math::Vector<mi::Float32, 3> right(1.0f, 0.0f, 0.0f);
        const mi::math::Vector<mi::Float32, 3> up   (0.0f, 1.0f, 0.0f);
        label->set_geometry(label_point, right, up, label_height, label_width);
        const mi::neuraylib::Tag label_tag = dice_transaction->store_for_reference_counting(label.get());
        check_success(label_tag.is_valid());
        group_node->append(label_tag, dice_transaction);
    }
}
 
//----------------------------------------------------------------------
void Create_label_auto_width::create_scene(
    nv::index::IScene*                  scene_edit,
    mi::neuraylib::IDice_transaction*   dice_transaction) const
{
    check_success(scene_edit       != 0);
    check_success(dice_transaction != 0);
 
    // Add a scene group where the shapes should be added
    mi::base::Handle<nv::index::ITransformed_scene_group> main_group_node(
        scene_edit->create_scene_group<nv::index::ITransformed_scene_group>());
    check_success(main_group_node.is_valid_interface());
 
    // Add a light and a material
    {
        // Add a light
        mi::base::Handle<nv::index::IDirectional_headlight> headlight(
            scene_edit->create_attribute<nv::index::IDirectional_headlight>());
        check_success(headlight.is_valid_interface());
        const mi::math::Color_struct color_intensity = { 1.0f, 1.0f, 1.0f, 1.0f, };
        headlight->set_intensity(color_intensity);
        headlight->set_direction(mi::math::Vector<mi::Float32, 3>(1.0f, -1.0f, -1.0f));
        const mi::neuraylib::Tag headlight_tag = dice_transaction->store_for_reference_counting(headlight.get());
        check_success(headlight_tag.is_valid());
        main_group_node->append(headlight_tag, dice_transaction);
 
        // Add a fully ambient material for the planes, so that lighting doesn't matter
        create_append_material_to_group(scene_edit,
                                        main_group_node.get(),
                                        mi::math::Color(1.0f, 1.0f, 1.0f, 1.0f),
                                        mi::math::Color(0.0f),
                                        mi::math::Color(0.0f),
                                        100.0f,
                                        dice_transaction);
    }
 
    // create some labels with fixed width
    {
        mi::math::Color_struct fg_col; fg_col.r = 0.25f; fg_col.g = 0.95f; fg_col.b = 0.99f; fg_col.a = 1.0f;
        mi::math::Color_struct bg_col; bg_col.r = 0.4f; bg_col.g = 0.5f;  bg_col.b = 0.4f;  bg_col.a = 0.5f;
    
        mi::math::Vector<mi::Float32, 3> label_pos (-800.0f, 700.0f, 0.0f );
        std::string str = "This label's size";
        create_append_label_to_group(scene_edit, main_group_node.get(), label_pos, str,
                                     100.0f, 700.0f, fg_col, bg_col, dice_transaction);
 
        label_pos.y += -300.f;
        str = "has to be";
        create_append_label_to_group(scene_edit, main_group_node.get(), label_pos, str,
                                     130.0f, 700.0f, fg_col, bg_col, dice_transaction);
 
        label_pos.y += -300.f;
        str = "manually adjusted";
        create_append_label_to_group(scene_edit, main_group_node.get(), label_pos, str,
                                     110.0f, 700.0f, fg_col, bg_col, dice_transaction);
 
        label_pos.y += -300.f;
        str = "to";
        create_append_label_to_group(scene_edit, main_group_node.get(), label_pos, str,
                                     165.0f, 700.0f, fg_col, bg_col, dice_transaction);
 
        label_pos.y += -300.f;
        str = "fit the text";
        create_append_label_to_group(scene_edit, main_group_node.get(), label_pos, str,
                                     135.0f, 700.0f, fg_col, bg_col, dice_transaction);
                                     
    }
    
    // create some other labels with auto width
    {
        mi::math::Color_struct fg_col; fg_col.r = 0.25f; fg_col.g = 0.95f; fg_col.b = 0.25f; fg_col.a = 1.0f;
        mi::math::Color_struct bg_col; bg_col.r = 0.4f;  bg_col.g = 0.5f;  bg_col.b = 0.4f;  bg_col.a = 0.5f;
 
        mi::math::Vector<mi::Float32, 3> label_pos (0.0f, 700.0f, 0.0f );
        std::string str = "This other labels instead";
        create_append_label_to_group(scene_edit, main_group_node.get(), label_pos, str,
                                     100.0f, -1.0f, fg_col, bg_col, dice_transaction);
 
        label_pos.y += -300.f;
        str = "can";
        create_append_label_to_group(scene_edit, main_group_node.get(), label_pos, str,
                                     130.0f, -1.0f, fg_col, bg_col, dice_transaction);
 
        label_pos.y += -300.f;
        str = "automatically adapt";
        create_append_label_to_group(scene_edit, main_group_node.get(), label_pos, str,
                                     110.0f, -1.0f, fg_col, bg_col, dice_transaction);
 
        label_pos.y += -300.f;
        str = "its size to";
        create_append_label_to_group(scene_edit, main_group_node.get(), label_pos, str,
                                     165.0f, -1.0f, fg_col, bg_col, dice_transaction);
 
        label_pos.y += -300.f;
        str = "fit the text";
        create_append_label_to_group(scene_edit, main_group_node.get(), label_pos, str,
                                     135.0f, -1.0f, fg_col, bg_col, dice_transaction);
                                     
    }
 
    // Finally append everything to the root of the hierachical scene description
    const mi::neuraylib::Tag main_group_tag = dice_transaction->store_for_reference_counting(main_group_node.get());
    check_success(main_group_tag.is_valid());
    scene_edit->append(main_group_tag, dice_transaction);
}
 
//----------------------------------------------------------------------
void Create_label_auto_width::setup_camera(nv::index::IPerspective_camera* cam) const
{
    check_success(cam != 0);
 
    // Set the camera parameters to see the whole scene.
    const mi::math::Vector<mi::Float32, 3> from(0.0f, 0.0f, 2000.0f);
    const mi::math::Vector<mi::Float32, 3> to  (0.0f, 0.0f,    0.0f);
    const mi::math::Vector<mi::Float32, 3> 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(80.0f);
    cam->set_clip_max(5000.0f);
}
 
//----------------------------------------------------------------------
nv::index::IFrame_results* Create_label_auto_width::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 label with automatic width setting
int main(int argc, const char* argv[])
{
    nv::index::app::String_dict sdict;
    sdict.insert("dice::verbose", "3");                                   // log level
    sdict.insert("font_fpath", "/usr/share/fonts/dejavu/DejaVuSans.ttf"); // font path
    sdict.insert("outfname", "frame_create_label_auto_width");            // 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");
 
    // Start IndeX via index_connect
    Create_label_auto_width create_label_auto_width;
    create_label_auto_width.initialize(argc, argv, sdict);
    check_success(create_label_auto_width.is_initialized());
 
    // launch the application. creating the scene and rendering.
    const mi::Sint32 exit_code = create_label_auto_width.launch();
    INFO_LOG << "Shutting down ...";
 
    return exit_code;
}