Medical Imaging Interaction Toolkit  2024.06.99-5f7b36e7
Medical Imaging Interaction Toolkit
mitk::RenderWindowLayerUtilities Namespace Reference

Typedefs

typedef std::vector< BaseRenderer * > RendererVector
 
typedef std::map< int, DataNode::Pointer, std::greater< int > > LayerStack
 

Functions

MITKQTWIDGETS_EXPORT LayerStack GetLayerStack (const DataStorage *dataStorage, const BaseRenderer *renderer)
 Return the stack of layers of the given renderer as std::map<int, DataNode::Pointer>, which guarantees ordering of the layers. Stacked layers are only included if they have their "layer" property set. More...
 
MITKQTWIDGETS_EXPORT void SetRenderWindowProperties (DataNode *dataNode, const BaseRenderer *renderer)
 Set renderer-specific properties to mark a data node as 'managed by the specific renderer'. In order for a renderer to manage a data node, the 'visible' and the 'layer' property are set and allow to individually render a set of nodes with a specific renderer. The last two mentioned properties are set so that they initially have the same value as the corresponding global property. More...
 
MITKQTWIDGETS_EXPORT void DeleteRenderWindowProperties (DataNode *dataNode, const BaseRenderer *renderer)
 
MITKQTWIDGETS_EXPORT void TransferRenderWindowProperties (DataNode *dataNode, const BaseRenderer *newRenderer, const BaseRenderer *oldRenderer)
 

Variables

const int TOP_LAYER_INDEX
 

Typedef Documentation

◆ LayerStack

typedef std::map<int, DataNode::Pointer, std::greater<int> > mitk::RenderWindowLayerUtilities::LayerStack

Definition at line 33 of file mitkRenderWindowLayerUtilities.h.

◆ RendererVector

Function Documentation

◆ DeleteRenderWindowProperties()

MITKQTWIDGETS_EXPORT void mitk::RenderWindowLayerUtilities::DeleteRenderWindowProperties ( DataNode dataNode,
const BaseRenderer renderer 
)

◆ GetLayerStack()

MITKQTWIDGETS_EXPORT LayerStack mitk::RenderWindowLayerUtilities::GetLayerStack ( const DataStorage dataStorage,
const BaseRenderer renderer 
)

Return the stack of layers of the given renderer as std::map<int, DataNode::Pointer>, which guarantees ordering of the layers. Stacked layers are only included if they have their "layer" property set.

If "renderer" = nullptr: a layer stack won't be created and an empty "LayerStack" will be returned.

Parameters
dataStoragePointer to a data storage instance whose data nodes should be checked and possibly be included.
rendererPointer to the renderer instance for which the layer stack should be generated.

◆ SetRenderWindowProperties()

MITKQTWIDGETS_EXPORT void mitk::RenderWindowLayerUtilities::SetRenderWindowProperties ( DataNode dataNode,
const BaseRenderer renderer 
)

Set renderer-specific properties to mark a data node as 'managed by the specific renderer'. In order for a renderer to manage a data node, the 'visible' and the 'layer' property are set and allow to individually render a set of nodes with a specific renderer. The last two mentioned properties are set so that they initially have the same value as the corresponding global property.

◆ TransferRenderWindowProperties()

MITKQTWIDGETS_EXPORT void mitk::RenderWindowLayerUtilities::TransferRenderWindowProperties ( DataNode dataNode,
const BaseRenderer newRenderer,
const BaseRenderer oldRenderer 
)

Variable Documentation

◆ TOP_LAYER_INDEX

const int mitk::RenderWindowLayerUtilities::TOP_LAYER_INDEX

The top layer index, denoting that no valid (positive) layer index is given and therefore the index should be resolved into the topmost layer index.

Definition at line 38 of file mitkRenderWindowLayerUtilities.h.