The interface class representing rendering properties for sparse volume data.
More...
#include <isparse_volume_rendering_properties.h>
Inherits mi::base::Interface_declare< 0x718c9406, ... >.
The interface class representing rendering properties for sparse volume data.
◆ get_debug_visualization_option()
| virtual mi::Uint32 nv::index::ISparse_volume_rendering_properties::get_debug_visualization_option |
( |
| ) |
const |
|
pure virtual |
Internal debugging options applied to the visualization.
- Returns
- Returns the applied debug option.
◆ get_filter_mode()
◆ get_lod_pixel_threshold()
| virtual mi::Float32 nv::index::ISparse_volume_rendering_properties::get_lod_pixel_threshold |
( |
| ) |
const |
|
pure virtual |
Returns the currently set scalar pixel threshold.
◆ get_lod_rendering_enabled()
| virtual bool nv::index::ISparse_volume_rendering_properties::get_lod_rendering_enabled |
( |
| ) |
const |
|
pure virtual |
Returns if level-of-detail rendering is enabled or disabled.
◆ get_preintegrated_volume_rendering()
| virtual bool nv::index::ISparse_volume_rendering_properties::get_preintegrated_volume_rendering |
( |
| ) |
const |
|
pure virtual |
Returns if the pre-integrated volume rendering is enabled or disabled.
◆ get_reference_sampling_distance()
| virtual mi::Float32 nv::index::ISparse_volume_rendering_properties::get_reference_sampling_distance |
( |
| ) |
const |
|
pure virtual |
◆ get_sampling_distance()
| virtual mi::Float32 nv::index::ISparse_volume_rendering_properties::get_sampling_distance |
( |
| ) |
const |
|
pure virtual |
◆ get_voxel_offsets()
| virtual mi::math::Vector_struct< mi::Float32, 3 > nv::index::ISparse_volume_rendering_properties::get_voxel_offsets |
( |
| ) |
const |
|
pure virtual |
◆ set_debug_visualization_option()
| virtual void nv::index::ISparse_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_filter_mode()
Set the volume filter mode for a sparse volume scene element (ISparse_volume_scene_element).
The default filter used is SPARSE_VOLUME_FILTER_NEAREST.
- Parameters
-
| [in] | filter_mode | Filter mode (default value is SPARSE_VOLUME_FILTER_NEAREST). |
◆ set_lod_pixel_threshold()
| virtual void nv::index::ISparse_volume_rendering_properties::set_lod_pixel_threshold |
( |
mi::Float32 |
pixel_threshold | ) |
|
|
pure virtual |
The pixel-threshold allows to control the dynamic level-of-detail selection.
It feeds into an internal heuristic determining the amount of pixels a voxel spans in the viewport. A larger threshold allows for a more coarse LOD selection displaying lower resolution data closer to the view point.
- Parameters
-
| [in] | pixel_threshold | Scalar pixel threshold. |
◆ set_lod_rendering_enabled()
| virtual void nv::index::ISparse_volume_rendering_properties::set_lod_rendering_enabled |
( |
bool |
enable_lod_render | ) |
|
|
pure virtual |
Set the mode for the level-of-detail (LOD) rendering for a sparse volume scene element (ISparse_volume_scene_element).
The default setting of disabled.
- Parameters
-
| [in] | enable_lod_render | Enables or disabled the LOD-rendering. |
◆ set_preintegrated_volume_rendering()
| virtual void nv::index::ISparse_volume_rendering_properties::set_preintegrated_volume_rendering |
( |
bool |
enable | ) |
|
|
pure virtual |
Enable or disable pre-integrated volume rendering for a sparse volume scene element (ISparse_volume_scene_element).
Per default this is disabled.
- Parameters
-
| [in] | enable | Enables the pre-integrated volume rendering technique if (true) otherwise the technique will be disabled (false). |
◆ set_reference_sampling_distance()
| virtual void nv::index::ISparse_volume_rendering_properties::set_reference_sampling_distance |
( |
mi::Float32 |
s | ) |
|
|
pure virtual |
Set the reference sampling distance used for a sparse volume scene element (ISparse_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] | s | Sampling distance (default value is 1.0f). |
◆ set_sampling_distance()
| virtual void nv::index::ISparse_volume_rendering_properties::set_sampling_distance |
( |
mi::Float32 |
sample_dist | ) |
|
|
pure virtual |
Set the sampling distance used for a sparse volume scene element (ISparse_volume_scene_element).
The default value used is 1.0f.
- Parameters
-
| [in] | sample_dist | Sampling distance (default value is 1.0f). |
◆ set_voxel_offsets()
| virtual void nv::index::ISparse_volume_rendering_properties::set_voxel_offsets |
( |
const mi::math::Vector_struct< mi::Float32, 3 > & |
voxel_offsets | ) |
|
|
pure virtual |
Set the voxel offsets used for a sparse volume scene element (ISparse_volume_scene_element).
The default values used are (0.0, 0.0, 0.0). The input values are limited to the range [0.0, 0.5].
- Parameters
-
| [in] | voxel_offsets | Voxel offsets (default value is (0.0, 0.0, 0.0)); |
The documentation for this class was generated from the following file:
