Medical Imaging Interaction Toolkit  2026.06.00
Medical Imaging Interaction Toolkit
mitk::MITKRegistrationWrapperMapperBase Class Referenceabstract

#include <mitkRegistrationWrapperMapperBase.h>

Inheritance diagram for mitk::MITKRegistrationWrapperMapperBase:
Collaboration diagram for mitk::MITKRegistrationWrapperMapperBase:

Classes

class  RegWrapperLocalStorage
 

Public Member Functions

 mitkClassMacro (MITKRegistrationWrapperMapperBase, VtkMapper)
 
vtkProp * GetVtkProp (mitk::BaseRenderer *renderer) override
 Return the VTK prop (actor, assembly, etc.) for the given renderer. More...
 
void GenerateDataForRenderer (mitk::BaseRenderer *renderer) override
 Generate the data needed for rendering into renderer. More...
 
virtual bool GetGeometryDescription (mitk::BaseRenderer *renderer, mitk::BaseGeometry::ConstPointer &gridDesc, unsigned int &gridFrequ) const =0
 
virtual bool RendererGeometryIsOutdated (mitk::BaseRenderer *renderer, const itk::TimeStamp &time) const =0
 
- 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...
 
void ApplyColorAndOpacityProperties (mitk::BaseRenderer *renderer, vtkActor *actor) override
 Apply color and opacity properties read from the PropertyList to the given vtkActor. 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 overwrite=false)
 
- 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...
 

Public Attributes

mitk::LocalStorageHandler< RegWrapperLocalStorage > m_LSH
 This member holds all three LocalStorages for the 3D render window(s). More...
 

Protected Member Functions

 MITKRegistrationWrapperMapperBase ()
 
 ~MITKRegistrationWrapperMapperBase () override
 
- 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

Base class for all mapper that visualize a registration object.

Definition at line 34 of file mitkRegistrationWrapperMapperBase.h.

Constructor & Destructor Documentation

◆ MITKRegistrationWrapperMapperBase()

mitk::MITKRegistrationWrapperMapperBase::MITKRegistrationWrapperMapperBase ( )
protected

◆ ~MITKRegistrationWrapperMapperBase()

mitk::MITKRegistrationWrapperMapperBase::~MITKRegistrationWrapperMapperBase ( )
overrideprotected

Member Function Documentation

◆ GenerateDataForRenderer()

void mitk::MITKRegistrationWrapperMapperBase::GenerateDataForRenderer ( mitk::BaseRenderer *  )
overridevirtual

Generate the data needed for rendering into renderer.

Reimplemented from mitk::Mapper.

◆ GetGeometryDescription()

virtual bool mitk::MITKRegistrationWrapperMapperBase::GetGeometryDescription ( mitk::BaseRenderer *  renderer,
mitk::BaseGeometry::ConstPointer &  gridDesc,
unsigned int &  gridFrequ 
) const
pure virtual

◆ GetVtkProp()

vtkProp* mitk::MITKRegistrationWrapperMapperBase::GetVtkProp ( mitk::BaseRenderer *  renderer)
overridevirtual

Return the VTK prop (actor, assembly, etc.) for the given renderer.

Each subclass must implement this to provide its rendering representation.

Parameters
[in]rendererThe renderer for which the prop is requested.
Returns
Pointer to the vtkProp used for rendering.

Implements mitk::VtkMapper.

◆ mitkClassMacro()

mitk::MITKRegistrationWrapperMapperBase::mitkClassMacro ( MITKRegistrationWrapperMapperBase  ,
VtkMapper   
)

◆ RendererGeometryIsOutdated()

virtual bool mitk::MITKRegistrationWrapperMapperBase::RendererGeometryIsOutdated ( mitk::BaseRenderer *  renderer,
const itk::TimeStamp &  time 
) const
pure virtual

◆ SetDefaultProperties()

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

Member Data Documentation

◆ m_LSH

mitk::LocalStorageHandler<RegWrapperLocalStorage> mitk::MITKRegistrationWrapperMapperBase::m_LSH

This member holds all three LocalStorages for the 3D render window(s).

Definition at line 77 of file mitkRegistrationWrapperMapperBase.h.


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