Medical Imaging Interaction Toolkit  2026.06.00
Medical Imaging Interaction Toolkit
mitk::ROIMapperLocalStorage Class Reference

Common base class for both 2D and 3D ROI mapper local storages. More...

#include <mitkROIMapperLocalStorage.h>

Inheritance diagram for mitk::ROIMapperLocalStorage:
Collaboration diagram for mitk::ROIMapperLocalStorage:

Public Member Functions

 ROIMapperLocalStorage ()
 
 ~ROIMapperLocalStorage () override
 
vtkPropAssembly * GetPropAssembly () const
 Get the VTK prop assembly containing all rendered ROI actors. More...
 
void SetPropAssembly (vtkPropAssembly *propAssembly)
 Set the VTK prop assembly. More...
 
TimePointType GetLastTimePoint () const
 Get the time point that was last used for rendering. More...
 
void SetLastTimePoint (TimePointType timePoint)
 Set the last rendered time point. More...
 
- Public Member Functions inherited from mitk::Mapper::BaseLocalStorage
 BaseLocalStorage ()=default
 
virtual ~BaseLocalStorage ()=default
 
 BaseLocalStorage (const BaseLocalStorage &)=delete
 
BaseLocalStorage & operator= (const BaseLocalStorage &)=delete
 
bool IsGenerateDataRequired (mitk::BaseRenderer *renderer, mitk::Mapper *mapper, mitk::DataNode *dataNode) const
 Check whether GenerateDataForRenderer() needs to be called. More...
 
void UpdateGenerateDataTime ()
 Mark the stored data as up-to-date. More...
 
itk::TimeStamp & GetLastGenerateDataTime ()
 Get a reference to the last-generate-data timestamp. More...
 

Protected Attributes

vtkSmartPointer< vtkPropAssembly > m_PropAssembly
 
TimePointType m_LastTimePoint
 
- Protected Attributes inherited from mitk::Mapper::BaseLocalStorage
itk::TimeStamp m_LastGenerateDataTime
 Timestamp of last update of stored data. More...
 

Detailed Description

Common base class for both 2D and 3D ROI mapper local storages.

Stores per-renderer state shared by ROIMapper2D and ROIMapper3D, including the VTK prop assembly that aggregates all rendered ROI element actors and the last rendered time point for caching purposes.

See also
ROIMapper2D, ROIMapper3D

Definition at line 33 of file mitkROIMapperLocalStorage.h.

Constructor & Destructor Documentation

◆ ROIMapperLocalStorage()

mitk::ROIMapperLocalStorage::ROIMapperLocalStorage ( )

◆ ~ROIMapperLocalStorage()

mitk::ROIMapperLocalStorage::~ROIMapperLocalStorage ( )
override

Member Function Documentation

◆ GetLastTimePoint()

TimePointType mitk::ROIMapperLocalStorage::GetLastTimePoint ( ) const

Get the time point that was last used for rendering.

Returns
The last rendered time point.

◆ GetPropAssembly()

vtkPropAssembly* mitk::ROIMapperLocalStorage::GetPropAssembly ( ) const

Get the VTK prop assembly containing all rendered ROI actors.

Returns
Pointer to the prop assembly. Never nullptr after construction.

◆ SetLastTimePoint()

void mitk::ROIMapperLocalStorage::SetLastTimePoint ( TimePointType  timePoint)

Set the last rendered time point.

Parameters
[in]timePointThe time point value to store.

◆ SetPropAssembly()

void mitk::ROIMapperLocalStorage::SetPropAssembly ( vtkPropAssembly *  propAssembly)

Set the VTK prop assembly.

Parameters
[in]propAssemblyThe new prop assembly to store.

Member Data Documentation

◆ m_LastTimePoint

TimePointType mitk::ROIMapperLocalStorage::m_LastTimePoint
protected

Definition at line 69 of file mitkROIMapperLocalStorage.h.

◆ m_PropAssembly

vtkSmartPointer<vtkPropAssembly> mitk::ROIMapperLocalStorage::m_PropAssembly
protected

Definition at line 68 of file mitkROIMapperLocalStorage.h.


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