Diagnostic rendering properties for irregular volumes.
More...
#include <iirregular_volume_rendering_properties.h>
Inherits mi::base::Interface_declare< 0x72327639, ... >.
Diagnostic rendering properties for irregular volumes.
◆ get_diagnostics_flags()
| virtual mi::Uint32 nv::index::IIrregular_volume_rendering_properties::get_diagnostics_flags |
( |
| ) |
const |
|
pure virtual |
Get bit flags to enable various diagnostics (internal).
- Returns
- The bit flags currently set.
◆ get_diagnostics_mode()
| virtual mi::Uint32 nv::index::IIrregular_volume_rendering_properties::get_diagnostics_mode |
( |
| ) |
const |
|
pure virtual |
Get diagnostic rendering mode.
- Returns
- Returns the diagnostic rendering is performed instead of normal rendering (1:wireframe, 2:run path) or 0 otherwise.
◆ get_halo_size()
| virtual mi::Float32 nv::index::IIrregular_volume_rendering_properties::get_halo_size |
( |
| ) |
const |
|
pure virtual |
Get default subregion halo size, in object space.
Subregions are expanded by the halo size for data loading. Similar to subcube_border_size, it enables filtering and it defines the step size limit for discrete volume sampling.
- Returns
- Returns the halo size.
◆ get_sampling_mode()
| virtual mi::Uint32 nv::index::IIrregular_volume_rendering_properties::get_sampling_mode |
( |
| ) |
const |
|
pure virtual |
Get render sampling mode (0 = preintegrated colormap; 1 = discrete sampling)
- Returns
- Returns the render sampling mode.
◆ get_sampling_reference_segment_length()
| virtual mi::Float32 nv::index::IIrregular_volume_rendering_properties::get_sampling_reference_segment_length |
( |
| ) |
const |
|
pure virtual |
Get reference length of discrete sampling segment length on ray.
- Returns
- Returns the reference length.
◆ get_sampling_segment_length()
| virtual mi::Float32 nv::index::IIrregular_volume_rendering_properties::get_sampling_segment_length |
( |
| ) |
const |
|
pure virtual |
Get length of discrete sampling segment length on ray.
Should be less than subregion halo size to avoid artifacts.
- Returns
- Returns the segment length.
◆ get_wireframe_color_mod_begin()
| virtual mi::Float32 nv::index::IIrregular_volume_rendering_properties::get_wireframe_color_mod_begin |
( |
| ) |
const |
|
pure virtual |
Get distance from camera where color modulation starts.
- Returns
- Returns the distance value.
◆ get_wireframe_color_mod_factor()
| virtual mi::Float32 nv::index::IIrregular_volume_rendering_properties::get_wireframe_color_mod_factor |
( |
| ) |
const |
|
pure virtual |
Get distance factor.
Distance is multiplied by factor for color modulation. 0 disables color modulation.
- Returns
- Returns the color modulation factor.
◆ get_wireframe_size()
| virtual mi::Float32 nv::index::IIrregular_volume_rendering_properties::get_wireframe_size |
( |
| ) |
const |
|
pure virtual |
Get world space size of wireframe mode lines.
- Returns
- Returns the width of the wire frame lines.
◆ set_diagnostics_flags()
| virtual void nv::index::IIrregular_volume_rendering_properties::set_diagnostics_flags |
( |
mi::Uint32 |
f | ) |
|
|
pure virtual |
Set bit flags to enable various diagnostics (internal).
- Parameters
-
| [in] | f | Flags for diagnostic rendering. |
◆ set_diagnostics_mode()
| virtual void nv::index::IIrregular_volume_rendering_properties::set_diagnostics_mode |
( |
mi::Uint32 |
m | ) |
|
|
pure virtual |
Get diagnostic rendering mode.
- Parameters
-
| [in] | m | Set the diagnostic rendering mode (0: no diagnostics, 1: wireframe, 2: run path) |
◆ set_halo_size()
| virtual void nv::index::IIrregular_volume_rendering_properties::set_halo_size |
( |
mi::Float32 |
f | ) |
|
|
pure virtual |
Set default subregion halo size, in object space.
- Parameters
-
| [in] | f | The size of the halo. |
◆ set_sampling_mode()
| virtual void nv::index::IIrregular_volume_rendering_properties::set_sampling_mode |
( |
mi::Uint32 |
m | ) |
|
|
pure virtual |
Set render sampling mode (0 = preintegrated colormap; 1 = discrete sampling)
- Parameters
-
| [in] | m | Render sampling mode. |
◆ set_sampling_reference_segment_length()
| virtual void nv::index::IIrregular_volume_rendering_properties::set_sampling_reference_segment_length |
( |
mi::Float32 |
l | ) |
|
|
pure virtual |
Set reference length of discrete sampling segment length on ray.
- Parameters
-
| [in] | l | The reference length. |
◆ set_sampling_segment_length()
| virtual void nv::index::IIrregular_volume_rendering_properties::set_sampling_segment_length |
( |
mi::Float32 |
l | ) |
|
|
pure virtual |
Set length of discrete sampling segment length on ray.
- Parameters
-
◆ set_wireframe_color_mod_begin()
| virtual void nv::index::IIrregular_volume_rendering_properties::set_wireframe_color_mod_begin |
( |
mi::Float32 |
f | ) |
|
|
pure virtual |
Set distance from camera where color modulation starts.
- Parameters
-
◆ set_wireframe_color_mod_factor()
| virtual void nv::index::IIrregular_volume_rendering_properties::set_wireframe_color_mod_factor |
( |
mi::Float32 |
f | ) |
|
|
pure virtual |
Set distance factor.
Distance is multiplied by factor for color modulation. 0 disables color modulation.
- Parameters
-
| [in] | f | The color modulation factor. |
◆ set_wireframe_size()
| virtual void nv::index::IIrregular_volume_rendering_properties::set_wireframe_size |
( |
mi::Float32 |
s | ) |
|
|
pure virtual |
Set world space size of wireframe mode lines.
- Parameters
-
| [in] | s | Sets the width of the wire frame lines. |
The documentation for this class was generated from the following file:
