Slicer 5.13
Slicer is a multi-platform, free and open source software package for visualization and medical image computing
Loading...
Searching...
No Matches
vtkMRMLLayerDMLayerManager Class Reference

Responsible for adding and removing renderer layers to a vtkRenderWindow depending on the display pipeline preferred render order value. More...

#include <Modules/Loadable/LayerDM/MRMLDM/vtkMRMLLayerDMLayerManager.h>

Inheritance diagram for vtkMRMLLayerDMLayerManager:
Collaboration diagram for vtkMRMLLayerDMLayerManager:

Public Types

using LayerKey = std::tuple<unsigned int, std::uintptr_t>
 
typedef vtkObject Superclass
 

Public Member Functions

void AddPipeline (vtkMRMLLayerDMPipeline *pipeline)
 
virtual const char * GetClassName ()
 
int GetNumberOfDistinctLayers () const
 
int GetNumberOfManagedLayers () const
 
int GetNumberOfRenderers () const
 Returns the current number of managed renderers in the render window.
 
virtual int IsA (const char *type)
 
void PrintSelf (ostream &os, vtkIndent indent) override
 
void RemovePipeline (vtkMRMLLayerDMPipeline *pipeline)
 
void ResetCameraClippingRange () const
 Iterates over the renderers and resets their clipping range to visible bounds.
 
void SetDefaultCamera (const vtkSmartPointer< vtkCamera > &camera)
 If the default camera has changed, update the layers with ne new camera.
 
void SetRenderWindow (vtkRenderWindow *renderWindow)
 

Static Public Member Functions

static int IsTypeOf (const char *type)
 
static vtkMRMLLayerDMLayerManager * New ()
 
static vtkMRMLLayerDMLayerManager * SafeDownCast (vtkObject *o)
 

Protected Member Functions

 vtkMRMLLayerDMLayerManager ()
 
 ~vtkMRMLLayerDMLayerManager () override
 

Detailed Description

Responsible for adding and removing renderer layers to a vtkRenderWindow depending on the display pipeline preferred render order value.

Display pipeline order values are arbitrary unsigned int. This class will create and set the actual Renderer layers so that their ordering is consistent with expected VTK behavior.

Renderer 0 is left unchanged by the class and is expected to already exist in the render window.

When pipelines are added / removed, renderers are created or deleted, and renderer layers are optimized depending on the pipelines' preferred render order number. Order number is read-only during update and is expected to be static per pipeline.

Definition at line 57 of file vtkMRMLLayerDMLayerManager.h.

Member Typedef Documentation

◆ LayerKey

using vtkMRMLLayerDMLayerManager::LayerKey = std::tuple<unsigned int, std::uintptr_t>

Definition at line 60 of file vtkMRMLLayerDMLayerManager.h.

◆ Superclass

Definition at line 63 of file vtkMRMLLayerDMLayerManager.h.

Constructor & Destructor Documentation

◆ vtkMRMLLayerDMLayerManager()

vtkMRMLLayerDMLayerManager::vtkMRMLLayerDMLayerManager ( )
protected

◆ ~vtkMRMLLayerDMLayerManager()

vtkMRMLLayerDMLayerManager::~vtkMRMLLayerDMLayerManager ( )
overrideprotected

Member Function Documentation

◆ AddPipeline()

void vtkMRMLLayerDMLayerManager::AddPipeline ( vtkMRMLLayerDMPipeline * pipeline)

Adds the pipeline to the layers. May change an update of the layer ordering. Will trigger the SetRenderer call on the pipeline when it's added to its layer.

◆ GetClassName()

virtual const char * vtkMRMLLayerDMLayerManager::GetClassName ( )
virtual

◆ GetNumberOfDistinctLayers()

int vtkMRMLLayerDMLayerManager::GetNumberOfDistinctLayers ( ) const

◆ GetNumberOfManagedLayers()

int vtkMRMLLayerDMLayerManager::GetNumberOfManagedLayers ( ) const

◆ GetNumberOfRenderers()

int vtkMRMLLayerDMLayerManager::GetNumberOfRenderers ( ) const

Returns the current number of managed renderers in the render window.

◆ IsA()

virtual int vtkMRMLLayerDMLayerManager::IsA ( const char * type)
virtual

◆ IsTypeOf()

static int vtkMRMLLayerDMLayerManager::IsTypeOf ( const char * type)
static

◆ New()

static vtkMRMLLayerDMLayerManager * vtkMRMLLayerDMLayerManager::New ( )
static

◆ PrintSelf()

void vtkMRMLLayerDMLayerManager::PrintSelf ( ostream & os,
vtkIndent indent )
override

◆ RemovePipeline()

void vtkMRMLLayerDMLayerManager::RemovePipeline ( vtkMRMLLayerDMPipeline * pipeline)

Removes the pipeline from the layers. May change the layer ordering if pipeline was the last one of its current renderer.

◆ ResetCameraClippingRange()

void vtkMRMLLayerDMLayerManager::ResetCameraClippingRange ( ) const

Iterates over the renderers and resets their clipping range to visible bounds.

◆ SafeDownCast()

static vtkMRMLLayerDMLayerManager * vtkMRMLLayerDMLayerManager::SafeDownCast ( vtkObject * o)
static

◆ SetDefaultCamera()

void vtkMRMLLayerDMLayerManager::SetDefaultCamera ( const vtkSmartPointer< vtkCamera > & camera)

If the default camera has changed, update the layers with ne new camera.

◆ SetRenderWindow()

void vtkMRMLLayerDMLayerManager::SetRenderWindow ( vtkRenderWindow * renderWindow)

Changes the render window managed by the layer manager. Will trigger a removal of all managed layers and creation of new layers if the render window is not null.


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