#include <Modules/Loadable/ViewControllers/qSlicerViewControllersModule.h>

Inheritance diagram for qSlicerViewControllersModule:

Collaboration diagram for qSlicerViewControllersModule:

Public Types
typedef qSlicerLoadableModule	Superclass

Public Types inherited from qSlicerLoadableModule
typedef qSlicerLoadableModule	Self

typedef qSlicerAbstractModule	Superclass

Public Types inherited from qSlicerAbstractModule
typedef qSlicerAbstractCoreModule	Superclass

Public Types inherited from qSlicerAbstractCoreModule
typedef QObject	Superclass

Public Member Functions
QString	acknowledgementText () const override

QStringList	categories () const override

QStringList	contributors () const override
	Return the contributors of the module. More...

QString	helpText () const override
	Return help/acknowledgement text. More...

QIcon	icon () const override

	qSlicerGetTitleMacro (QTMODULE_TITLE)

	qSlicerViewControllersModule (QObject *parent=nullptr)

void	readDefaultPlotViewSettings (vtkMRMLPlotViewNode *defaultViewNode)

void	readDefaultSliceViewSettings (vtkMRMLSliceNode *defaultViewNode)

void	setMRMLScene (vtkMRMLScene *scene) override

void	writeDefaultPlotViewSettings (vtkMRMLPlotViewNode *defaultViewNode)

	~qSlicerViewControllersModule () override

Public Member Functions inherited from qSlicerLoadableModule
	qSlicerLoadableModule (QObject *parent=nullptr)

	~qSlicerLoadableModule () override

Public Member Functions inherited from qSlicerAbstractModule
Q_INVOKABLE QAction *	action ()

virtual QImage	logo () const
	The logo of the module, the credits given by the grants or instution. More...

	qSlicerAbstractModule (QObject *parent=nullptr)

	~qSlicerAbstractModule () override

Public Member Functions inherited from qSlicerAbstractCoreModule
	qSlicerAbstractCoreModule (QObject *parent=nullptr)

	~qSlicerAbstractCoreModule () override

virtual void	printAdditionalInfo ()

QString	slicerWikiUrl () const
	Convenience method to return slicer wiki URL. More...

QString	defaultDocumentationLink () const

void	initialize (vtkSlicerApplicationLogic *appLogic)

virtual QString	name () const

virtual void	setName (const QString &name)

virtual QString	title () const =0

virtual int	index () const
	Return the category index of the module. More...

virtual bool	isHidden () const

bool	isWidgetRepresentationCreationEnabled () const

void	setWidgetRepresentationCreationEnabled (bool value)

qSlicerAbstractModuleRepresentation *	widgetRepresentation ()

qSlicerAbstractModuleRepresentation *	createNewWidgetRepresentation ()

void	setAppLogic (vtkSlicerApplicationLogic *appLogic)

vtkSlicerApplicationLogic *	appLogic () const

vtkMRMLAbstractLogic *	moduleLogic (const QString &moduleName) const
	Convenience method for getting another module's logic from appLogic. More...

Q_INVOKABLE vtkMRMLAbstractLogic *	logic ()

Q_INVOKABLE vtkMRMLScene *	mrmlScene () const
	Return a pointer on the MRML scene. More...

virtual QStringList	dependencies () const

QString	path () const

void	setPath (const QString &newPath)

bool	isInstalled () const

void	setInstalled (bool value)

bool	isBuiltIn () const

void	setBuiltIn (bool value)

virtual QStringList	associatedNodeTypes () const
	Return node types associated with this module (e.g., node types this module can edit) More...

Static Public Member Functions
static void	readDefaultThreeDViewSettings (vtkMRMLViewNode *defaultViewNode)

static void	writeDefaultSliceViewSettings (vtkMRMLSliceNode *defaultViewNode)

static void	writeDefaultThreeDViewSettings (vtkMRMLViewNode *defaultViewNode)

Static Public Member Functions inherited from qSlicerLoadableModule
static bool	addModuleNameToSlicerModuleNames (qSlicerCorePythonManager *pythonManager, const QString &moduleName)

static bool	addModuleToSlicerModules (qSlicerCorePythonManager pythonManager, qSlicerAbstractModule module, const QString &moduleName)

static bool	importModulePythonExtensions (qSlicerCorePythonManager *pythonManager, const QString &intDir, const QString &modulePath, bool isEmbedded=false)
	Import python extensions associated with modulePath. More...

Protected Member Functions
vtkMRMLAbstractLogic *	createLogic () override
	Create and return the logic associated to this module. More...

qSlicerAbstractModuleRepresentation *	createWidgetRepresentation () override
	Create and return the widget representation associated to this module. More...

void	setup () override
	Initialize the module. Register the volumes reader/writer. More...

Protected Member Functions inherited from qSlicerAbstractCoreModule

Static Protected Member Functions
static void	readCommonViewSettings (vtkMRMLAbstractViewNode *defaultViewNode, QSettings &settings)
	Helper functions to read/write common view settings. More...

static void	writeCommonViewSettings (vtkMRMLAbstractViewNode *defaultViewNode, QSettings &settings)

Protected Attributes
QScopedPointer< qSlicerViewControllersModulePrivate >	d_ptr

Protected Attributes inherited from qSlicerLoadableModule
QScopedPointer< qSlicerLoadableModulePrivate >	d_ptr

Protected Attributes inherited from qSlicerAbstractModule
QScopedPointer< qSlicerAbstractModulePrivate >	d_ptr

Protected Attributes inherited from qSlicerAbstractCoreModule
QScopedPointer< qSlicerAbstractCoreModulePrivate >	d_ptr

Additional Inherited Members
Properties inherited from qSlicerAbstractModule
QIcon	icon

QImage	logo

Properties inherited from qSlicerAbstractCoreModule
QString	name

QString	title

QStringList	categories

int	index

bool	hidden

bool	widgetRepresentationCreationEnabled

QString	helpText

QString	acknowledgementText

QStringList	contributors

QString	slicerWikiUrl

QString	defaultDocumentationLink

QStringList	dependencies

QString	path

bool	isInstalled

bool	isBuiltIn

QStringList	associatedNodeTypes

Public Slots inherited from qSlicerAbstractCoreModule

Detailed Description

Definition at line 37 of file qSlicerViewControllersModule.h.

Member Typedef Documentation

◆ Superclass

typedef qSlicerLoadableModule qSlicerViewControllersModule::Superclass

Definition at line 46 of file qSlicerViewControllersModule.h.

Constructor & Destructor Documentation

◆ qSlicerViewControllersModule()

qSlicerViewControllersModule::qSlicerViewControllersModule ( QObject * parent = nullptr )

◆ ~qSlicerViewControllersModule()

qSlicerViewControllersModule::~qSlicerViewControllersModule ( )

override

Member Function Documentation

◆ acknowledgementText()

QString qSlicerViewControllersModule::acknowledgementText ( ) const

overridevirtual

Return acknowledgement text for the module Must be reimplemented in the derived classes

Reimplemented from qSlicerLoadableModule.

◆ categories()

QStringList qSlicerViewControllersModule::categories ( ) const

overridevirtual

Categories the module belongs to. Categories support subcategories. Use the '.' separator to specify a subcategory (no depth limit), e.g.: "Filtering.Arithmetic". The function must be reimplemented in derived classes. Note: If a category doesn't exist, it will be created.

Reimplemented from qSlicerAbstractCoreModule.

◆ contributors()

QStringList qSlicerViewControllersModule::contributors ( ) const

overridevirtual

Return the contributors of the module.

Reimplemented from qSlicerAbstractCoreModule.

◆ createLogic()

vtkMRMLAbstractLogic* qSlicerViewControllersModule::createLogic ( )

overrideprotectedvirtual

Create and return the logic associated to this module.

Implements qSlicerAbstractCoreModule.

◆ createWidgetRepresentation()

qSlicerAbstractModuleRepresentation* qSlicerViewControllersModule::createWidgetRepresentation ( )

overrideprotectedvirtual

Create and return the widget representation associated to this module.

Implements qSlicerAbstractCoreModule.

◆ helpText()

QString qSlicerViewControllersModule::helpText ( ) const

overridevirtual

Return help/acknowledgement text.

Reimplemented from qSlicerLoadableModule.

◆ icon()

QIcon qSlicerViewControllersModule::icon ( ) const

overridevirtual

Icon of the module. Anytime a graphical representation of the module is needed, the icon is used. It's the icon shown in the module selector as well as in the frequently used module toolbar (if any).

Reimplemented from qSlicerAbstractModule.

◆ qSlicerGetTitleMacro()

qSlicerViewControllersModule::qSlicerGetTitleMacro ( QTMODULE_TITLE )

◆ readCommonViewSettings()

static void qSlicerViewControllersModule::readCommonViewSettings	(	vtkMRMLAbstractViewNode *	defaultViewNode,
		QSettings &	settings
	)

staticprotected

Helper functions to read/write common view settings.

◆ readDefaultPlotViewSettings()

void qSlicerViewControllersModule::readDefaultPlotViewSettings ( vtkMRMLPlotViewNode * defaultViewNode )

Read default plot view settings from application settings (.ini file) into defaultViewNode.

◆ readDefaultSliceViewSettings()

void qSlicerViewControllersModule::readDefaultSliceViewSettings ( vtkMRMLSliceNode * defaultViewNode )

Read default slice view settings from application settings (.ini file) into defaultViewNode.

◆ readDefaultThreeDViewSettings()

static void qSlicerViewControllersModule::readDefaultThreeDViewSettings ( vtkMRMLViewNode * defaultViewNode )

static

Write default slice view settings to application settings (.ini file) from defaultViewNode.

◆ setMRMLScene()

void qSlicerViewControllersModule::setMRMLScene ( vtkMRMLScene * scene )

overridevirtual

Set MRML scene for the module. Updates the default view settings based on the application settings.

Reimplemented from qSlicerAbstractCoreModule.

◆ setup()

void qSlicerViewControllersModule::setup ( )

overrideprotectedvirtual

Initialize the module. Register the volumes reader/writer.

Reimplemented from qSlicerLoadableModule.

◆ writeCommonViewSettings()

static void qSlicerViewControllersModule::writeCommonViewSettings	(	vtkMRMLAbstractViewNode *	defaultViewNode,
		QSettings &	settings
	)

staticprotected

◆ writeDefaultPlotViewSettings()

void qSlicerViewControllersModule::writeDefaultPlotViewSettings ( vtkMRMLPlotViewNode * defaultViewNode )

Write default plot view settings to application settings (.ini file) from defaultViewNode.

◆ writeDefaultSliceViewSettings()

static void qSlicerViewControllersModule::writeDefaultSliceViewSettings ( vtkMRMLSliceNode * defaultViewNode )

static

Read default 3D view settings from application settings (.ini file) into defaultViewNode.

◆ writeDefaultThreeDViewSettings()

static void qSlicerViewControllersModule::writeDefaultThreeDViewSettings ( vtkMRMLViewNode * defaultViewNode )

static

Write default 3D view settings to application settings (.ini file) from defaultViewNode.

Member Data Documentation

◆ d_ptr

QScopedPointer<qSlicerViewControllersModulePrivate> qSlicerViewControllersModule::d_ptr

protected

Definition at line 101 of file qSlicerViewControllersModule.h.

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

Modules/Loadable/ViewControllers/qSlicerViewControllersModule.h

Public Types

Public Member Functions

Static Public Member Functions

Protected Member Functions

Static Protected Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Member Typedef Documentation

◆ Superclass

Constructor & Destructor Documentation

◆ qSlicerViewControllersModule()

◆ ~qSlicerViewControllersModule()

Member Function Documentation

◆ acknowledgementText()

◆ categories()

◆ contributors()

◆ createLogic()

◆ createWidgetRepresentation()

◆ helpText()

◆ icon()

◆ qSlicerGetTitleMacro()

◆ readCommonViewSettings()

◆ readDefaultPlotViewSettings()

◆ readDefaultSliceViewSettings()

◆ readDefaultThreeDViewSettings()

◆ setMRMLScene()

◆ setup()

◆ writeCommonViewSettings()

◆ writeDefaultPlotViewSettings()

◆ writeDefaultSliceViewSettings()

◆ writeDefaultThreeDViewSettings()

Member Data Documentation

◆ d_ptr