iparticle_volume_rendering_properties.h

Go to the documentation of this file.

/******************************************************************************
 * Copyright 2023 NVIDIA Corporation. All rights reserved.
 *****************************************************************************/
 
#ifndef NVIDIA_INDEX_IPARTICLE_VOLUME_RENDERING_PROPERTIES_H
#define NVIDIA_INDEX_IPARTICLE_VOLUME_RENDERING_PROPERTIES_H
 
#include <mi/dice.h>
 
#include <nv/index/iattribute.h>
 
namespace nv {
namespace index {
 
enum Particle_volume_rendering_mode
{
    PARTICLE_VOLUME_RENDERING_MODE_RBF             = 0x00u,    
    PARTICLE_VOLUME_RENDERING_MODE_SOLID_BOX,                  
    PARTICLE_VOLUME_RENDERING_MODE_SOLID_CONE,                 
    PARTICLE_VOLUME_RENDERING_MODE_SOLID_CYLINDER,             
    PARTICLE_VOLUME_RENDERING_MODE_SOLID_SPHERE,               
    PARTICLE_VOLUME_RENDERING_MODE_SOLID_DISC,                 
    PARTICLE_VOLUME_RENDERING_MODE_SOLID_INDIVIDUAL,           
 
    PARTICLE_VOLUME_RENDERING_MODE_COUNT
};
 
enum Particle_volume_RBF_falloff_kernel
{
    PARTICLE_VOLUME_RBF_FALLOFF_CONSTANT        = 0x00,
    PARTICLE_VOLUME_RBF_FALLOFF_LINEAR,
    PARTICLE_VOLUME_RBF_FALLOFF_HERMITE,
    PARTICLE_VOLUME_RBF_FALLOFF_SPLINE,
 
    PARTICLE_VOLUME_RBF_FALLOFF_COUNT
};
 
class IParticle_volume_rendering_properties :
    public mi::base::Interface_declare<0x82869c9e,0x96a,0x4e86,0x9f,0xde,0x40,0xa8,0x62,0xcd,0xa0,0xa1,
                                       nv::index::IAttribute>
{
public:
    virtual void                        set_sampling_distance(mi::Float32 sample_dist) = 0;
    virtual mi::Float32                 get_sampling_distance() const = 0;
 
    virtual void                        set_reference_sampling_distance(mi::Float32 ref_sample_dist) = 0;
    virtual mi::Float32                 get_reference_sampling_distance() const = 0;
 
    virtual void                        set_rendering_mode(Particle_volume_rendering_mode rendering_mode) = 0;
    virtual Particle_volume_rendering_mode get_rendering_mode() const = 0;
 
 
    virtual void                        set_rbf_falloff_kernel(Particle_volume_RBF_falloff_kernel falloff_kernel) = 0;
    virtual Particle_volume_RBF_falloff_kernel  get_rbf_falloff_kernel() const = 0;
 
    virtual void                        set_override_fixed_radius(mi::Float32 override_radius) = 0;
    virtual mi::Float32                 get_override_fixed_radius() const = 0;
 
    virtual void                        set_use_optix_sphere_primitives(bool use_optix_spheres) = 0;
    virtual bool                        get_use_optix_sphere_primitives() const = 0;
 
    virtual void                        set_debug_visualization_option(mi::Uint32 o) = 0;
    virtual mi::Uint32                  get_debug_visualization_option() const = 0;
};
 
} // namespace index
} // namespace nv
 
#endif // NVIDIA_INDEX_IPARTICLE_VOLUME_RENDERING_PROPERTIES_H