xac_interface_scene_elements_doc.h

Go to the documentation of this file.

/******************************************************************************
 * Copyright 2023 NVIDIA Corporation. All rights reserved.
 *****************************************************************************/
 
namespace nv {
namespace index {
namespace xac {
 
// import namespace definitions
using cuda::Mat4x4f;
 
/* Scene Object Definitions */
 
class Light
{
public:
 
    const float3& get_color() const;
 
    const float3& get_direction() const;
 
    const float3& get_direction_inverse() const;
}; // class Light
 
 
class Material_phong
{
public:
 
    Material_phong( const float3& color_ambient,
                    const float3& color_diffuse,
                    const float3& color_specular,
                    const float spec_coeff,
                    const float mat_opacity = 1.0f)
    {}
 
    const float3& get_ambient() const;
 
    const float3& get_diffuse() const;
    
    const float3& get_specular() const;
    
    float get_shininess() const;
    
    float get_opacity() const;
};
 
 
class Camera
{
public:
 
    const float3& get_position() const;
 
    const float3& get_up() const;
 
    const float3& get_right() const;
 
    const float3& get_to() const;
};
 
 
 
class Bounding_box
{
public:
    Bounding_box(
            const float3& in_min,
            const float3& in_max)
        : min(in_min)
        , max(in_max)
    {}
    
    const float3& get_min() const;
 
    const float3& get_max() const;
 
    bool is_inside(const float3& position) const;
};
 
 
class Ray
{
public:
    Ray(    const float3& in_origin,
            const float3& in_direction,
            const float3& in_direction_rec)
    {}
 
    Ray(    const float3& in_origin,
            const float3& in_direction)
    {}
 
    const float3& get_origin() const;
 
    const float3& get_direction() const;
 
    const float3& get_direction_reciprocal() const;
}; // Ray
 
 
class Colormap
{
public:
 
    float4 lookup(float value) const;
 
    float lookup_alpha(float value) const;
 
    float get_domain_min() const;
 
    float get_domain_max() const;
 
    float normalize_to_domain(const float value) const;
}; // class Colormap
 
class Texture2D
{
public:
 
    enum class Filter : unsigned
    {
         NEAREST    = 0x00u,
         LINEAR     = 0x01
    };
 
    template<Filter TEX_filter_mode =  Filter::NEAREST>
    float4 sample(const float2& uv_coordinate) const;
 
}; // class Texture2D
 
 
class Compute_texture_tile_base
{
public:
 
    bool is_valid() const;
 
    uint2 get_tile_resolution() const;
 
    float2 get_minimum_uv_coordinate() const;
 
    float2 get_maximum_uv_coordinate() const;
 
    uint get_format() const;
 
    float2 get_extent() const;
    
    float2 transform_uv_to_tile(float2 uv_position) const;
 
    float2 transform_uv_to_tile_inverse(float2 tile_position) const;
 
    xac::Colormap get_colormap() const;
}; // class Compute_texture_tile_base
 
 
class Compute_texture_tile : public Compute_texture_tile_base
{
public:
 
    float4 sample(const float2& uv_coordinate) const;
 
    float4 sample_offset(const float2& uv_coordinate, const int2& offset) const;
 
    float4 sample_non_normalized(const float2& tile_coordinate) const;
}; // class Compute_texture_tile
 
 
class Compute_texture_LOD_tile : public Compute_texture_tile_base
{
public:
 
    float4 sample(const float2& uv_coordinate, const float sample_distance) const;
}; // class Compute_texture_LOD_tile
 
class Triangle_mesh
{
public:
    typedef Sample_info_surface      Base_info_type;
 
    uint get_light_id() const;
 
    uint get_material_id(uint material_idx = 0u) const;
 
    const float4& get_vertex_color(uint index) const;
 
    const float3& get_vertex_position(uint index) const;
 
    const float3& get_vertex_normal(uint index) const;
 
    const float2& get_vertex_texture_coordinate(uint index) const;
 
    xac::Texture2D get_texture() const;
}; // class Triangle_mesh
 
 
class Height_field
{
public:
    typedef Sample_info_height_field  Base_info_type;
 
    bool is_inside(const float3& sample_position) const;
 
    bool is_hole(float height) const;
 
    bool has_compute_texture() const;
 
    float get_elevation_value(float px, float py, float& hf_u, float& hf_v) const;
 
    float2 get_elevation_minmax_interval() const;
 
    float3 get_normal(const float3& scene_position) const;
 
    const nv::index::cuda::Mat4x4f& get_scene_to_object_transform() const;
 
    const nv::index::cuda::Mat4x4f& get_scene_to_object_transform_inverse() const;
 
    float2 transform_scene_to_sample(const float3& scene_pos) const;
 
    float3 transform_scene_to_sample_inverse(const float2& sample_pos) const;
 
    uint get_light_id() const;
 
    uint get_material_id() const;
 
    xac::Colormap get_colormap() const;
 
    xac::Colormap get_colormap_compute_texture() const;
 
    xac::Compute_texture_tile get_compute_texture() const;
};
 
 
class LOD_height_field
{
public:
    typedef Sample_info_height_field  Base_info_type;
 
    uint get_light_id() const;
 
    uint get_material_id() const;
}; //  class LOD_height_field
 
 
class Ellipsoid
{
public:
    typedef Sample_info_surface         Base_info_type;
 
    uint get_light_id() const;
 
    uint get_material_id() const;
 
    bool is_valid() const;
 
    bool is_inside(const float3& scene_position) const;
 
    float get_distance(const float3& scene_position) const;
 
    const float3& get_center() const;
 
    const float3 get_semi_axis_a() const;
 
    const float3 get_semi_axis_b() const;
 
    const float3 get_semi_axis_c() const;
 
    const Mat3x3f& get_world_to_axis_transform() const;
 
    const Mat3x3f& get_world_to_axis_transform_inverse() const;
};
 
 
class Sphere
{
public:
    typedef Sample_info_surface         Base_info_type;
 
    bool is_valid() const;
 
    uint get_light_id() const;
 
    uint get_material_id() const;
 
    const float3& get_center() const;
 
    float get_radius() const;
 
    bool is_inside(const float3& scene_position) const;
 
    float get_distance(const float3& scene_position) const;
};
 
 
class Cylinder
{
public:
    typedef Sample_info_surface     Base_info_type;
 
    uint get_light_id() const;
 
    uint get_material_id() const;
 
    const float3& get_bottom() const;
 
    const float3& get_top() const;
 
    float get_radius() const;
 
    bool is_valid() const;
 
    bool is_capped() const;
 
    bool is_inside(const float3& world_position) const;
 
    float get_distance(const float3& scene_position) const;
};
 
 
class Cone
{
public:
    typedef Sample_info_surface     Base_info_type;
 
    uint get_light_id() const;
 
    uint get_material_id() const;
 
    const float3& get_bottom() const;
 
    const float3& get_top() const;
 
    float get_radius() const;
 
    bool is_valid() const;
 
    bool is_capped() const;
 
    bool is_inside(const float3& world_position) const;
 
    float get_distance(const float3& scene_position) const;
}; // Cone
 
 
class Plane
{
public:  
    typedef Sample_info_plane    Base_info_type;
 
    bool is_valid() const;
 
    float get_distance(const float3& scene_position) const;
 
    const float3& get_position() const;
 
    const float3& get_normal() const;
 
    const float3& get_right() const;
 
    const float3& get_up() const;
 
    const float2& get_extent() const;
 
    uint get_light_id() const;
 
    uint get_material_id() const;
 
    xac::Colormap get_colormap() const;
 
    xac::Colormap get_colormap_compute_texture() const;
 
    bool has_compute_texture() const;
 
    xac::Compute_texture_tile get_compute_texture() const;
 
    bool has_compute_LOD_texture() const;
 
    xac::Compute_texture_LOD_tile get_compute_texture_LOD() const;
};
 
 
 
} // namespace xac
} // namespace index
} // namespace nv