mitk::ROIMapper2D Class Reference

VTK-based mapper for rendering ROI elements in 2D slice views. More...

#include <mitkROIMapper2D.h>

Inheritance diagram for mitk::ROIMapper2D:

Collaboration diagram for mitk::ROIMapper2D:

Public Member Functions
	mitkClassMacro (ROIMapper2D, VtkMapper) static Pointer New()
vtkProp *	GetVtkProp (mitk::BaseRenderer *renderer) override
	Get the VTK prop assembly for the given renderer. More...
Public Member Functions inherited from mitk::VtkMapper
	mitkClassMacro (VtkMapper, Mapper)
void	MitkRender (mitk::BaseRenderer *renderer, mitk::VtkPropRenderer::RenderType type) override
	Determine the render pass type and call the appropriate render method. More...
virtual void	MitkRenderOverlay (BaseRenderer *renderer)
	Check visibility and render the overlay pass. More...
virtual void	MitkRenderOpaqueGeometry (BaseRenderer *renderer)
	Check visibility and render opaque (untransparent) geometry. More...
virtual void	MitkRenderTranslucentGeometry (BaseRenderer *renderer)
	Check visibility and render translucent (transparent) geometry. More...
virtual void	MitkRenderVolumetricGeometry (BaseRenderer *renderer)
	Check visibility and render volumetric geometry. More...
virtual bool	HasVtkProp (const vtkProp *prop, BaseRenderer *renderer)
	Check whether this mapper owns the specified vtkProp for the given renderer. More...
virtual void	UpdateVtkTransform (mitk::BaseRenderer *renderer)
	Set the vtkTransform of the m_Prop3D for the current time step of renderer. More...
virtual void	ReleaseGraphicsResources (mitk::BaseRenderer *)
	Release VTK-based graphics resources consumed by this mapper. More...
Public Member Functions inherited from mitk::Mapper
	mitkClassMacroItkParent (Mapper, itk::Object)
virtual void	SetDataNode (DataNode *_arg)
	Set the DataNode containing the data to map. More...
virtual DataNode *	GetDataNode () const
	Get the DataNode containing the data to map. More...
virtual void	Update (BaseRenderer *renderer)
	Calculate the time step for the current renderer and generate rendering data. More...
TimeStepType	GetTimestep () const
	Return the current time step as calculated from the renderer. More...
virtual bool	IsLODEnabled (BaseRenderer *) const
	Return whether this Mapper currently allows for Level-of-Detail rendering. More...

Static Public Member Functions
static void	SetDefaultProperties (DataNode *node, BaseRenderer *renderer=nullptr, bool override=false)
	Initialize default properties on the given data node for 2D ROI rendering. More...
Static Public Member Functions inherited from mitk::Mapper
static void	SetDefaultProperties (DataNode *node, BaseRenderer *renderer=nullptr, bool overwrite=false)
	Set default values of properties used by this mapper on the given node. More...

Protected Member Functions
	ROIMapper2D ()
	~ROIMapper2D () override
void	GenerateDataForRenderer (BaseRenderer *renderer) override
	Generate the data needed for rendering into renderer. More...
void	ApplyColorAndOpacityProperties (BaseRenderer *renderer, vtkActor *actor) override
	Apply color and opacity properties read from the PropertyList to the given vtkActor. More...
Protected Member Functions inherited from mitk::VtkMapper
	VtkMapper ()
	~VtkMapper () override
Protected Member Functions inherited from mitk::Mapper
	Mapper ()
	explicit constructor which disallows implicit conversions More...
	~Mapper () override
	virtual destructor in order to derive from this class More...
virtual void	CalculateTimeStep (BaseRenderer *renderer)
	Updates the time step, which is sometimes needed in subclasses. More...
virtual void	ResetMapper (BaseRenderer *)
	Reset the mapper (i.e., make sure that nothing is displayed) if no valid data is present. In most cases the reimplemented function disables the according actors (toggling visibility off) More...

Additional Inherited Members
Protected Attributes inherited from mitk::Mapper
mitk::DataNode *	m_DataNode

Detailed Description

VTK-based mapper for rendering ROI elements in 2D slice views.

This mapper renders each ROI element as the intersection of its axis-aligned bounding box (cube) with the current slice plane. The intersection is computed using a plane cutter on the transformed cube geometry. Optional captions are displayed at the bottom-left corner of each slice intersection.

Supported data node properties for caption rendering:

• caption (StringProperty): Caption template with placeholder support
• font.size (IntProperty): Font size in points
• font.bold (BoolProperty): Bold font style
• font.italic (BoolProperty): Italic font style

See also

ROI, ROIMapper3D, ROIMapperLocalStorage

Definition at line 39 of file mitkROIMapper2D.h.

Constructor & Destructor Documentation

ROIMapper2D()

mitk::ROIMapper2D::ROIMapper2D ( )

protected

~ROIMapper2D()

mitk::ROIMapper2D::~ROIMapper2D ( )

overrideprotected

Member Function Documentation

ApplyColorAndOpacityProperties()

void mitk::ROIMapper2D::ApplyColorAndOpacityProperties ( BaseRenderer *  renderer, vtkActor *  actor  )

overrideprotectedvirtual

Apply color and opacity properties read from the PropertyList to the given vtkActor.

Reads the "color" and "opacity" properties from the DataNode and applies them to the actor's vtkProperty.

Parameters

[in]	renderer	The renderer whose property list is queried.
[in]	actor	The vtkActor to apply color and opacity to.

Reimplemented from mitk::VtkMapper.

GenerateDataForRenderer()

void mitk::ROIMapper2D::GenerateDataForRenderer ( BaseRenderer *  )

overrideprotectedvirtual

Generate the data needed for rendering into renderer.

Reimplemented from mitk::Mapper.

GetVtkProp()

vtkProp* mitk::ROIMapper2D::GetVtkProp ( mitk::BaseRenderer *  renderer )

overridevirtual

Get the VTK prop assembly for the given renderer.

Parameters

[in]

renderer

The renderer to get the prop for.

Returns

The VTK prop assembly containing all rendered ROI elements.

Implements mitk::VtkMapper.

mitkClassMacro()

mitk::ROIMapper2D::mitkClassMacro	(	ROIMapper2D	,
		VtkMapper
	)

SetDefaultProperties()

static void mitk::ROIMapper2D::SetDefaultProperties ( DataNode *  node, BaseRenderer *  renderer = nullptr, bool  override = false  )

static

Initialize default properties on the given data node for 2D ROI rendering.

Parameters

[in]	node	The data node to initialize properties on.
[in]	renderer	The renderer context, or nullptr for the default context.
[in]	override	If true, overwrite existing properties.

---

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

• mitkROIMapper2D.h