Loading [MathJax]/extensions/tex2jax.js
Carna  Version 3.3.2
All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Macros Pages
Public Member Functions | Public Attributes | Static Public Attributes | Protected Member Functions | List of all members
Carna::presets::MaskRenderingStage Class Reference

Renders 3D masks. More...

#include <MaskRenderingStage.h>

+ Inheritance diagram for Carna::presets::MaskRenderingStage:
+ Collaboration diagram for Carna::presets::MaskRenderingStage:

Public Member Functions

 MaskRenderingStage (unsigned int geometryType, unsigned int maskRole=DEFAULT_ROLE_MASK)
 Instantiates. More...
 
virtual ~MaskRenderingStage ()
 Deletes.
 
MaskRenderingStageclone () const override
 Returns same RenderStage implementation with same configuration. More...
 
virtual void reshape (base::FrameRenderer &fr, unsigned int width, unsigned int height) override
 Orders this stage to reshape its buffers according to the specified dimensions. More...
 
virtual void renderPass (const base::math::Matrix4f &viewTransform, base::RenderTask &rt, const base::Viewport &vp) override
 Performs the mask rendering.
 
const base::Colorcolor () const
 Tells the rendering color.
 
void setColor (const base::Color &color)
 Sets the rendering color.
 
bool renderBorders () const
 Tells whether borders are rendered instead of regions.
 
void setRenderBorders (bool borders)
 Sets whether to render borders instead of regions.
 
- Public Member Functions inherited from Carna::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. More...
 
unsigned int sampleRate () const
 Tells number of slices to be rendered per segment. More...
 
- Public Member Functions inherited from Carna::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 Carna::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. More...
 
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 Carna::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. More...
 
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. More...
 
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::FrameRendererrenderer ()
 References the renderer this stage belongs to. More...
 
const base::FrameRendererrenderer () 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

const unsigned int maskRole
 Holds the role that mask volume data is expected to take when attached to base::Geometry nodes.
 
- Public Attributes inherited from Carna::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 base::Color DEFAULT_COLOR
 Holds the default rendering color.
 
static const unsigned int DEFAULT_ROLE_MASK
 Holds the default value of maskRole.
 
- Static Public Attributes inherited from Carna::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. More...
 
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::ShaderProgramacquireShader () override
 Acquires the mask_rendering shader from the base::ShaderManager.
 
virtual const std::string & uniformName (unsigned int role) const override
 Maps maskRole to mask.
 
virtual void configureShader () override
 Sets the border rendering mode and the rendering color.
 
virtual void configureShader (const base::Renderable &) override
 Does nothing.
 
- Protected Member Functions inherited from Carna::presets::VolumeRenderingStage
virtual void render (const base::Renderable &) override
 Renders the renderable.
 
- Protected Member Functions inherited from Carna::base::GeometryStage< base::Renderable::BackToFront >
void activateGLContext () const
 Ensures that the OpenGL context of the hosting Carna::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 Carna::base::GeometryStage< base::Renderable::BackToFront >
RenderQueue< base::Renderable::BackToFrontrq
 Holds the predefined rendering queue of this rendering stage.
 

Detailed Description

Renders 3D masks.

The MaskRenderingStage constructor takes a geometry type parameter:

mr = new presets::MaskRenderingStage( GEOMETRY_TYPE_VOLUMETRIC );

The concept of geometry types is explained here.

Note
In the rendering process this stage will usually be inserted as the last stage.

A mask can be produced, for example, by threshold a 3D intensity image:

mask.reset( new base::IntensityVolumeUInt8( scene->volume().size ) );
for( std::size_t pos = 0; pos < mask->buffer().size(); ++pos )
{
mask->buffer()[ pos ] = scene->volume().buffer()[ pos ] > 48000 ? 255 : 0;
}
base::BufferedVectorFieldTexture< base::IntensityVolumeUInt8 >& maskTexture

The mask can then be attached to, for example, an already existing geometry node:

geometry.putFeature( mr->maskRole, maskTexture );
maskTexture.release();

This will render an image similar to this:

MaskRenderingStageTest.png
exemplary rendering from code above
Author
Leonid Kostrykin
Date
June 2021
Since
API Version 3.3.0

Definition at line 59 of file MaskRenderingStage.h.

Constructor & Destructor Documentation

◆ MaskRenderingStage()

Carna::presets::MaskRenderingStage::MaskRenderingStage ( unsigned int  geometryType,
unsigned int  maskRole = DEFAULT_ROLE_MASK 
)
explicit

Instantiates.

The created stage will render such base::Geometry scene graph nodes, whose geometry types equal geometryType. The mask data will be obtained from maskRole.

Member Function Documentation

◆ clone()

MaskRenderingStage* Carna::presets::MaskRenderingStage::clone ( ) const
overridevirtual

Returns same RenderStage implementation with same configuration.

The listeners and the rendering state are not copied.

Deprecated:
Do not use this method. It will be removed shortly.

Implements Carna::base::RenderStage.

◆ loadVideoResources()

virtual unsigned int Carna::presets::MaskRenderingStage::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 Carna::presets::VolumeRenderingStage.

◆ reshape()

virtual void Carna::presets::MaskRenderingStage::reshape ( base::FrameRenderer fr,
unsigned int  width,
unsigned int  height 
)
overridevirtual

Orders this stage to reshape its buffers according to the specified dimensions.

Attention
Always call the base implementaion!
Parameters
frreferences the frame renderer this stage belongs to.
widthis the root viewport width.
heightis the root viewport height.

Reimplemented from Carna::base::RenderStage.


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