Interface for a MITK Workbench Part providing a render window. More...

#include <mitkIRenderWindowPart.h>

Inheritance diagram for mitk::IRenderWindowPart:

[legend]

Public Member Functions
virtual	~IRenderWindowPart ()

virtual QmitkRenderWindow *	GetActiveQmitkRenderWindow () const =0

virtual QHash< QString, QmitkRenderWindow * >	GetQmitkRenderWindows () const =0

virtual QmitkRenderWindow *	GetQmitkRenderWindow (const QString &id) const =0

virtual QmitkRenderWindow *	GetQmitkRenderWindow (const mitk::AnatomicalPlane &orientation) const =0

virtual mitk::IRenderingManager *	GetRenderingManager () const =0

virtual void	RequestUpdate (mitk::RenderingManager::RequestType requestType=mitk::RenderingManager::REQUEST_UPDATE_ALL)=0

virtual void	ForceImmediateUpdate (mitk::RenderingManager::RequestType requestType=mitk::RenderingManager::REQUEST_UPDATE_ALL)=0

virtual void	InitializeViews (const mitk::TimeGeometry *geometry, bool resetCamera)=0
	Initialize the render windows of this render window part to the given geometry. More...

virtual void	SetInteractionReferenceGeometry (const mitk::TimeGeometry *referenceGeometry)=0
	Define the reference geometry for interaction withing a render window. More...

virtual bool	HasCoupledRenderWindows () const =0
	Returns true if the render windows are coupled; false if not. More...

virtual mitk::TimeNavigationController *	GetTimeNavigationController () const =0

virtual mitk::Point3D	GetSelectedPosition (const QString &id=QString()) const =0

virtual void	SetSelectedPosition (const mitk::Point3D &pos, const QString &id=QString())=0

virtual TimePointType	GetSelectedTimePoint (const QString &id=QString()) const =0

virtual void	EnableDecorations (bool enable, const QStringList &decorations=QStringList())=0

virtual bool	IsDecorationEnabled (const QString &decoration) const =0

virtual QStringList	GetDecorations () const =0

Static Public Attributes
static const QString	DECORATION_BORDER

static const QString	DECORATION_LOGO

static const QString	DECORATION_MENU

static const QString	DECORATION_BACKGROUND

static const QString	DECORATION_CORNER_ANNOTATION

Detailed Description

Interface for a MITK Workbench Part providing a render window.

This interface allows generic access to Workbench parts which provide some kind of render window. The interface is intended to be implemented by subclasses of berry::IWorkbenchPart. Usually, the interface is implemented by a Workbench editor.

A IRenderWindowPart provides zero or more QmitkRenderWindow instances which can be controlled via this interface. QmitkRenderWindow instances have an associated id, which is implementation specific. Additionally the defined values Axial, Sagittal, Coronal and Original from mitk::AnatomicalPlane can be used to retrieve a specific QmitkRenderWindow.

See also: ILinkedRenderWindowPart; IRenderWindowPartListener; QmitkAbstractRenderEditor

Definition at line 54 of file mitkIRenderWindowPart.h.

Constructor & Destructor Documentation

◆ ~IRenderWindowPart()

virtual mitk::IRenderWindowPart::~IRenderWindowPart ( )

virtual

Member Function Documentation

◆ EnableDecorations()

virtual void mitk::IRenderWindowPart::EnableDecorations	(	bool	enable,
		const QStringList &	decorations = `QStringList()`
	)

pure virtual

Enable decorations like colored borders, menu widgets, logos, text annotations, etc.

Decorations are implementation specific. A set of standardized decoration names is listed in GetDecorations().

Parameters

enable	If `true` enable the decorations specified in `decorations`, otherwise disable them.
decorations	A list of decoration names. If empty, all supported decorations are affected.

See also: GetDecorations()

Implemented in QmitkAbstractMultiWidgetEditor.

◆ ForceImmediateUpdate()

virtual void mitk::IRenderWindowPart::ForceImmediateUpdate ( mitk::RenderingManager::RequestType requestType = mitk::RenderingManager::REQUEST_UPDATE_ALL )

pure virtual

Force an immediate update of all render windows.

Parameters

requestType Specifies the type of render windows for which an immediate update will be requested.

Implemented in QmitkAbstractRenderEditor.

◆ GetActiveQmitkRenderWindow()

virtual QmitkRenderWindow* mitk::IRenderWindowPart::GetActiveQmitkRenderWindow ( ) const

pure virtual

Get the currently active (focused) render window. Focus handling is implementation specific.

Returns: The active QmitkRenderWindow instance; nullptr if no render window is active.

Implemented in QmitkAbstractMultiWidgetEditor.

◆ GetDecorations()

virtual QStringList mitk::IRenderWindowPart::GetDecorations ( ) const

pure virtual

Get a list of supported decorations.

The following decoration names are standardized and should not be used for other decoration types:

DECORATION_BORDER Any border decorations like colored rectangles, etc.
DECORATION_MENU Menus associated with render windows
DECORATION_BACKGROUND All kinds of backgrounds (patterns, gradients, etc.) except for solid colored backgrounds
DECORATION_LOGO Any kind of logo overlayed on the rendered scene

Returns: A list of supported decoration names.

Implemented in QmitkAbstractMultiWidgetEditor.

◆ GetQmitkRenderWindow() [1/2]

virtual QmitkRenderWindow* mitk::IRenderWindowPart::GetQmitkRenderWindow ( const mitk::AnatomicalPlane & orientation ) const

pure virtual

Get a render window with a specific plane orientation.

Parameters

orientation The render window plane orientation.

Returns: The QmitkRenderWindow instance for orientation

Implemented in QmitkAbstractMultiWidgetEditor.

◆ GetQmitkRenderWindow() [2/2]

virtual QmitkRenderWindow* mitk::IRenderWindowPart::GetQmitkRenderWindow ( const QString & id ) const

pure virtual

Get a render window with a specific id.

Parameters

id	The render window id.

Returns: The QmitkRenderWindow instance for id

Implemented in QmitkAbstractMultiWidgetEditor.

◆ GetQmitkRenderWindows()

virtual QHash<QString,QmitkRenderWindow*> mitk::IRenderWindowPart::GetQmitkRenderWindows ( ) const

pure virtual

Get all render windows with their ids.

Returns: A hash map mapping the render window id to the QmitkRenderWindow instance.

Implemented in QmitkAbstractMultiWidgetEditor.

◆ GetRenderingManager()

virtual mitk::IRenderingManager* mitk::IRenderWindowPart::GetRenderingManager ( ) const

pure virtual

Get the rendering manager used by this render window part.

Returns: The current IRenderingManager instance or nullptr if no rendering manager is used.

Implemented in QmitkAbstractRenderEditor.

◆ GetSelectedPosition()

virtual mitk::Point3D mitk::IRenderWindowPart::GetSelectedPosition ( const QString & id = QString() ) const

pure virtual

Get the selected position in the render window with id id or in the active render window if id is an empty string.

Parameters

id	The render window id.

Returns: The currently selected position in world coordinates.

Implemented in QmitkAbstractMultiWidgetEditor.

◆ GetSelectedTimePoint()

virtual TimePointType mitk::IRenderWindowPart::GetSelectedTimePoint ( const QString & id = QString() ) const

pure virtual

Get the time point selected in the render window with id id or in the active render window if id is an empty string.

Parameters

id	The render window id.

Returns: The currently selected position in world coordinates.

Implemented in QmitkAbstractRenderEditor.

◆ GetTimeNavigationController()

virtual mitk::TimeNavigationController* mitk::IRenderWindowPart::GetTimeNavigationController ( ) const

pure virtual

Get the TimeNavigationController for controlling time positions.

Returns: A TimeNavigationController if the render window supports this operation; otherwise returns nullptr.

Implemented in QmitkAbstractRenderEditor.

◆ HasCoupledRenderWindows()

virtual bool mitk::IRenderWindowPart::HasCoupledRenderWindows ( ) const

pure virtual

Returns true if the render windows are coupled; false if not.

Render windows are coupled if the slice navigation controller of the render windows are connected which means that always the same geometry is used for the render windows.

Implemented in QmitkAbstractMultiWidgetEditor.

◆ InitializeViews()

virtual void mitk::IRenderWindowPart::InitializeViews	(	const mitk::TimeGeometry *	geometry,
		bool	resetCamera
	)

pure virtual

Initialize the render windows of this render window part to the given geometry.

Parameters

geometry	The geometry to be used to initialize / update a render window's time and slice navigation controller.
resetCamera	If true, the camera and crosshair will be reset to the default view (centered, no zoom). If false, the current crosshair position and the camera zoom will be stored and reset after the reference geometry has been updated.

Implemented in QmitkAbstractMultiWidgetEditor.

◆ IsDecorationEnabled()

virtual bool mitk::IRenderWindowPart::IsDecorationEnabled ( const QString & decoration ) const

pure virtual

Return if a specific decoration is enabled.

Returns: true if the decoration is enabled, false if it is disabled or unknown.

See also: GetDecorations()

Implemented in QmitkAbstractMultiWidgetEditor.

◆ RequestUpdate()

virtual void mitk::IRenderWindowPart::RequestUpdate ( mitk::RenderingManager::RequestType requestType = mitk::RenderingManager::REQUEST_UPDATE_ALL )

pure virtual

Request an update of all render windows.

Parameters

requestType Specifies the type of render windows for which an update will be requested.

Implemented in QmitkAbstractRenderEditor.

◆ SetInteractionReferenceGeometry()

virtual void mitk::IRenderWindowPart::SetInteractionReferenceGeometry ( const mitk::TimeGeometry * referenceGeometry )

pure virtual

Define the reference geometry for interaction withing a render window.

   The concrete implementation is subclass-specific, no default implementation is provided here.
   An implementation can be found in 'QmitkAbstractMultiWidgetEditor' and will just
   forward the argument to the contained multi widget.

Parameters

referenceGeometry The interaction reference geometry for the concrete multi widget. For more details, see 'BaseRenderer::SetInteractionReferenceGeometry'.

Implemented in QmitkAbstractMultiWidgetEditor.

◆ SetSelectedPosition()

virtual void mitk::IRenderWindowPart::SetSelectedPosition	(	const mitk::Point3D &	pos,
		const QString &	id = `QString()`
	)

pure virtual

Set the selected position in the render window with id id or in the active render window if id is nullptr.

Parameters

pos	The position in world coordinates which should be selected.
id	The render window id in which the selection should take place.

Implemented in QmitkAbstractMultiWidgetEditor.

Member Data Documentation

◆ DECORATION_BACKGROUND

const QString mitk::IRenderWindowPart::DECORATION_BACKGROUND

static

Definition at line 59 of file mitkIRenderWindowPart.h.

◆ DECORATION_BORDER

const QString mitk::IRenderWindowPart::DECORATION_BORDER

static

Definition at line 56 of file mitkIRenderWindowPart.h.

◆ DECORATION_CORNER_ANNOTATION

const QString mitk::IRenderWindowPart::DECORATION_CORNER_ANNOTATION

static

Definition at line 60 of file mitkIRenderWindowPart.h.

◆ DECORATION_LOGO

const QString mitk::IRenderWindowPart::DECORATION_LOGO

static

Definition at line 57 of file mitkIRenderWindowPart.h.

◆ DECORATION_MENU

const QString mitk::IRenderWindowPart::DECORATION_MENU

static

Definition at line 58 of file mitkIRenderWindowPart.h.

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

mitkIRenderWindowPart.h

Public Member Functions

Static Public Attributes

Detailed Description

Constructor & Destructor Documentation

◆ ~IRenderWindowPart()

Member Function Documentation

◆ EnableDecorations()

◆ ForceImmediateUpdate()

◆ GetActiveQmitkRenderWindow()

◆ GetDecorations()

◆ GetQmitkRenderWindow() [1/2]

◆ GetQmitkRenderWindow() [2/2]

◆ GetQmitkRenderWindows()

◆ GetRenderingManager()

◆ GetSelectedPosition()

◆ GetSelectedTimePoint()

◆ GetTimeNavigationController()

◆ HasCoupledRenderWindows()

◆ InitializeViews()

◆ IsDecorationEnabled()

◆ RequestUpdate()

◆ SetInteractionReferenceGeometry()

◆ SetSelectedPosition()

Member Data Documentation

◆ DECORATION_BACKGROUND

◆ DECORATION_BORDER

◆ DECORATION_CORNER_ANNOTATION

◆ DECORATION_LOGO

◆ DECORATION_MENU