Slicer  5.3
Slicer is a multi-platform, free and open source software package for visualization and medical image computing
List of all members | Public Types | Public Slots | Public Member Functions | Protected Member Functions | Protected Attributes
qSlicerSceneViewsModule Class Reference

#include <Modules/Loadable/SceneViews/qSlicerSceneViewsModule.h>

Inheritance diagram for qSlicerSceneViewsModule:
Inheritance graph
Collaboration diagram for qSlicerSceneViewsModule:
Collaboration graph

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 Slots

void showSceneViewDialog ()
- Public Slots inherited from qSlicerAbstractCoreModule
virtual void setMRMLScene (vtkMRMLScene *)

Public Member Functions

QString acknowledgementText () const override
QStringList associatedNodeTypes () const override
 Specify editable node types. More...
QStringList categories () const override
QStringList contributors () const override
 Return the contributors of the module. More...
QString helpText () const override
 Return the help and acknowledgement text for the SceneViews module. More...
QIcon icon () const override
 Return the icon of the SceneViews module. More...
 qSlicerGetTitleMacro (QTMODULE_TITLE)
 qSlicerSceneViewsModule (QObject *parent=nullptr)
 ~qSlicerSceneViewsModule () 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)
qSlicerAbstractModuleRepresentationwidgetRepresentation ()
qSlicerAbstractModuleRepresentationcreateNewWidgetRepresentation ()
void setAppLogic (vtkSlicerApplicationLogic *appLogic)
vtkSlicerApplicationLogicappLogic () const
vtkMRMLAbstractLogicmoduleLogic (const QString &moduleName) const
 Convenience method for getting another module's logic from appLogic. More...
Q_INVOKABLE vtkMRMLAbstractLogiclogic ()
Q_INVOKABLE vtkMRMLScenemrmlScene () 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)

Protected Member Functions

vtkMRMLAbstractLogiccreateLogic () override
qSlicerAbstractModuleRepresentationcreateWidgetRepresentation () override
 Create and return a widget representation for the module. More...
void setup () override
 All initialization code should be done in the setup. More...
- Protected Member Functions inherited from qSlicerAbstractCoreModule

Protected Attributes

QScopedPointer< qSlicerSceneViewsModulePrivate > 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
- 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...

Detailed Description

Definition at line 16 of file qSlicerSceneViewsModule.h.

Member Typedef Documentation

◆ Superclass

Definition at line 24 of file qSlicerSceneViewsModule.h.

Constructor & Destructor Documentation

◆ qSlicerSceneViewsModule()

qSlicerSceneViewsModule::qSlicerSceneViewsModule ( QObject *  parent = nullptr)

◆ ~qSlicerSceneViewsModule()

qSlicerSceneViewsModule::~qSlicerSceneViewsModule ( )

Member Function Documentation

◆ acknowledgementText()

QString qSlicerSceneViewsModule::acknowledgementText ( ) const

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

Reimplemented from qSlicerLoadableModule.

◆ associatedNodeTypes()

QStringList qSlicerSceneViewsModule::associatedNodeTypes ( ) const

Specify editable node types.

Reimplemented from qSlicerAbstractCoreModule.

◆ categories()

QStringList qSlicerSceneViewsModule::categories ( ) const

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 qSlicerSceneViewsModule::contributors ( ) const

Return the contributors of the module.

Reimplemented from qSlicerAbstractCoreModule.

◆ createLogic()

vtkMRMLAbstractLogic* qSlicerSceneViewsModule::createLogic ( )

Create and return the module logic Note: Only one instance of the logic will exist per module

Implements qSlicerAbstractCoreModule.

◆ createWidgetRepresentation()

qSlicerAbstractModuleRepresentation* qSlicerSceneViewsModule::createWidgetRepresentation ( )

Create and return a widget representation for the module.

Implements qSlicerAbstractCoreModule.

◆ helpText()

QString qSlicerSceneViewsModule::helpText ( ) const

Return the help and acknowledgement text for the SceneViews module.

Reimplemented from qSlicerLoadableModule.

◆ icon()

QIcon qSlicerSceneViewsModule::icon ( ) const

Return the icon of the SceneViews module.

Reimplemented from qSlicerAbstractModule.

◆ qSlicerGetTitleMacro()

qSlicerSceneViewsModule::qSlicerGetTitleMacro ( QTMODULE_TITLE  )

◆ setup()

void qSlicerSceneViewsModule::setup ( )

All initialization code should be done in the setup.

Reimplemented from qSlicerLoadableModule.

◆ showSceneViewDialog

void qSlicerSceneViewsModule::showSceneViewDialog ( )

a public slot to open up the scene view capture dialog (get the module manager, get the module sceneviews, get the widget representation, then invoke this method

See also

Member Data Documentation

◆ d_ptr

QScopedPointer<qSlicerSceneViewsModulePrivate> qSlicerSceneViewsModule::d_ptr

Definition at line 63 of file qSlicerSceneViewsModule.h.

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