Medical Imaging Interaction Toolkit  2024.06.00
Medical Imaging Interaction Toolkit
mitk::VtkGLMapperWrapper Class Reference

Vtk-based 2D mapper for PointSet. More...

#include <mitkVtkGLMapperWrapper.h>

Inheritance diagram for mitk::VtkGLMapperWrapper:
Collaboration diagram for mitk::VtkGLMapperWrapper:

Classes

class  LocalStorage
 Internal class holding the mapper, actor, etc. for each of the 3 2D render windows. More...
 

Public Member Functions

 mitkClassMacro (VtkGLMapperWrapper, VtkMapper)
 
 mitkNewMacro1Param (Self, GLMapper::Pointer)
 
Pointer Clone () const
 
vtkProp * GetVtkProp (mitk::BaseRenderer *renderer) override
 returns the a prop assembly More...
 
void GenerateDataForRenderer (mitk::BaseRenderer *renderer) override
 Generate the data needed for rendering into renderer. More...
 
void ApplyColorAndOpacityProperties (mitk::BaseRenderer *renderer, vtkActor *actor) override
 Apply color and opacity properties read from the PropertyList. Called by mapper subclasses. 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...
 
void Update (BaseRenderer *renderer) override
 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...
 
void SetDataNode (DataNode *node) override
 Set the DataNode containing the data to map. More...
 
DataNodeGetDataNode () const override
 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...
 
- 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...
 
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 *)
 
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
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...
 
TimeStepType GetTimestep () const
 Returns the current time step as calculated from the renderer. More...
 
virtual bool IsLODEnabled (BaseRenderer *) const
 

Public Attributes

mitk::LocalStorageHandler< LocalStoragem_LSH
 The LocalStorageHandler holds all (three) LocalStorages for the three 2D render windows. More...
 

Protected Member Functions

 VtkGLMapperWrapper (GLMapper::Pointer mitkGLMapper)
 
 ~VtkGLMapperWrapper () override
 
void Enable2DOpenGL (mitk::BaseRenderer *)
 
void Disable2DOpenGL ()
 
- 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...
 

Protected Attributes

GLMapper::Pointer m_MitkGLMapper
 
- Protected Attributes inherited from mitk::Mapper
mitk::DataNodem_DataNode
 

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
 
- 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...
 

Detailed Description

Vtk-based 2D mapper for PointSet.

Definition at line 30 of file mitkVtkGLMapperWrapper.h.

Constructor & Destructor Documentation

◆ VtkGLMapperWrapper()

mitk::VtkGLMapperWrapper::VtkGLMapperWrapper ( GLMapper::Pointer  mitkGLMapper)
protected

◆ ~VtkGLMapperWrapper()

mitk::VtkGLMapperWrapper::~VtkGLMapperWrapper ( )
overrideprotected

Member Function Documentation

◆ ApplyColorAndOpacityProperties()

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

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

Reimplemented from mitk::VtkMapper.

◆ Clone()

Pointer mitk::VtkGLMapperWrapper::Clone ( ) const

◆ Disable2DOpenGL()

void mitk::VtkGLMapperWrapper::Disable2DOpenGL ( )
protected

◆ Enable2DOpenGL()

void mitk::VtkGLMapperWrapper::Enable2DOpenGL ( mitk::BaseRenderer )
protected

◆ GenerateDataForRenderer()

void mitk::VtkGLMapperWrapper::GenerateDataForRenderer ( mitk::BaseRenderer )
overridevirtual

Generate the data needed for rendering into renderer.

Reimplemented from mitk::Mapper.

◆ GetDataNode()

DataNode* mitk::VtkGLMapperWrapper::GetDataNode ( ) const
overridevirtual

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.

Reimplemented from mitk::Mapper.

◆ GetVtkProp()

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

returns the a prop assembly

Implements mitk::VtkMapper.

◆ mitkClassMacro()

mitk::VtkGLMapperWrapper::mitkClassMacro ( VtkGLMapperWrapper  ,
VtkMapper   
)

◆ mitkNewMacro1Param()

mitk::VtkGLMapperWrapper::mitkNewMacro1Param ( Self  ,
GLMapper::Pointer   
)

◆ MitkRender()

void mitk::VtkGLMapperWrapper::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

Reimplemented from mitk::VtkMapper.

◆ SetDataNode()

void mitk::VtkGLMapperWrapper::SetDataNode ( DataNode _arg)
overridevirtual

Set the DataNode containing the data to map.

Reimplemented from mitk::Mapper.

◆ Update()

void mitk::VtkGLMapperWrapper::Update ( BaseRenderer renderer)
overridevirtual

Calls the time step of the input data for the specified renderer and checks whether the time step is valid and calls method GenerateDataForRenderer()

Reimplemented from mitk::Mapper.

Member Data Documentation

◆ m_LSH

mitk::LocalStorageHandler<LocalStorage> mitk::VtkGLMapperWrapper::m_LSH

The LocalStorageHandler holds all (three) LocalStorages for the three 2D render windows.

Definition at line 67 of file mitkVtkGLMapperWrapper.h.

◆ m_MitkGLMapper

GLMapper::Pointer mitk::VtkGLMapperWrapper::m_MitkGLMapper
protected

Definition at line 70 of file mitkVtkGLMapperWrapper.h.


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