The interface class representing rendering properties for particle volume data.
More...
#include <iparticle_volume_rendering_properties.h>
Inherits mi::base::Interface_declare< 0x82869c9e, ... >.
The interface class representing rendering properties for particle volume data.
◆ get_debug_visualization_option()
| virtual mi::Uint32 nv::index::IParticle_volume_rendering_properties::get_debug_visualization_option |
( |
| ) |
const |
|
pure virtual |
Internal debugging options applied to the visualization.
- Returns
- Returns the applied debug option.
◆ get_override_fixed_radius()
| virtual mi::Float32 nv::index::IParticle_volume_rendering_properties::get_override_fixed_radius |
( |
| ) |
const |
|
pure virtual |
Returns the override radius applied to a particle volume scene element (Iparticle_volume_scene_element).
◆ get_rbf_falloff_kernel()
Returns the falloff kernel function applied for the radial basis function rendering (RBF) mode.
◆ get_reference_sampling_distance()
| virtual mi::Float32 nv::index::IParticle_volume_rendering_properties::get_reference_sampling_distance |
( |
| ) |
const |
|
pure virtual |
Returns the reference sampling distance used for a particle volume scene element (Iparticle_volume_scene_element).
◆ get_rendering_mode()
Returns the rendering mode used for rendering a particle volume scene element (Iparticle_volume_scene_element).
◆ get_sampling_distance()
| virtual mi::Float32 nv::index::IParticle_volume_rendering_properties::get_sampling_distance |
( |
| ) |
const |
|
pure virtual |
Returns the sampling distance used for a particle volume scene element (Iparticle_volume_scene_element).
◆ get_use_optix_sphere_primitives()
| virtual bool nv::index::IParticle_volume_rendering_properties::get_use_optix_sphere_primitives |
( |
| ) |
const |
|
pure virtual |
Returns whether the mode to use OptiX native spheres primitives for rendering is set.
◆ set_debug_visualization_option()
| virtual void nv::index::IParticle_volume_rendering_properties::set_debug_visualization_option |
( |
mi::Uint32 |
o | ) |
|
|
pure virtual |
Internal debugging options applied to the visualization.
- Parameters
-
| [in] | o | Debug option applied to the visualization. |
◆ set_override_fixed_radius()
| virtual void nv::index::IParticle_volume_rendering_properties::set_override_fixed_radius |
( |
mi::Float32 |
override_radius | ) |
|
|
pure virtual |
Set a override radius used as a fixed radius for all particles in the dataset.
This setting allows to control the size of the particles without modifying the particle radii through the data subset. This can be especially useful for the solid geometry rendering modes.
- Note
- Setting this override radius larger than the radii or fixed radius specified during data import may result in rendering artifacts due to the existing data distribution of the subsets already created.
◆ set_rbf_falloff_kernel()
Set the radial basis-function falloff kernel applied for the direct volume rendering mode.
- Parameters
-
| [in] | falloff_kernel | RBF falloff kernel function (default value is PARTICLE_VOLUME_RBF_FALLOFF_LINEAR). |
◆ set_reference_sampling_distance()
| virtual void nv::index::IParticle_volume_rendering_properties::set_reference_sampling_distance |
( |
mi::Float32 |
ref_sample_dist | ) |
|
|
pure virtual |
Set the reference sampling distance used for a particle volume scene element (Iparticle_volume_scene_element).
The default value used is 1.0f. The reference sampling distance is used during the volume rendering to steer the opacity correction and therefore the appearance of the volume display.
- Parameters
-
| [in] | ref_sample_dist | Sampling distance (default value is 1.0f). |
◆ set_rendering_mode()
Set rendering mode used for the visualization of a particle volume scene element (Iparticle_volume_scene_element).
- Parameters
-
| [in] | rendering_mode | Rendering mode identifier (default value is PARTICLE_VOLUME_RENDERING_MODE_RBF). |
◆ set_sampling_distance()
| virtual void nv::index::IParticle_volume_rendering_properties::set_sampling_distance |
( |
mi::Float32 |
sample_dist | ) |
|
|
pure virtual |
Set the sampling distance used for a particle volume scene element (Iparticle_volume_scene_element) when applying the direct volume rendering mode (PARTICLE_VOLUME_RENDERING_MODE_RBF).
The default value used is 1.0f.
- Parameters
-
| [in] | sample_dist | Sampling distance (default value is 1.0f). |
◆ set_use_optix_sphere_primitives()
| virtual void nv::index::IParticle_volume_rendering_properties::set_use_optix_sphere_primitives |
( |
bool |
use_optix_spheres | ) |
|
|
pure virtual |
Set the mode to use OptiX native spheres primitives for rendering.
- Note
- This mode may help reduce the memory overhead required for building the internal BVH structures.
The documentation for this class was generated from the following file:
