Medical Imaging Interaction Toolkit  2023.12.00
Medical Imaging Interaction Toolkit
mitk::RenderWindowViewDirectionController Class Reference

#include <mitkRenderWindowViewDirectionController.h>

Public Member Functions

 RenderWindowViewDirectionController ()
 
void SetDataStorage (DataStorage::Pointer dataStorage)
 Set the data storage on which to work. More...
 
void SetControlledRenderer (RenderWindowLayerUtilities::RendererVector controlledRenderer)
 Set the controlled base renderer. More...
 
void SetViewDirectionOfRenderer (const std::string &viewDirection, BaseRenderer *renderer=nullptr)
 Set the ciew direction for the given renderer (nullptr = all renderer) More...
 
void SetViewDirectionOfRenderer (AnatomicalPlane viewDirection, BaseRenderer *renderer=nullptr)
 Set the ciew direction for the given renderer (nullptr = all renderer) More...
 
void InitializeViewByBoundingObjects (const BaseRenderer *renderer)
 Reinitialize the given renderer with the currently visible nodes. More...
 

Detailed Description

The RenderWindowViewDirectionController is used to manipulate the 'sliceNavigationController' of a given base renderer. The 'sliceNavigationController' is used to set the view direction / camera perspective of a base renderer. The view direction can be changed to 'mitk::AnatomicalPlane::Axial', 'mitk::AnatomicalPlane::Coronal' or 'mitk::AnatomicalPlane::Sagittal'.

Functions with 'mitk::BaseRenderer* renderer' have 'nullptr' as their default argument. Using the nullptr these functions operate on all base renderer. Giving a specific base renderer will change the view direction only for the given renderer.

Definition at line 36 of file mitkRenderWindowViewDirectionController.h.

Constructor & Destructor Documentation

◆ RenderWindowViewDirectionController()

mitk::RenderWindowViewDirectionController::RenderWindowViewDirectionController ( )

Member Function Documentation

◆ InitializeViewByBoundingObjects()

void mitk::RenderWindowViewDirectionController::InitializeViewByBoundingObjects ( const BaseRenderer renderer)

Reinitialize the given renderer with the currently visible nodes.

Parameters
rendererPointer to the renderer instance which should be reinitialized. If it is a nullptr (default) all controlled renderer will be affected.

◆ SetControlledRenderer()

void mitk::RenderWindowViewDirectionController::SetControlledRenderer ( RenderWindowLayerUtilities::RendererVector  controlledRenderer)

Set the controlled base renderer.

◆ SetDataStorage()

void mitk::RenderWindowViewDirectionController::SetDataStorage ( DataStorage::Pointer  dataStorage)

Set the data storage on which to work.

◆ SetViewDirectionOfRenderer() [1/2]

void mitk::RenderWindowViewDirectionController::SetViewDirectionOfRenderer ( AnatomicalPlane  viewDirection,
BaseRenderer renderer = nullptr 
)

Set the ciew direction for the given renderer (nullptr = all renderer)

Parameters
viewDirectionThe view direction that should be used for this renderer.
rendererPointer to the renderer instance for which the view direction should be changed. If it is a nullptr (default) nothing happens.

◆ SetViewDirectionOfRenderer() [2/2]

void mitk::RenderWindowViewDirectionController::SetViewDirectionOfRenderer ( const std::string &  viewDirection,
BaseRenderer renderer = nullptr 
)

Set the ciew direction for the given renderer (nullptr = all renderer)

Parameters
viewDirectionThe view direction that should be used for this renderer as a string. Currently "axial", "coronal" and "sagittal" is supported.
rendererPointer to the renderer instance for which the view direction should be changed. If it is a nullptr (default) all controlled renderer will be affected.

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