isampling_rays.h

Go to the documentation of this file.

/******************************************************************************
 * Copyright 2023 NVIDIA Corporation. All rights reserved.
 *****************************************************************************/
#ifndef NVIDIA_INDEX_SAMPLING_RAYS_H
#define NVIDIA_INDEX_SAMPLING_RAYS_H
 
#include <mi/math/vector.h>
#include <mi/math/color.h>
#include <mi/base/interface_declare.h>
#include <mi/neuraylib/iserializer.h>    // Tag_struct
 
namespace mi {
namespace neuraylib {
 
class IDice_transaction;
 
}}
 
 
 
namespace nv {
namespace index {
 
// forward declarations
class IScene_path;  // see iscene_query_result.h
class IIndex_rendering;
class IRay_sampling_value_format;
class IRay_sampling_query;
class IRay_sampling_result;
class IPerformance_values;
 
 
 
class IRay_sampling
    : public mi::base::Interface_declare<0xa9c602d,0x3869,0x4a42,0x94,0x9d,0x57,0x33,0x4b,0xa0,0x5a,0x4b>
{
public:
    enum Limit {
        MAX_RAYS,               
        MAX_USER_VALUES,        
        MAX_USER_VALUE_SIZE     
    };
 
    virtual mi::Uint32  get_limit(Limit limit) const = 0;
 
    virtual IRay_sampling_value_format* create_sampling_value_format() = 0;
 
    virtual IRay_sampling_query* create_sampling_query() = 0;
 
    virtual const IRay_sampling_result* sample_scene(
        const IRay_sampling_query*        sampling_query,
        const IRay_sampling_value_format* user_value_format,
        IIndex_rendering*                 index_rendering,
        mi::neuraylib::Tag_struct         session_tag,
        mi::neuraylib::IDice_transaction* transaction) = 0;
};
 
 
 
class IRay_sampling_value_format
    : public mi::base::Interface_declare<0x2c848141,0xb2de,0x46db,0x92,0xaa,0xc7,0x66,0x7e,0xdb,0xeb,0xfe>
{
public:
    virtual bool set_value_sizes(const mi::Uint32* value_sizes, mi::Uint32 nb_values) = 0;
 
    virtual mi::Uint32 get_nb_values() const = 0;
 
    virtual mi::Uint32 get_value_size(mi::Uint32 i) const = 0;
};
 
 
 
class IRay_sampling_query
    : public mi::base::Interface_declare<0xd2f21a06,0xb509,0x40df,0x82,0xd1,0x91,0xc1,0x1c,0xe4,0xc3,0xf>
{
public:
    virtual bool is_valid() const = 0;
 
    virtual void set_max_samples(mi::Uint32 num) = 0;
 
    virtual mi::Uint32 get_max_samples() const = 0;
 
 
    struct Ray {
        mi::math::Vector_struct<mi::Float32, 3>   origin;       
        mi::math::Vector_struct<mi::Float32, 3>   direction;    
        mi::math::Vector_struct<mi::Float32, 2>   range;        
    };
 
 
    virtual bool set_rays(const Ray* rays, mi::Uint32 nb_rays) = 0;
    
    virtual mi::Uint32  get_nb_rays() const = 0;
 
    virtual const Ray*  get_ray(mi::Uint32 index) const = 0;
};
 
 
 
class IRay_sampling_object_info
    : public mi::base::Interface_declare<0xb8a4ffbd,0x5f8b,0x4785,0x8a,0x95,0xa6,0xe1,0xb5,0xfc,0x97,0x78>
{
public:
    virtual mi::neuraylib::Tag_struct get_scene_element() const = 0;
 
    virtual const IScene_path* get_scene_path() const = 0;
};
 
 
 
class IRay_sampling_result
    : public mi::base::Interface_declare<0x1560b720,0xe3c7,0x4356,0x92,0x29,0xd8,0x41,0xef,0x4d,0xb3,0xe6>
{
public:
 
    virtual const IRay_sampling_query*          get_query() const = 0;
 
    virtual const IRay_sampling_value_format*   get_value_format() const = 0;
 
    virtual bool        is_valid() const = 0;
 
    virtual mi::Uint32  get_nb_samples(mi::Uint32 ray_index) const = 0;
 
 
    struct Sample_range {
        mi::Uint32  ray_index;      
        mi::Uint32  first_sample;   
        mi::Uint32  nb_samples;     
    };
 
    virtual bool get_distances(const Sample_range& sample_range, mi::Float32* data) const = 0;
    
    virtual bool get_colors(const Sample_range& sample_range, mi::math::Color_struct* data) const = 0;
    
    virtual bool get_flags(const Sample_range& sample_range, mi::Uint32* data) const = 0;
    
    virtual bool get_element_indices(const Sample_range& sample_range, mi::Uint64* data) const = 0;
 
    virtual bool get_user_values(const Sample_range& sample_range, mi::Uint32 value_index, void* data) const = 0;
 
    virtual bool get_user_value_masks(const Sample_range& sample_range, mi::Uint32* data) const = 0;
 
    virtual bool get_object_ids(const Sample_range& sample_range, mi::Uint32* data) const = 0;
 
 
 
    virtual const IRay_sampling_object_info* get_object_info(mi::Uint32 object_id) const = 0;
 
    virtual mi::Uint32 get_nb_object_infos() const = 0;
 
 
    virtual const IPerformance_values* get_performance_values() const = 0;
};
 
}} // nv::index
 
#endif //NVIDIA_INDEX_SAMPLING_RAYS_H