Renders maximum intensity projections of volume geometries in the scene. More...

#include <MIPStage.hpp>

Inheritance diagram for LibCarna::presets::MIPStage:

Collaboration diagram for LibCarna::presets::MIPStage:

Public Member Functions
	MIPStage (unsigned int geometryType, unsigned int colorMapResolution=base::ColorMap::DEFAULT_RESOLUTION)
	Instantiates.

virtual	~MIPStage ()
	Deletes.

virtual void	reshape (base::FrameRenderer &fr, unsigned int width, unsigned int height) override
	Orders this stage to reshape its buffers according to the specified width and height.

virtual void	renderPass (const base::math::Matrix4f &viewTransform, base::RenderTask &rt, const base::Viewport &vp) override
	Triggers the volume rendering.

Public Member Functions inherited from LibCarna::presets::VolumeRenderingStage
	VolumeRenderingStage (unsigned int geometryType)
	Instantiates. The created stage will render such base::Geometry scene graph nodes, whose geometry types equal geometryType.

virtual	~VolumeRenderingStage ()
	Deletes.

void	setSampleRate (unsigned int sampleRate)
	Sets number of slices to be rendered per segment.

unsigned int	sampleRate () const
	Tells number of slices to be rendered per segment.

Public Member Functions inherited from LibCarna::base::GeometryStage< base::Renderable::BackToFront >
	GeometryStage (unsigned int geometryType, unsigned int geometryTypeMask=RenderQueue< base::Renderable::BackToFront >::EXACT_MATCH_GEOMETRY_TYPE_MASK)
	Instantiates s.t. the predefined rendering queue enqueues such LibCarna::base::Geometry scene graph nodes, whose geometry type AND-linked with geometryTypeMask equals the geometryType specified here.

virtual	~GeometryStage ()
	Releases acquired video resources.

virtual void	prepareFrame (Node &root) override
	Called once before each frame.

std::size_t	renderedPassesCount () const
	Tells the number of passes rendered so far since the beginning of the current frame.

GeometryFeatureType::ManagedInterface &	videoResource (GeometryFeatureType &geometryFeature) const
	Interfaces the geometryFeature video resources that were acquired by this rendering stage.

const GeometryFeatureType::ManagedInterface &	videoResource (const GeometryFeatureType &geometryFeature) const

Public Member Functions inherited from LibCarna::base::RenderStage
	RenderStage ()
	Instantiates in enabled-state.

virtual	~RenderStage ()
	Deletes.

void	setViewTransformFixed (bool viewTransformFixed)
	Sets whether the view transform is pass-invariant for the duration of a single frame.

bool	isViewTransformFixed () const
	Tells whether the view transform is pass-invariant for the duration of a single frame.

bool	isInitialized () const
	Tells whether this stage is ready for rendering.

bool	isEnabled () const
	Tells whether this stage is enabled. Disabled stages are not rendered by render tasks.

void	setEnabled (bool)
	Sets whether this stage is enabled. Disabled stages are not rendered by render tasks.

base::FrameRenderer &	renderer ()
	References the renderer this stage belongs to.

const base::FrameRenderer &	renderer () const

void	addRenderStageListener (RenderStageListener &listener)
	Adds listener to the set of listeners this instance notifies in \(\mathcal O\left(\log n\right)\).

void	removeRenderStageListener (RenderStageListener &listener)
	Removes listener from the set of listeners this instance notifies in \(\mathcal O\left(\log n\right)\).

Public Attributes
base::ColorMap	colorMap
	The color map used for the rendering.

Public Attributes inherited from LibCarna::base::GeometryStage< base::Renderable::BackToFront >
const unsigned int	geometryType
	Renders such geometries whose type AND-linked with geometryTypeMask equals this.

const unsigned int	geometryTypeMask
	Renders such geometries whose type AND-linked with this equals geometryType.

Static Public Attributes
static const unsigned int	ROLE_INTENSITIES = 0
	Holds the role that intensity volume data is expected to take when attached to base::Geometry nodes.

Static Public Attributes inherited from LibCarna::presets::VolumeRenderingStage
static const unsigned int	DEFAULT_SAMPLE_RATE = 200
	Holds the default number of slices rendered per segment.

Protected Member Functions
virtual unsigned int	loadVideoResources () override
	Loads video resources when rendering is triggered for the first time. Override this method if you need any additional resources to be loaded, but always call the base implementation.

virtual void	createVolumeSamplers (const std::function< void(unsigned int, base::Sampler *) > &registerSampler) override
	Creates texture samplers for volume textures and uses registerSampler to assign them to the roles that they should be used with.

virtual const base::ShaderProgram &	acquireShader () override
	Acquires the shader from the base::ShaderManager, that is to be used for rendering the slices.

virtual const std::string &	uniformName (unsigned int role) const override
	Tells the name of the uniform variable, that the role texture is to be bound to. Use configureShader for custom shader configuration that goes beyond that.

virtual void	configureShader () override
	Does nothing.

virtual void	configureShader (const base::Renderable &) override
	Does nothing.

Protected Member Functions inherited from LibCarna::presets::VolumeRenderingStage
virtual void	render (const base::Renderable &) override
	Renders the renderable.

Protected Member Functions inherited from LibCarna::base::GeometryStage< base::Renderable::BackToFront >
void	activateGLContext () const
	Ensures that the OpenGL context of the hosting LibCarna::base::FrameRenderer is the current one.

virtual void	buildRenderQueues (Node &root, const math::Matrix4f &viewTransform)
	Builds the rendering queues of this stage.

virtual void	rewindRenderQueues ()
	Rewinds the rendering queues of this stage.

virtual void	updateRenderQueues (const math::Matrix4f &viewTransform)
	Recomputes the model-view transforms of the renderables enqueued by this stage.

Additional Inherited Members
Protected Attributes inherited from LibCarna::base::GeometryStage< base::Renderable::BackToFront >
RenderQueue< base::Renderable::BackToFront >	rq
	Holds the predefined rendering queue of this rendering stage.

Detailed Description

Renders maximum intensity projections of volume geometries in the scene.

Basics

The MIPStage constructor takes a geometry type parameter:

    mip = new presets::MIPStage( GEOMETRY_TYPE_VOLUMETRIC );
    mip->colorMap.writeLinearSegment(
        0, 1,
        base::Color( 0, 0, 255, 255 ), base::Color( 255, 0, 0, 255 )
    );
    renderer->appendStage( mip );

exemplary rendering with a linearly transitioning blue-to-red color map

The concept of geometry types is explained here.

Note: In the rendering process this stage will usually be inserted after such stages that render opaque geometry, like CuttingPlanesStage and OpaqueRenderingStage.

More complex color maps can easily be generated using the base::ColorMap::writeLinearSpline function:

    std::vector< base::Color > colors =
        { base::Color(   0,   0, 255,   0 )
        , base::Color(   0,   0, 255, 255 )
        , base::Color(   0, 255, 255, 255 )
        , base::Color( 255, 255,   0, 255 )
        , base::Color( 255,   0,   0, 255 ) };
    mip->colorMap.writeLinearSpline( colors );

exemplary rendering with a "jet"-like color map

Author: Leonid Kostrykin

Definition at line 66 of file MIPStage.hpp.

Member Function Documentation

◆ acquireShader()

virtual const base::ShaderProgram & LibCarna::presets::MIPStage::acquireShader ( )

overrideprotectedvirtual

Acquires the shader from the base::ShaderManager, that is to be used for rendering the slices.

Implements LibCarna::presets::VolumeRenderingStage.

◆ configureShader() [1/2]

virtual void LibCarna::presets::MIPStage::configureShader ( )

overrideprotectedvirtual

Does nothing.

Implements LibCarna::presets::VolumeRenderingStage.

◆ configureShader() [2/2]

virtual void LibCarna::presets::MIPStage::configureShader ( const base::Renderable & )

overrideprotectedvirtual

Does nothing.

Implements LibCarna::presets::VolumeRenderingStage.

◆ createVolumeSamplers()

virtual void LibCarna::presets::MIPStage::createVolumeSamplers ( const std::function< void(unsigned int, base::Sampler *) > & registerSampler )

overrideprotectedvirtual

Creates texture samplers for volume textures and uses registerSampler to assign them to the roles that they should be used with.

Implements LibCarna::presets::VolumeRenderingStage.

◆ loadVideoResources()

virtual unsigned int LibCarna::presets::MIPStage::loadVideoResources ( )

overrideprotectedvirtual

Loads video resources when rendering is triggered for the first time. Override this method if you need any additional resources to be loaded, but always call the base implementation.

Returns: the first texture unit to use for volume textures. The dafault implementation returns base::Texture<0>::SETUP_UNIT +1.

Reimplemented from LibCarna::presets::VolumeRenderingStage.

◆ renderPass()

virtual void LibCarna::presets::MIPStage::renderPass	(	const base::math::Matrix4f &	viewTransform,
		base::RenderTask &	rt,
		const base::Viewport &	vp
	)

overridevirtual

Triggers the volume rendering.

Reimplemented from LibCarna::presets::VolumeRenderingStage.

◆ reshape()

virtual void LibCarna::presets::MIPStage::reshape	(	base::FrameRenderer &	fr,
		unsigned int	width,
		unsigned int	height
	)

overridevirtual

Orders this stage to reshape its buffers according to the specified width and height.

Attention: Always call the base implementaion!

Parameters

fr	references the frame renderer this stage belongs to.
width	is the root viewport width.
height	is the root viewport height.

Reimplemented from LibCarna::base::RenderStage.

◆ uniformName()

virtual const std::string & LibCarna::presets::MIPStage::uniformName ( unsigned int role ) const

overrideprotectedvirtual

Tells the name of the uniform variable, that the role texture is to be bound to. Use configureShader for custom shader configuration that goes beyond that.

Implements LibCarna::presets::VolumeRenderingStage.

Member Data Documentation

◆ colorMap

base::ColorMap LibCarna::presets::MIPStage::colorMap

The color map used for the rendering.

Definition at line 93 of file MIPStage.hpp.

◆ ROLE_INTENSITIES

const unsigned int LibCarna::presets::MIPStage::ROLE_INTENSITIES = 0

static

Holds the role that intensity volume data is expected to take when attached to base::Geometry nodes.

Definition at line 78 of file MIPStage.hpp.

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

include/LibCarna/presets/MIPStage.hpp

Public Member Functions

Public Attributes

Static Public Attributes

Protected Member Functions

Additional Inherited Members

Detailed Description

Basics

Member Function Documentation

◆ acquireShader()

◆ configureShader() [1/2]

◆ configureShader() [2/2]

◆ createVolumeSamplers()

◆ loadVideoResources()

◆ renderPass()

◆ reshape()

◆ uniformName()

Member Data Documentation

◆ colorMap

◆ ROLE_INTENSITIES