Medical Imaging Interaction Toolkit  2024.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
 
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
virtual std::vector< std::string > GetClassHierarchy () const override
 
virtual const char * GetClassName () const
 
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 DataNodeGetDataNode () 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...
 
BaseDataGetData () 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...
 
TimeStepType GetTimestep () const
 Returns the current time step as calculated from the renderer. More...
 
virtual bool IsLODEnabled (BaseRenderer *) const
 

Static Public Member Functions

static void SetDefaultProperties (DataNode *node, BaseRenderer *renderer=nullptr, bool overwrite=false)
 
- Static Public Member Functions inherited from mitk::VtkMapper
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...
 

Public Attributes

mitk::LocalStorageHandler< RegWrapperLocalStoragem_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 GenerateData ()
 Generate the data needed for rendering (independent of a specific 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

- Public Types inherited from mitk::VtkMapper
typedef VtkMapper Self
 
typedef Mapper Superclass
 
typedef itk::SmartPointer< SelfPointer
 
typedef itk::SmartPointer< const SelfConstPointer
 
- Public Types inherited from mitk::Mapper
typedef Mapper Self
 
typedef itk::Object Superclass
 
typedef itk::SmartPointer< SelfPointer
 
typedef itk::SmartPointer< const SelfConstPointer
 
- Protected Attributes inherited from mitk::Mapper
mitk::DataNodem_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

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: