#include <ImFusion/GL/GlVolumeRendererBasic.h>

Basic implementation of a direct volume renderer that supports different compositing modes. More...

Inheritance diagram for GlVolumeRendererBasic:

Detailed Description

Basic implementation of a direct volume renderer that supports different compositing modes.

In DVR mode this renderer exhibits only local illumination implementing Phong shading. Besides classic shaded and unshaded DVR compositing, this renderer also supports iso-surface rendering, Maximum Intensity Projection, as well as Digitally Reconstructed Radiograph modes.

The current implementation supports rendering multiple volumes at the same time, as well as masks and deformations.

This renderer can also be run on legacy OpenGL 2.1 hardware.

See also: ImageView3D, GlVolumeView

Classes
struct	OpacityPeelingParameters
	Record of parameters for configuring Opacity Peeling in the GlVolumeRendererBasic. More...

Public Types
enum	RenderMode { DRR , MIP , ISO , VRT , VRT_SHADED , BLANK }
	Supported rendering modes. More...

Public Member Functions
	GlVolumeRendererBasic (RenderMode mode=DRR)
	Create the renderer, optionally specifying the mode and a custom fragment program.

	~GlVolumeRendererBasic () override
	Destructor.

std::string	name () const override
	Returns the name for identification/GUI usage of this volume renderer.

void	render (const GL::ViewState &viewState, const RenderTextures &renderTextures) override
	Renders the data in the given configuration.

SharedImageSet *	imageData () const override
	Returns the first SharedImageSet that is rendered by this GlVolumeRenderer.

vec3	center () const override
	Returns the center in world coordinates of the first shown data.

bool	supportsDeformations () const override
	Returns whether this renderer supports showing Deformations attached to images.

void	configuration (Properties *p) const override
	Serialize the current object configuration into the given Properties object.

void	configure (const Properties *p) override
	Configure this object instance by de-serializing the given Properties.

RenderMode	mode () const
	Returns the volume rendering mode.

void	setMode (RenderMode mode)
	Sets the volume rendering mode (and hence one of the pre-defined shaders)

float	ambientAttenuationDistance () const
	Returns the ambient illumination attenuation distance fall-off. No attenuation if <= 0..

void	setAmbientAttenuationDistance (float value)
	Sets the ambient illumination attenuation distance fall-off. No attenuation if <= 0..

void	setIsoModulation (double distance)
	View-distance based modulation for 2 iso-layers.

OpacityPeelingParameters	opacityPeeling () const
	Returns the flag whether to enable Opacity Peeling.

void	setOpacityPeeling (OpacityPeelingParameters value)
	Sets the flag whether to enable Opacity Peeling.

void	setUseOctree (bool value)
	Configures whether to use an octree to accelerate rendering.

void	setRandomizeRayOffset (bool value)
	Set whether to randomize ray start positions to mitigate ring artifacts.

Public Member Functions inherited from GlVolumeRenderer
virtual void	setData (const std::vector< std::pair< const SharedImageSet , const DisplayOptions3d > > &data)
	Sets the data to render paired with the display options to use.

std::vector< std::pair< const SharedImageSet , const DisplayOptions3d > >	data () const
	Return the list of shown data paired with the DisplayOptions to use.

virtual bool	dirty () const
	Returns whether the scene is dirty (i.e. re-rendering is required).

virtual bool	supportsOITIntegration () const
	Returns whether this renderer supports the order-independent integration of semi-transparent scene geometry.

bool	showsDeformations () const
	Returns the flag whether to evaluate deformation fields of volumes during rendering if supported.

void	setShowDeformations (bool value)
	Sets the flag whether to evaluate deformation fields of volumes during rendering if supported.

bool	lod () const
	Returns the flag whether low LOD mode is enabled (half output render size, half sampling rate).

virtual void	setLod (bool value)
	Sets the flag whether low LOD mode is enabled (half output render size, half sampling rate).

float	samplesPerVoxel () const
	Returns the number of ray casting samples to use per smallest voxel length.

void	setSamplesPerVoxel (float value)
	Sets the number of ray casting samples to use per smallest voxel length.

void	setClipPlane (std::optional< Geometry::Plane > clipPlane)
	Sets an optional clip plane so that parts on the back (opposite the direction of the normal vector) are clipped.

void	setMaxVolumesToDisplay (int value)
	Sets the maximum number of volumes to display.

Public Member Functions inherited from SignalReceiver
	SignalReceiver ()=default
	Default constructor.

	SignalReceiver (const SignalReceiver &other)
	Copy constructor, does not copy any existing signal connections from other.

SignalReceiver &	operator= (SignalReceiver rhs)
	Assignment operator, disconnects all existing connections, does not copy any existing signal connections from rhs.

virtual	~SignalReceiver ()
	Virtual destructor disconnects from all connected signals.

Public Member Functions inherited from Configurable
virtual void	configureDefaults ()
	Retrieve the properties of this object, replaces values with their defaults and sets it again.

void	registerParameter (ParameterBase *param)
	Register the given Parameter or SubProperty, so that it will be configured during configure()/configuration().

void	unregisterParameter (const ParameterBase *param)
	Remove the given Parameter or SubProperty from the list of registered parameters.

	Configurable (const Configurable &rhs)

	Configurable (Configurable &&rhs) noexcept

Configurable &	operator= (const Configurable &)

Configurable &	operator= (Configurable &&) noexcept

Additional Inherited Members
Public Attributes inherited from Configurable
Signal	signalParametersChanged
	Emitted whenever one of the registered Parameters' or SubPropertys' `signalValueChanged` signal was emitted.

Protected Member Functions inherited from GlVolumeRenderer
virtual void	markDirty ()
	Set the dirty flag so that the scene is re-rendered from scratch next time.

virtual void	onTransformationChanged (const Data *sis)
	Called when the transformation of one of the rendered images has changed.

void	onDeformationEvent (const DeformationEvent &event)
	Called when a Deformation object attached to the SharedImage has changed its state.

Protected Member Functions inherited from SignalReceiver
void	disconnectAll ()
	Disconnects all existing connections.

Protected Attributes inherited from GlVolumeRenderer
std::vector< std::pair< const SharedImageSet , const DisplayOptions3d > >	m_currentData

std::vector< std::shared_ptr< SignalConnection > >	m_temporarySlots
	signal connections created for the set of currently shown images

std::unique_ptr< GL::Framebuffer >	m_fbo
	FBO used during rendering.

bool	m_dirty = true

bool	m_showDeformations = false
	Flag whether to evaluate deformation fields of volumes if supported.

bool	m_lod = false
	Flag whether low LOD mode is enabled (half output render size, half sampling rate)

float	m_samplesPerVoxel = 1.f
	Ray casting samples per smallest voxel length.

std::optional< Geometry::Plane >	m_clipPlane
	Optional clipping plane to use during rendering.

int	m_maxVolumesToDisplay = 4
	Maximum number of volumes to display.

Protected Attributes inherited from Configurable
std::vector< Param >	m_params
	List of all registered Parameter and SubProperty instances.

Member Enumeration Documentation

◆ RenderMode

enum RenderMode

Supported rendering modes.

Enumerator
DRR	Digitally reconstructed radiograph (DRR)
MIP	Maximum intensity projection.
ISO	Iso-surface rendering.
VRT	General volume rendering technique (VRT)
VRT_SHADED	Shaded VRT.
BLANK	No rendering.

Member Function Documentation

◆ name()

std::string name ( ) const

overridevirtual

Returns the name for identification/GUI usage of this volume renderer.

Implements GlVolumeRenderer.

◆ render()

void render	(	const GL::ViewState &	viewState,
		const RenderTextures &	renderTextures )

overridevirtual

Renders the data in the given configuration.

Parameters

viewState	OpenGL state describing projection and model-view matrix to use for rendering
renderTextures	Struct holding all the render textures to use

Note: The dimensions of all provided textures must be equivalent.

Implements GlVolumeRenderer.

◆ imageData()

SharedImageSet * imageData ( ) const

overridevirtual

Returns the first SharedImageSet that is rendered by this GlVolumeRenderer.

Note: This is merely a low-level convenience function. Please use GlVolumeRenderer::data() or ImageView3D::visibleData() on the parent view in order to get all shown data.

Implements GlVolumeRenderer.

◆ center()

vec3 center ( ) const

overridevirtual

Returns the center in world coordinates of the first shown data.

Implements GlVolumeRenderer.

◆ supportsDeformations()

bool supportsDeformations ( ) const

overridevirtual

Returns whether this renderer supports showing Deformations attached to images.

The default implementation returns false.

See also: setShowDeformations()

Reimplemented from GlVolumeRenderer.

◆ configuration()

void configuration ( Properties * p ) const

overridevirtual

Serialize the current object configuration into the given Properties object.

The default implementation will do so automatically for all registered Parameter and SubProperty instances.

See also: configure() for the inverse functionality

Reimplemented from GlVolumeRenderer.

◆ configure()

void configure ( const Properties * p )

overridevirtual

Configure this object instance by de-serializing the given Properties.

The default implementation will do so automatically for all registered Parameter and SubProperty instances.

See also: configuration() for the inverse functionality

Reimplemented from GlVolumeRenderer.

The documentation for this class was generated from the following file:

ImFusion/GL/GlVolumeRendererBasic.h

Detailed Description

Classes

Public Types

Public Member Functions

Additional Inherited Members

Member Enumeration Documentation

◆ RenderMode

Member Function Documentation

◆ name()

◆ render()

◆ imageData()

◆ center()

◆ supportsDeformations()

◆ configuration()

◆ configure()