Base class of all Vtk Mappers in order to display primitives by exploiting Vtk functionality. More...

#include <mitkVtkMapper.h>

Inheritance diagram for mitk::VtkMapper:

[legend]

Collaboration diagram for mitk::VtkMapper:

[legend]

Classes
class	LocalStorage

Public Types
typedef VtkMapper	Self

typedef Mapper	Superclass

typedef itk::SmartPointer< Self >	Pointer

typedef itk::SmartPointer< const Self >	ConstPointer

Public Types inherited from mitk::Mapper
typedef Mapper	Self

typedef itk::Object	Superclass

typedef itk::SmartPointer< Self >	Pointer

typedef itk::SmartPointer< const Self >	ConstPointer

Public Member Functions
virtual std::vector< std::string >	GetClassHierarchy () const override

virtual const char *	GetClassName () const

virtual vtkProp *	GetVtkProp (mitk::BaseRenderer *renderer)=0

virtual bool	IsVtkBased () const override
	Returns whether this is an vtk-based mapper. More...

void	MitkRender (mitk::BaseRenderer *renderer, mitk::VtkPropRenderer::RenderType type) override
	Determines which geometry should be rendered (opaque, translucent, volumetric, overlay) and calls the appropriate function. More...

virtual void	MitkRenderOverlay (BaseRenderer *renderer)
	Checks visibility and renders the overlay. More...

virtual void	MitkRenderOpaqueGeometry (BaseRenderer *renderer)
	Checks visibility and renders untransparent geometry. More...

virtual void	MitkRenderTranslucentGeometry (BaseRenderer *renderer)
	Checks visibility and renders transparent geometry. More...

virtual void	MitkRenderVolumetricGeometry (BaseRenderer *renderer)
	Checks visibility and renders volumes. More...

virtual bool	HasVtkProp (const vtkProp prop, BaseRenderer renderer)
	Returns true if this mapper owns the specified vtkProp for the given BaseRenderer. More...

virtual void	UpdateVtkTransform (mitk::BaseRenderer *renderer)
	Set the vtkTransform of the m_Prop3D for the current time step of renderer. More...

virtual void	ApplyProperties (vtkActor actor, mitk::BaseRenderer renderer)
	Apply color and opacity properties read from the PropertyList. More...

void	ApplyShaderProperties (mitk::BaseRenderer *)

void	ApplyColorAndOpacityProperties (mitk::BaseRenderer renderer, vtkActor actor) override
	Apply color and opacity properties read from the PropertyList. Called by mapper subclasses. More...

virtual void	ReleaseGraphicsResources (mitk::BaseRenderer *)
	Release vtk-based graphics resources that are being consumed by this mapper. More...

Public Member Functions inherited from mitk::Mapper
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. Method only returns valid DataNode Pointer if the mapper belongs to a data node. Otherwise, the returned DataNode Pointer might be invalid. More...

BaseData *	GetData () const
	Get the data to map. More...

virtual bool	GetColor (float rgb[3], BaseRenderer renderer, const char name="color") const
	Convenience access method for color properties (instances of ColorProperty) More...

virtual bool	GetVisibility (bool &visible, BaseRenderer renderer, const char name="visible") const
	Convenience access method for visibility properties (instances of BoolProperty) More...

virtual bool	GetOpacity (float &opacity, BaseRenderer renderer, const char name="opacity") const
	Convenience access method for opacity properties (instances of FloatProperty) More...

virtual bool	GetLevelWindow (LevelWindow &levelWindow, BaseRenderer renderer, const char name="levelwindow") const
	Convenience access method for color properties (instances of LevelWindoProperty) More...

virtual bool	IsVisible (BaseRenderer renderer, const char name="visible") const
	Convenience access method for visibility properties (instances of BoolProperty). Return value is the visibility. Default is visible==true, i.e., true is returned even if the property (propertyKey) is not found. More...

virtual void	Update (BaseRenderer *renderer)
	Calls the time step of the input data for the specified renderer and checks whether the time step is valid and calls method GenerateDataForRenderer() More...

int	GetTimestep () const
	Returns the current time step as calculated from the renderer. More...

virtual bool	IsLODEnabled (BaseRenderer *) const

Static Public Member Functions
static const char *	GetStaticNameOfClass ()

Static Public Member Functions inherited from mitk::Mapper
static const char *	GetStaticNameOfClass ()

static void	SetDefaultProperties (DataNode node, BaseRenderer renderer=nullptr, bool overwrite=false)
	Set default values of properties used by this mapper to node. More...

Protected Member Functions
	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	GenerateData ()
	Generate the data needed for rendering (independent of a specific renderer) More...

virtual void	GenerateDataForRenderer (BaseRenderer *)
	Generate the data needed for rendering into renderer. 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

Base class of all Vtk Mappers in order to display primitives by exploiting Vtk functionality.

Rendering of opaque, translucent or volumetric geometry and overlays is done in consecutive render passes.

Definition at line 47 of file mitkVtkMapper.h.

Member Typedef Documentation

◆ ConstPointer

typedef itk::SmartPointer<const Self> mitk::VtkMapper::ConstPointer

Definition at line 50 of file mitkVtkMapper.h.

◆ Pointer

typedef itk::SmartPointer<Self> mitk::VtkMapper::Pointer

Definition at line 50 of file mitkVtkMapper.h.

◆ Self

typedef VtkMapper mitk::VtkMapper::Self

Definition at line 50 of file mitkVtkMapper.h.

◆ Superclass

typedef Mapper mitk::VtkMapper::Superclass

Definition at line 50 of file mitkVtkMapper.h.

Constructor & Destructor Documentation

◆ VtkMapper()

mitk::VtkMapper::VtkMapper ( )

protected

constructor

◆ ~VtkMapper()

mitk::VtkMapper::~VtkMapper ( )

overrideprotected

virtual destructor in order to derive from this class

Member Function Documentation

◆ ApplyColorAndOpacityProperties()

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

overridevirtual

Apply color and opacity properties read from the PropertyList. Called by mapper subclasses.

Implements mitk::Mapper.

Reimplemented in mitk::EnhancedPointSetVtkMapper3D, mitk::VtkGLMapperWrapper, mitk::ROIMapper2D, mitk::PlanarFigureVtkMapper3D, and mitk::ROIMapper3D.

◆ ApplyProperties()

virtual void mitk::VtkMapper::ApplyProperties	(	vtkActor *	actor,
		mitk::BaseRenderer *	renderer
	)

inlinevirtual

Apply color and opacity properties read from the PropertyList.

Deprecated:: (as of 2013_03) Use ApplyColorAndOpacityProperties(mitk::BaseRenderer* renderer, vtkActor * actor) instead

Reimplemented in mitk::VolumeMapperVtkSmart3D, and mitk::UnstructuredGridVtkMapper3D.

Definition at line 106 of file mitkVtkMapper.h.

◆ ApplyShaderProperties()

void mitk::VtkMapper::ApplyShaderProperties ( mitk::BaseRenderer * )

inline

Deprecated:: (as of 2018_04)

Definition at line 114 of file mitkVtkMapper.h.

◆ GetClassHierarchy()

virtual std::vector<std::string> mitk::VtkMapper::GetClassHierarchy ( ) const

inlineoverridevirtual

Reimplemented from mitk::Mapper.

Reimplemented in mitk::ImageVtkMapper2D, mitk::PointSetVtkMapper2D, mitk::PointSetVtkMapper3D, mitk::PlaneGeometryDataVtkMapper3D, mitk::SurfaceVtkMapper3D, mitk::SurfaceVtkMapper2D, mitk::PlaneGeometryDataMapper2D, and mitk::CrosshairVtkMapper2D.

Definition at line 50 of file mitkVtkMapper.h.

◆ GetClassName()

virtual const char* mitk::VtkMapper::GetClassName ( ) const

virtual

Reimplemented from mitk::Mapper.

Reimplemented in mitk::ImageVtkMapper2D, mitk::PointSetVtkMapper2D, mitk::PointSetVtkMapper3D, mitk::PlaneGeometryDataVtkMapper3D, mitk::SurfaceVtkMapper3D, mitk::SurfaceVtkMapper2D, mitk::PlaneGeometryDataMapper2D, and mitk::CrosshairVtkMapper2D.

◆ GetStaticNameOfClass()

static const char* mitk::VtkMapper::GetStaticNameOfClass ( )

inlinestatic

Definition at line 50 of file mitkVtkMapper.h.

◆ GetVtkProp()

virtual vtkProp* mitk::VtkMapper::GetVtkProp ( mitk::BaseRenderer * renderer )

pure virtual

Implemented in mitk::ImageVtkMapper2D, mitk::DoseImageVtkMapper2D, mitk::PointSetVtkMapper2D, mitk::PointSetVtkMapper3D, mitk::PlaneGeometryDataVtkMapper3D, mitk::SurfaceVtkMapper3D, mitk::RegEvaluationMapper2D, mitk::LabelSetImageVtkMapper2D, mitk::EnhancedPointSetVtkMapper3D, mitk::SurfaceVtkMapper2D, mitk::PlaneGeometryDataMapper2D, mitk::ContourModelSetMapper3D, mitk::GizmoMapper2D, mitk::TubeGraphVtkMapper3D, mitk::ContourModelMapper3D, mitk::ContourModelMapper2D, mitk::UnstructuredGridVtkMapper3D, mitk::SplineVtkMapper3D, mitk::VolumeMapperVtkSmart3D, mitk::ContourVtkMapper3D, mitk::ContourSetVtkMapper3D, mitk::ROIMapper2D, mitk::MITKRegistrationWrapperMapperBase, mitk::VtkGLMapperWrapper, mitk::ROIMapper3D, mitk::BoundingShapeVtkMapper2D, mitk::CrosshairVtkMapper2D, mitk::PlanarFigureVtkMapper3D, and mitk::BoundingShapeVtkMapper3D.

◆ HasVtkProp()

virtual bool mitk::VtkMapper::HasVtkProp	(	const vtkProp *	prop,
		BaseRenderer *	renderer
	)

virtual

Returns true if this mapper owns the specified vtkProp for the given BaseRenderer.

Note: returns false by default; should be implemented for VTK-based Mapper subclasses.

◆ IsVtkBased()

virtual bool mitk::VtkMapper::IsVtkBased ( ) const

overridevirtual

Returns whether this is an vtk-based mapper.

Deprecated:: (as of 2013_03) All mappers of superclass VTKMapper are vtk based, use a dynamic_cast instead

Reimplemented from mitk::Mapper.

◆ MitkRender()

void mitk::VtkMapper::MitkRender	(	mitk::BaseRenderer *	renderer,
		mitk::VtkPropRenderer::RenderType	type
	)

overridevirtual

Determines which geometry should be rendered (opaque, translucent, volumetric, overlay) and calls the appropriate function.

Called by mitk::VtkPropRenderer::Render

Implements mitk::Mapper.

Reimplemented in mitk::VtkGLMapperWrapper.

◆ MitkRenderOpaqueGeometry()

virtual void mitk::VtkMapper::MitkRenderOpaqueGeometry ( BaseRenderer * renderer )

virtual

Checks visibility and renders untransparent geometry.

◆ MitkRenderOverlay()

virtual void mitk::VtkMapper::MitkRenderOverlay ( BaseRenderer * renderer )

virtual

Checks visibility and renders the overlay.

◆ MitkRenderTranslucentGeometry()

virtual void mitk::VtkMapper::MitkRenderTranslucentGeometry ( BaseRenderer * renderer )

virtual

Checks visibility and renders transparent geometry.

◆ MitkRenderVolumetricGeometry()

virtual void mitk::VtkMapper::MitkRenderVolumetricGeometry ( BaseRenderer * renderer )

virtual

Checks visibility and renders volumes.

◆ ReleaseGraphicsResources()

virtual void mitk::VtkMapper::ReleaseGraphicsResources ( mitk::BaseRenderer * )

inlinevirtual

Release vtk-based graphics resources that are being consumed by this mapper.

Method called by mitk::VtkPropRenderer. The parameter renderer could be used to determine which graphic resources to release. The local storage is accessible by the parameter renderer. Should be overwritten in subclasses.

Reimplemented in mitk::PointSetVtkMapper3D.

Definition at line 129 of file mitkVtkMapper.h.

◆ UpdateVtkTransform()

virtual void mitk::VtkMapper::UpdateVtkTransform ( mitk::BaseRenderer * renderer )

virtual

Set the vtkTransform of the m_Prop3D for the current time step of renderer.

Called by mitk::VtkPropRenderer::Update before rendering. This method will transform all actors (e.g. of an vtkAssembly) according the geometry.

Warning: This method transforms only props which derive from vtkProp3D. Make sure to use vtkAssembly, if you have multiple props. vtkPropAssembly does not work, since it derives from vtkProp.

Reimplemented in mitk::PointSetVtkMapper3D, mitk::PlaneGeometryDataVtkMapper3D, mitk::EnhancedPointSetVtkMapper3D, mitk::SplineVtkMapper3D, mitk::SurfaceVtkMapper2D, and mitk::PlanarFigureVtkMapper3D.

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

mitkVtkMapper.h

Classes

Public Types

Public Member Functions

Static Public Member Functions

Protected Member Functions

Additional Inherited Members

Detailed Description

Member Typedef Documentation

◆ ConstPointer

◆ Pointer

◆ Self

◆ Superclass

Constructor & Destructor Documentation

◆ VtkMapper()

◆ ~VtkMapper()

Member Function Documentation

◆ ApplyColorAndOpacityProperties()

◆ ApplyProperties()

◆ ApplyShaderProperties()

◆ GetClassHierarchy()

◆ GetClassName()

◆ GetStaticNameOfClass()

◆ GetVtkProp()

◆ HasVtkProp()

◆ IsVtkBased()

◆ MitkRender()

◆ MitkRenderOpaqueGeometry()

◆ MitkRenderOverlay()

◆ MitkRenderTranslucentGeometry()

◆ MitkRenderVolumetricGeometry()

◆ ReleaseGraphicsResources()

◆ UpdateVtkTransform()