QmitkAbstractRenderEditor Class Reference

A convenient base class for MITK render window BlueBerry Editors. More...

#include <QmitkAbstractRenderEditor.h>

Inheritance diagram for QmitkAbstractRenderEditor:

Collaboration diagram for QmitkAbstractRenderEditor:

Public Member Functions
	berryObjectMacro (QmitkAbstractRenderEditor, QtEditorPart, mitk::IRenderWindowPart) QmitkAbstractRenderEditor()
	~QmitkAbstractRenderEditor ()
Public Member Functions inherited from berry::QtEditorPart
	berryObjectMacro (QtEditorPart, EditorPart) void CreatePartControl(QWidget *parent) override
Public Member Functions inherited from berry::EditorPart
IEditorInput::Pointer	GetEditorInput () const override
IEditorSite::Pointer	GetEditorSite () const override
QString	GetTitleToolTip () const override
virtual bool	IsSaveOnCloseNeeded () const override
Public Member Functions inherited from berry::WorkbenchPart
	berryObjectMacro (WorkbenchPart, QObject, IWorkbenchPart, IExecutableExtension)~WorkbenchPart()
void	AddPropertyListener (IPropertyChangeListener *l) override
void	RemovePropertyListener (IPropertyChangeListener *l) override
void	SetPartProperty (const QString &key, const QString &value) override
QString	GetPartProperty (const QString &key) const override
const QHash< QString, QString > &	GetPartProperties () const override
void	SetInitializationData (const IConfigurationElement::Pointer &cfig, const QString &propertyName, const Object::Pointer &data) override
virtual void	CreatePartControl (QWidget *parent) override=0
virtual void	SetFocus () override=0
IWorkbenchPartSite::Pointer	GetSite () const override
QString	GetPartName () const override
QString	GetContentDescription () const override
QIcon	GetTitleImage () const override
QString	GetTitleToolTip () const override
Public Member Functions inherited from berry::IWorkbenchPart
	berryObjectMacro (berry::IWorkbenchPart, Object) virtual ~IWorkbenchPart()
Public Member Functions inherited from berry::Object
virtual QString	GetClassName () const
virtual Reflection::TypeInfo	GetTypeInfo () const
virtual QList< Reflection::TypeInfo >	GetSuperclasses () const
virtual void	Delete ()
QDebug	Print (QDebug os, Indent Indent=0) const
virtual QString	ToString () const
virtual uint	HashCode () const
virtual bool	operator< (const Object *) const
void	Register () const
void	UnRegister (bool del=true) const
int	GetReferenceCount () const
void	SetReferenceCount (int)
void	AddDestroyListener (const MessageAbstractDelegate<> &delegate) const
void	RemoveDestroyListener (const MessageAbstractDelegate<> &delegate) const
virtual bool	operator== (const Object *) const
Public Member Functions inherited from berry::IExecutableExtension
virtual	~IExecutableExtension ()
virtual void	SetInitializationData (const SmartPointer< IConfigurationElement > &config, const QString &propertyName, const Object::Pointer &data)=0
Public Member Functions inherited from berry::IEditorPart
	berryObjectMacro (berry::IEditorPart, IWorkbenchPart, ISaveablePart) virtual ~IEditorPart()
virtual void	Init (SmartPointer< IEditorSite > site, SmartPointer< IEditorInput > input)=0
Public Member Functions inherited from berry::ISaveablePart
	berryObjectMacro (berry::ISaveablePart) static const int PROP_DIRTY
Public Member Functions inherited from mitk::IRenderWindowPart
virtual	~IRenderWindowPart ()
virtual QmitkRenderWindow *	GetActiveQmitkRenderWindow () const =0
virtual QHash< QString, QmitkRenderWindow * >	GetQmitkRenderWindows () const =0
virtual QmitkRenderWindow *	GetQmitkRenderWindow (const QString &id) 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

Protected Member Functions
void	Init (berry::IEditorSite::Pointer site, berry::IEditorInput::Pointer input) override
virtual mitk::IDataStorageReference::Pointer	GetDataStorageReference () const
virtual mitk::DataStorage::Pointer	GetDataStorage () const
virtual berry::IPreferences::Pointer	GetPreferences () const
mitk::IRenderingManager *	GetRenderingManager () const override
void	RequestUpdate (mitk::RenderingManager::RequestType requestType=mitk::RenderingManager::REQUEST_UPDATE_ALL) override
void	ForceImmediateUpdate (mitk::RenderingManager::RequestType requestType=mitk::RenderingManager::REQUEST_UPDATE_ALL) override
mitk::SliceNavigationController *	GetTimeNavigationController () const override
void	DoSave () override
void	DoSaveAs () override
bool	IsDirty () const override
bool	IsSaveAsAllowed () const override
Protected Member Functions inherited from berry::QtEditorPart
virtual void	CreateQtPartControl (QWidget *parent)=0
Protected Member Functions inherited from berry::EditorPart
	EditorPart ()
virtual void	SetInput (IEditorInput::Pointer input)
virtual void	SetInputWithNotify (IEditorInput::Pointer input)
virtual void	SetContentDescription (const QString &description) override
virtual void	SetPartName (const QString &partName) override
void	CheckSite (IWorkbenchPartSite::Pointer site) override
Protected Member Functions inherited from berry::WorkbenchPart
	WorkbenchPart ()
IConfigurationElement::Pointer	GetConfigurationElement () const
void	SetSite (IWorkbenchPartSite::Pointer site)
virtual void	SetTitleImage (const QIcon &titleImage)
virtual void	SetTitleToolTip (const QString &toolTip)
void	FirePropertyChanged (const QString &key, const QString &oldValue, const QString &newValue)
void	FirePropertyChange (int propertyId)
Protected Member Functions inherited from berry::Object
	Object ()
virtual	~Object ()
virtual QDebug	PrintSelf (QDebug os, Indent indent) const
virtual QDebug	PrintHeader (QDebug os, Indent indent) const
virtual QDebug	PrintTrailer (QDebug os, Indent indent) const

Additional Inherited Members
Public Types inherited from berry::Object
typedef Object	Self
typedef berry::SmartPointer< Self >	Pointer
typedef berry::SmartPointer< const Self >	ConstPointer
typedef berry::WeakPointer< Self >	WeakPtr
typedef berry::WeakPointer< const Self >	ConstWeakPtr
Static Public Member Functions inherited from berry::Object
static const char *	GetStaticClassName ()
static Reflection::TypeInfo	GetStaticTypeInfo ()
static QList< Reflection::TypeInfo >	GetStaticSuperclasses ()
Static Public Attributes inherited from mitk::IRenderWindowPart
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
Protected Attributes inherited from berry::Object
QAtomicInt	m_ReferenceCount
QMutex	m_ReferenceCountLock

Detailed Description

A convenient base class for MITK render window BlueBerry Editors.

QmitkAbstractRenderEditor provides several convenience methods that ease the introduction of a new editor for rendering a MITK DataStorage:

1. Access to the DataStorage (~ the shared data repository)
2. Access to and update notification for the editor's preferences
3. Default implementation of some mitk::IRenderWindowPart methods

When inheriting from QmitkAbstractRenderEditor, you must implement the following methods:

• void CreateQtPartControl(QWidget* parent)
• void SetFocus()

You may reimplement the following private virtual methods to be notified about certain changes:

• void OnPreferencesChanged(const berry::IBerryPreferences*)

See also

IRenderWindowPart

ILinkedRenderWindowPart

Definition at line 61 of file QmitkAbstractRenderEditor.h.

Constructor & Destructor Documentation

QmitkAbstractRenderEditor::~QmitkAbstractRenderEditor

(

)

Definition at line 55 of file QmitkAbstractRenderEditor.cpp.

Member Function Documentation

QmitkAbstractRenderEditor::berryObjectMacro	(	QmitkAbstractRenderEditor	,
		QtEditorPart	,
		mitk::IRenderWindowPart
	)

void QmitkAbstractRenderEditor::DoSave ( )

overrideprotectedvirtual

See also

berry::IEditorPart::DoSave

Implements berry::EditorPart.

Definition at line 136 of file QmitkAbstractRenderEditor.cpp.

void QmitkAbstractRenderEditor::DoSaveAs ( )

overrideprotectedvirtual

See also

berry::IEditorPart::DoSaveAs

Implements berry::EditorPart.

Definition at line 139 of file QmitkAbstractRenderEditor.cpp.

void QmitkAbstractRenderEditor::ForceImmediateUpdate ( mitk::RenderingManager::RequestType  requestType = mitk::RenderingManager::REQUEST_UPDATE_ALL )

overrideprotectedvirtual

Force an immediate update of this editor's render windows. This implementation calls mitk::IRenderingManager::ForceImmediateUpdate() on the rendering manager interface returned by GetRenderingManager();

Parameters

requestType

The type of render windows for which an immedate update is forced.

See also

mitk::IRenderWindowPart::ForceImmediateUpdate

Implements mitk::IRenderWindowPart.

Definition at line 120 of file QmitkAbstractRenderEditor.cpp.

References mitk::IRenderingManager::ForceImmediateUpdateAll(), and GetRenderingManager().

mitk::DataStorage::Pointer QmitkAbstractRenderEditor::GetDataStorage ( ) const

protectedvirtual

Get the DataStorage set by the editor input.

Definition at line 90 of file QmitkAbstractRenderEditor.cpp.

References GetDataStorageReference(), and berry::SmartPointer< TObjectType >::IsNotNull().

Referenced by QmitkStdMultiWidgetEditor::CreateQtPartControl(), and QmitkStdMultiWidgetEditor::OnPreferencesChanged().

mitk::IDataStorageReference::Pointer QmitkAbstractRenderEditor::GetDataStorageReference ( ) const

protectedvirtual

Get a reference to the DataStorage set by the editor input.

Definition at line 80 of file QmitkAbstractRenderEditor.cpp.

References berry::SmartPointer< TObjectType >::Cast(), berry::EditorPart::GetEditorInput(), and berry::SmartPointer< TObjectType >::IsNotNull().

Referenced by GetDataStorage().

berry::IPreferences::Pointer QmitkAbstractRenderEditor::GetPreferences ( ) const

protectedvirtual

Get the preferences for this editor.

Definition at line 97 of file QmitkAbstractRenderEditor.cpp.

References berry::WorkbenchPart::GetSite(), and berry::IPreferencesService::GetSystemPreferences().

Referenced by QmitkStdMultiWidgetEditor::CreateQtPartControl(), and Init().

mitk::IRenderingManager * QmitkAbstractRenderEditor::GetRenderingManager ( ) const

overrideprotectedvirtual

Get the RenderingManager used by this editor. This default implementation uses the global MITK RenderingManager provided by mitk::RenderingManager::GetInstance().

See also

mitk::IRenderWindowPart::GetRenderingManager

Implements mitk::IRenderWindowPart.

Definition at line 107 of file QmitkAbstractRenderEditor.cpp.

Referenced by ForceImmediateUpdate(), GetTimeNavigationController(), and RequestUpdate().

mitk::SliceNavigationController * QmitkAbstractRenderEditor::GetTimeNavigationController ( ) const

overrideprotectedvirtual

Get the time navigation controller for this editor. This implementation returns the SliceNavigationController returned by the mitk::IRenderingManager::GetTimeNavigationController() method of the interface implementation returned by GetRenderingManager().

See also

mitk::IRenderingManager::GetTimeNavigationController

Implements mitk::IRenderWindowPart.

Definition at line 126 of file QmitkAbstractRenderEditor.cpp.

References GetRenderingManager(), and mitk::IRenderingManager::GetTimeNavigationController().

void QmitkAbstractRenderEditor::Init ( berry::IEditorSite::Pointer  site, berry::IEditorInput::Pointer  input  )

overrideprotectedvirtual

Initializes this editor by checking for a valid mitk::DataStorageEditorInput as input.

See also

berry::IEditorPart::Init

Implements berry::EditorPart.

Definition at line 64 of file QmitkAbstractRenderEditor.cpp.

References berry::SmartPointer< TObjectType >::Cast(), GetPreferences(), berry::EditorPart::SetInput(), and berry::WorkbenchPart::SetSite().

bool QmitkAbstractRenderEditor::IsDirty ( ) const

overrideprotectedvirtual

See also

berry::IEditorPart::IsDirty

Implements berry::EditorPart.

Definition at line 142 of file QmitkAbstractRenderEditor.cpp.

bool QmitkAbstractRenderEditor::IsSaveAsAllowed ( ) const

overrideprotectedvirtual

See also

berry::IEditorPart::IsSaveAsAllowed

Implements berry::EditorPart.

Definition at line 145 of file QmitkAbstractRenderEditor.cpp.

void QmitkAbstractRenderEditor::RequestUpdate ( mitk::RenderingManager::RequestType  requestType = mitk::RenderingManager::REQUEST_UPDATE_ALL )

overrideprotectedvirtual

Request an update of this editor's render windows. This implementation calls mitk::IRenderingManager::RequestUpdate on the rendering manager interface returned by GetRenderingManager();

Parameters

requestType

The type of render windows for which an update is requested.

See also

mitk::IRenderWindowPart::RequestUpdate

Implements mitk::IRenderWindowPart.

Definition at line 114 of file QmitkAbstractRenderEditor.cpp.

References GetRenderingManager(), and mitk::IRenderingManager::RequestUpdateAll().

Referenced by QmitkStdMultiWidgetEditor::CreateQtPartControl().

---

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

• QmitkAbstractRenderEditor.h
• QmitkAbstractRenderEditor.cpp