ipath.h

Go to the documentation of this file.

/******************************************************************************
 * Copyright 2023 NVIDIA Corporation. All rights reserved.
 *****************************************************************************/
 
#ifndef NVIDIA_INDEX_IPATH_SHAPE_H
#define NVIDIA_INDEX_IPATH_SHAPE_H
 
#include <mi/base/interface_declare.h>
#include <mi/dice.h>
 
#include <nv/index/ishape.h>
#include <nv/index/iattribute.h>
 
namespace nv
{
namespace index
{
 
class IPath_style :
        public mi::base::Interface_declare<0xb4568002,0xc4f5,0x4e32,0xb2,0xf6,0x5e,0x04,0x12,0x45,0x2d,0xac,
                                           nv::index::IAttribute>
{
public:
    enum Cap_style
    {
        CAP_STYLE_NONE      = 0,  
        CAP_STYLE_FLAT      = 1,  
        // round caps.
        CAP_STYLE_ROUND     = 2   
    };
    
    virtual Cap_style get_cap_style() const = 0;
    
    virtual void set_cap_style(Cap_style cap_style) = 0;
    
 
    enum Interpolation
    {
        INTERPOLATION_SEGMENT      = 0,   // A single solid color per segment (default).
        INTERPOLATION_NEAREST      = 1,   // A solid color to nearest value.
        INTERPOLATION_LINEAR       = 2    // Linear color interpolation between points.
    };
    
    virtual Interpolation get_interpolation() const = 0;
    
    virtual void set_interpolation(Interpolation technique) = 0;
    
    enum Color_source
    {
        COLOR_SOURCE_NONE          = 0,   // disable colormap and rgba array sources.
        COLOR_SOURCE_COLORMAP_ONLY = 1,   // It uses colormap only. rgba array is disabled.
        COLOR_SOURCE_RGBA_ONLY     = 2,   // It uses rgba array only. Colormap is disabled.
        COLOR_SOURCE_BOTH          = 3,   // It uses both color sources or any defined (default).
                                          // When both defined it mixes the colors from both sources.
    };
    
    virtual Color_source get_color_source() const = 0;
    
    virtual void set_color_source(Color_source source) = 0;        
    
    virtual void set_upsampling(bool enable, mi::Uint32 up_factor = 2, mi::Float32 tension = 0.f) = 0;        
 
    virtual void get_upsampling(bool &enable, mi::Uint32 &up_factor, mi::Float32 &tension) const = 0;        
    
};
 
class IPath_3D :
        public mi::base::Interface_declare<0xe284adf5,0x6beb,0x4792,0x84,0x36,0x95,0xc7,0x78,0xb9,0xff,0x8a,
                                           nv::index::IObject_space_shape>
{
public:
    virtual mi::Float32 get_radius() const = 0;
    
    virtual void set_radius(mi::Float32 radius) = 0;
 
    virtual mi::Uint32 get_nb_points() const = 0;
    
    virtual const mi::math::Vector_struct<mi::Float32, 3>* get_points() const = 0;
    
    virtual void set_points(
        mi::math::Vector_struct<mi::Float32, 3>* points,
        mi::Uint32                               nb_points) = 0;
        
    virtual const mi::Float32* get_radii() const = 0;
    
    virtual void set_radii(
        mi::Float32* radii,
        mi::Uint32 nb_radii) = 0;
    
    virtual const mi::math::Color_struct* get_colors() const = 0;
    
    virtual void set_colors(
        mi::math::Color_struct* colors,
        mi::Uint32              nb_colors) = 0;
        
    virtual const mi::Uint32* get_color_map_indexes() const = 0;
    
    virtual void set_color_map_indexes(
        mi::Uint32*             indexes,
        mi::Uint32              nb_indexes) = 0;
 
    virtual const mi::Uint32* get_material_ids() const = 0;
    
    virtual void set_material_ids(
        mi::Uint32* ids,
        mi::Uint32  nb_ids) = 0;
};
 
class IPath_2D :
        public mi::base::Interface_declare<0xae7cff77,0x114b,0x472e,0x9b,0x77,0x1b,0xde,0x7d,0x98,0xff,0x7d,
                                           nv::index::IImage_space_shape>
{
public:
 
    virtual mi::Float32 get_radius() const = 0;
    
    virtual void set_radius(mi::Float32 radius) = 0;
 
    virtual mi::Uint32 get_nb_points() const = 0;
    
    virtual const mi::math::Vector_struct<mi::Float32, 3>* get_points() const = 0;
    
    virtual void set_points(
        mi::math::Vector_struct<mi::Float32, 3>* points,
        mi::Uint32                               nb_points) = 0;
        
    virtual const mi::Float32* get_radii() const = 0;
    
    virtual void set_radii(
        mi::Float32* radii,
        mi::Uint32 nb_radii) = 0;
    
    virtual const mi::math::Color_struct* get_colors() const = 0;
    
    virtual void set_colors(
        mi::math::Color_struct* colors,
        mi::Uint32              nb_colors) = 0;
        
    virtual const mi::Uint32* get_color_map_indexes() const = 0;
    
    virtual void set_color_map_indexes(
        mi::Uint32*             indexes,
        mi::Uint32              nb_indexes) = 0;
};
 
}} // namespace index / nv
 
#endif // NVIDIA_INDEX_IPATH_SHAPE_H