Medical Imaging Interaction Toolkit  2016.11.0
Medical Imaging Interaction Toolkit
mitk::IRenderWindowPart Struct Referenceabstract

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

#include <mitkIRenderWindowPart.h>

Inheritance diagram for mitk::IRenderWindowPart:

Public Member Functions

virtual ~IRenderWindowPart ()
 
virtual QmitkRenderWindowGetActiveQmitkRenderWindow () const =0
 
virtual QHash< QString, QmitkRenderWindow * > GetQmitkRenderWindows () const =0
 
virtual QmitkRenderWindowGetQmitkRenderWindow (const QString &id) const =0
 
virtual mitk::IRenderingManagerGetRenderingManager () 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 mitk::SliceNavigationControllerGetTimeNavigationController () 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 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. However, implementations should consider to use one of the following ids for certain QmitkRenderWindow instances to maximize reusability (they are free to map multiple ids to one QmitkRenderWindow internally):

  • axial
  • sagittal
  • coronal
  • 3d
See also
ILinkedRenderWindowPart
IRenderWindowPartListener
QmitkAbstractRenderEditor

Definition at line 63 of file mitkIRenderWindowPart.h.

Constructor & Destructor Documentation

mitk::IRenderWindowPart::~IRenderWindowPart ( )
virtual

Definition at line 27 of file mitkIRenderWindowPart.cpp.

Member Function Documentation

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
enableIf true enable the decorations specified in decorations, otherwise disable them.
decorationsA list of decoration names. If empty, all supported decorations are affected.
See also
GetDecorations()

Implemented in QmitkStdMultiWidgetEditor.

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
requestTypeSpecifies the type of render windows for which an immediate update will be requested.

Implemented in QmitkAbstractRenderEditor.

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; NULL if no render window is active.

Implemented in QmitkStdMultiWidgetEditor.

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 QmitkStdMultiWidgetEditor.

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

Get a render window with a specific id.

Parameters
idThe render window id.
Returns
The QmitkRenderWindow instance for id

Implemented in QmitkStdMultiWidgetEditor.

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 QmitkStdMultiWidgetEditor.

Referenced by QmitkSliceNavigationListener::InitObservers().

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 NULL if no rendering manager is used.

Implemented in QmitkAbstractRenderEditor.

Referenced by QmitkDataManagerView::ReinitSelectedNodes(), and QmitkAbstractView::RequestRenderWindowUpdate().

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 NULL.

Parameters
idThe render window id.
Returns
The currently selected position in world coordinates.

Implemented in QmitkStdMultiWidgetEditor.

virtual mitk::SliceNavigationController* mitk::IRenderWindowPart::GetTimeNavigationController ( ) const
pure virtual

Get the SliceNavigationController for controlling time positions.

Returns
A SliceNavigationController if the render window supports this operation; otherwise returns NULL.

Implemented in QmitkAbstractRenderEditor.

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 QmitkStdMultiWidgetEditor.

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

Request an update of all render windows.

Parameters
requestTypeSpecifies the type of render windows for which an update will be requested.

Implemented in QmitkAbstractRenderEditor.

Referenced by QmitkAbstractView::RequestRenderWindowUpdate().

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 NULL.

Parameters
posThe position in world coordinates which should be selected.
idThe render window id in which the selection should take place.

Implemented in QmitkStdMultiWidgetEditor.

Member Data Documentation

const QString mitk::IRenderWindowPart::DECORATION_BACKGROUND
static
const QString mitk::IRenderWindowPart::DECORATION_BORDER
static
const QString mitk::IRenderWindowPart::DECORATION_CORNER_ANNOTATION
static
const QString mitk::IRenderWindowPart::DECORATION_LOGO
static
const QString mitk::IRenderWindowPart::DECORATION_MENU
static

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