Medical Imaging Interaction Toolkit  2018.4.99-389bf124
Medical Imaging Interaction Toolkit
mitk::VtkLayerController Class Reference

#include <mitkVtkLayerController.h>

Public Member Functions

 VtkLayerController (vtkSmartPointer< vtkRenderWindow > renderWindow)
 
virtual ~VtkLayerController ()
 
vtkSmartPointer< vtkRenderer > GetSceneRenderer ()
 
void InsertBackgroundRenderer (vtkSmartPointer< vtkRenderer > renderer, bool forceAbsoluteBackground)
 
void InsertForegroundRenderer (vtkSmartPointer< vtkRenderer > renderer, bool forceAbsoluteForeground)
 
void InsertSceneRenderer (vtkSmartPointer< vtkRenderer > renderer)
 
void SetRenderWindow (vtkSmartPointer< vtkRenderWindow > renwin)
 
void RemoveRenderer (vtkSmartPointer< vtkRenderer > renderer)
 
bool IsRendererInserted (vtkSmartPointer< vtkRenderer > renderer)
 
unsigned int GetNumberOfRenderers ()
 
void SetEraseForAllRenderers (int i)
 

Static Public Member Functions

static VtkLayerControllerGetInstance (vtkSmartPointer< vtkRenderWindow > renWin)
 
static void AddInstance (vtkSmartPointer< vtkRenderWindow > renWin, vtkSmartPointer< vtkRenderer > mitkSceneRenderer)
 
static void RemoveInstance (vtkSmartPointer< vtkRenderWindow > renWin)
 

Protected Attributes

vtkSmartPointer< vtkRenderWindow > m_RenderWindow
 

Detailed Description

Manages the VTK layer hierarchy of a vtkRenderWindow. For simple access the layers are divided into three main groups: background, scene and foreground layers. Renderers can be registered via the insert... functions and removed via the RemoveRenderer function.

Definition at line 34 of file mitkVtkLayerController.h.

Constructor & Destructor Documentation

◆ VtkLayerController()

mitk::VtkLayerController::VtkLayerController ( vtkSmartPointer< vtkRenderWindow >  renderWindow)

Definition at line 56 of file mitkVtkLayerController.cpp.

References m_RenderWindow.

◆ ~VtkLayerController()

mitk::VtkLayerController::~VtkLayerController ( )
virtual

Definition at line 65 of file mitkVtkLayerController.cpp.

References m_RenderWindow.

Member Function Documentation

◆ AddInstance()

void mitk::VtkLayerController::AddInstance ( vtkSmartPointer< vtkRenderWindow >  renWin,
vtkSmartPointer< vtkRenderer >  mitkSceneRenderer 
)
static

Definition at line 33 of file mitkVtkLayerController.cpp.

References InsertSceneRenderer(), and RemoveInstance().

Referenced by mitk::BaseRenderer::BaseRenderer().

◆ GetInstance()

◆ GetNumberOfRenderers()

unsigned int mitk::VtkLayerController::GetNumberOfRenderers ( )

Returns the number of renderers in the renderwindow.

Definition at line 314 of file mitkVtkLayerController.cpp.

◆ GetSceneRenderer()

vtkSmartPointer< vtkRenderer > mitk::VtkLayerController::GetSceneRenderer ( )

Returns the current vtkRenderer of the Scene

Returns the Scene Renderer

Definition at line 124 of file mitkVtkLayerController.cpp.

◆ InsertBackgroundRenderer()

void mitk::VtkLayerController::InsertBackgroundRenderer ( vtkSmartPointer< vtkRenderer >  renderer,
bool  forceAbsoluteBackground 
)

Connects a VTK renderer with a vtk renderwindow. The renderer will be rendered in the background. With forceAbsoluteBackground set true a renderer can be placed at the absolute background of the scene. Multiple calls with forceAbsoluteBackground set true will set the latest registered renderer as background.

Definition at line 78 of file mitkVtkLayerController.cpp.

References RemoveRenderer().

Referenced by mitk::GradientBackground::Enable(), and QmitkVideoBackground::Modified().

◆ InsertForegroundRenderer()

void mitk::VtkLayerController::InsertForegroundRenderer ( vtkSmartPointer< vtkRenderer >  renderer,
bool  forceAbsoluteForeground 
)

Connects a VTK renderer with a vtk renderwindow. The renderer will be rendered in the foreground. With forceAbsoluteBackground set true a renderer can be placed at the absolute foreground of the scene. Multiple calls with forceAbsoluteForeground set true will set the latest registered renderer as foreground.

Definition at line 101 of file mitkVtkLayerController.cpp.

References RemoveRenderer().

Referenced by mitk::RenderWindowFrame::Enable(), mitk::VtkWidgetRendering::Enable(), and mitkVtkPropRendererTest().

◆ InsertSceneRenderer()

void mitk::VtkLayerController::InsertSceneRenderer ( vtkSmartPointer< vtkRenderer >  renderer)

Connects a VTK renderer with a vtk renderwindow. The renderer will be rendered between background renderers and foreground renderers.

Definition at line 138 of file mitkVtkLayerController.cpp.

References RemoveRenderer().

Referenced by AddInstance(), and mitk::BaseRenderer::BaseRenderer().

◆ IsRendererInserted()

bool mitk::VtkLayerController::IsRendererInserted ( vtkSmartPointer< vtkRenderer >  renderer)

Returns true if a renderer has been inserted

Definition at line 221 of file mitkVtkLayerController.cpp.

References m_RenderWindow.

Referenced by QmitkVideoBackground::Modified().

◆ RemoveInstance()

void mitk::VtkLayerController::RemoveInstance ( vtkSmartPointer< vtkRenderWindow >  renWin)
static

Definition at line 46 of file mitkVtkLayerController.cpp.

Referenced by AddInstance(), and mitk::BaseRenderer::~BaseRenderer().

◆ RemoveRenderer()

void mitk::VtkLayerController::RemoveRenderer ( vtkSmartPointer< vtkRenderer >  renderer)

A renderer which has been inserted via a insert... function can be removed from the vtkRenderWindow with RemoveRenderer.

Definition at line 153 of file mitkVtkLayerController.cpp.

Referenced by mitk::RenderWindowFrame::Disable(), mitk::VtkWidgetRendering::Disable(), mitk::GradientBackground::Disable(), QmitkVideoBackground::Disable(), InsertBackgroundRenderer(), InsertForegroundRenderer(), InsertSceneRenderer(), and QmitkVideoBackground::RemoveRenderWindow().

◆ SetEraseForAllRenderers()

void mitk::VtkLayerController::SetEraseForAllRenderers ( int  i)

Definition at line 320 of file mitkVtkLayerController.cpp.

References m_RenderWindow.

◆ SetRenderWindow()

void mitk::VtkLayerController::SetRenderWindow ( vtkSmartPointer< vtkRenderWindow >  renwin)

Connects a VtkRenderWindow with the layer controller.

Definition at line 193 of file mitkVtkLayerController.cpp.

References m_RenderWindow.

Member Data Documentation

◆ m_RenderWindow

vtkSmartPointer<vtkRenderWindow> mitk::VtkLayerController::m_RenderWindow
protected

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