Documentation/4.0/Developers/Modules - Revision history

Unknown user: Text replacement - "slicerWiki/index.php" to "wiki"

2019-11-21T17:05:00Z

Text replacement - "slicerWiki/index.php" to "wiki"

UpdateBot: Prepend documentation/versioncheck template. See http://na-mic.org/Mantis/view.php?id=2887

2013-06-14T07:31:27Z

Prepend documentation/versioncheck template. See http://na-mic.org/Mantis/view.php?id=2887

Dmwelch: /* Scripted Modules */ Fixed link

2012-05-17T18:38:30Z

Scripted Modules: Fixed link

Finetjul: /* ToDo */

2012-02-27T23:10:10Z

ToDo

Finetjul: /* Module Factory */

2012-02-22T20:16:50Z

Module Factory

JChris.FillionR: /* ToDo */

2012-02-21T05:29:50Z

ToDo

JChris.FillionR at 05:25, 21 February 2012

2012-02-21T05:25:41Z

Finetjul: Add module factory manager

2012-02-21T04:55:28Z

Add module factory manager

Finetjul at 16:59, 11 January 2012

2012-01-11T16:59:48Z

Finetjul: /* Command Line Interface (CLI) */ Add link

2012-01-11T16:58:13Z

Command Line Interface (CLI): Add link

@@ Line 25: / Line 25: @@
 * Recommended for fast prototyping
 * Links:
-** [http://www.slicer.org/slicerWiki/index.php/Documentation/4.0/Developers/Python_scripting Python Scripting]
+** [http://www.slicer.org/wiki/Documentation/4.0/Developers/Python_scripting Python Scripting]
 =Module Factory=

← Older revision		Revision as of 07:31, 14 June 2013
Line 1:		Line 1:
		+	<noinclude>{{documentation/versioncheck}}</noinclude>
	Slicer 4 supports 3 types of modules. While the developer has to choose between one of the 3 types to implement its module, the end user won't notice a difference as they all share the look&feel. The choice for a given type of module is usually based on the type of inputs/parameters for a given module.		Slicer 4 supports 3 types of modules. While the developer has to choose between one of the 3 types to implement its module, the end user won't notice a difference as they all share the look&feel. The choice for a given type of module is usually based on the type of inputs/parameters for a given module.
	= Command Line Interface (CLI) =		= Command Line Interface (CLI) =

@@ Line 24: / Line 24: @@
 * Recommended for fast prototyping
 * Links:
-** [http://www.slicer.org/slicerWiki/index.php/Documentation/4.0/Developers/Python_scripting|Python Scripting]
+** [http://www.slicer.org/slicerWiki/index.php/Documentation/4.0/Developers/Python_scripting Python Scripting]
 =Module Factory=

@@ Line 41: / Line 41: @@
 * Move factory registration in qSlicerApplication (or a general application library) to support module discovery/loading without needing to instantiate Slicer.
 ** Currently can't be moved into qSlicerApplication as the CLI factories that are in QTCLI depend on QTGUI
 ** Proposed architecture
   Base

@@ Line 28: / Line 28: @@
 =Module Factory=
 Loading modules into slicer happens in multiple steps:
-*module factories must be registered into the factory manager:
+*module factories must be registered into the factory manager
 * directories where the modules to load are located must be passed to the factory manager
 * Optionally specify module names to ignore
 * scan the directories and test which file is a module and register it (not instantiated yet)
 * Instantiate all the register modules
 * Connect each module with the scene and the application
-The application logic and the scene are passed to each module. The order of initialization is defined with the dependencies of the modules. If module B depends of module A, it is assured that module B is initialized/setup after A.
+More details can be found in the [http://slicer.org/doc/html/classqSlicerAbstractModuleFactoryManager.html online doc]
- factoryManager->loadModules();
 ==ToDo==
 * Transform all core modules into Loadable modules.
@@ Line 69: / Line 57: @@
 ** To have the settings panel be generic but have the code proper of each registered factory somewhere else
 * Add mechanism for modules to register dialogs (toolbars that open dialogs),  e.g. the sceneview module needs to register the sceneView dialog into an icon.

← Older revision		Revision as of 05:25, 21 February 2012
Line 1:		Line 1:
−	~~Back to [[Documentation/{{documentation/version}}/Developers\|Developers Information]]←~~
−
	Slicer 4 supports 3 types of modules. While the developer has to choose between one of the 3 types to implement its module, the end user won't notice a difference as they all share the look&feel. The choice for a given type of module is usually based on the type of inputs/parameters for a given module.		Slicer 4 supports 3 types of modules. While the developer has to choose between one of the 3 types to implement its module, the end user won't notice a difference as they all share the look&feel. The choice for a given type of module is usually based on the type of inputs/parameters for a given module.
	= Command Line Interface (CLI) =		= Command Line Interface (CLI) =

← Older revision		Revision as of 04:55, 21 February 2012
Line 27:		Line 27:
	* Links:		* Links:
	** [http://www.slicer.org/slicerWiki/index.php/Documentation/4.0/Developers/Python_scripting\|Python Scripting]		** [http://www.slicer.org/slicerWiki/index.php/Documentation/4.0/Developers/Python_scripting\|Python Scripting]
		+
		+	=Module Factory=
		+	Loading modules into slicer happens in multiple steps:
		+	*module factories must be registered into the factory manager:
		+	qSlicerModuleFactoryManager* factoryManager = app->moduleManager()->factoryManager();
		+	factoryManager->registerFactory(new qSlicerLoadableModuleFactory);
		+	...
		+	* directories where the modules to load are located must be passed to the factory manager
		+	factoryManager->addSearchPath(app->slicerHome() + "/" + Slicer_QTSCRIPTEDMODULES_LIB_DIR + "/" );
		+	factoryManager->addSearchPath(app->slicerHome() + "/" + Slicer_CLIMODULES_LIB_DIR + "/" );
		+	...
		+	* Optionally specify module names to ignore
		+	For startup speed-up and memory consummation, it can be useful to not load some modules
		+	factoryManager->setModulesToSkip(QStringList(QString("Data")));
		+
		+	* scan the directories and test which file is a module and register it (not instantiated yet)
		+	For each file in the search paths, the factory manager asks each registered factory if they can load the file. If there is a factory that supports the file, the manager associates the factory to the file path, otherwise the file is discarded.
		+	factoryManager->registerModules();
		+	* Instantiate all the register modules
		+	factoryManager->instantiateModules();
		+	* Connect each module with the scene and the application
		+	The application logic and the scene are passed to each module. The order of initialization is defined with the dependencies of the modules. If module B depends of module A, it is assured that module B is initialized/setup after A.
		+	factoryManager->loadModules();
		+	==ToDo==
		+	* Transform all core modules into Loadable modules.
		+	** the factory manager only support file based modules, core modules are not file based (linked into the core factory itself)
		+	* Move factory registration in qSlicerApplication (or a general application library) to support module discovery/loading without needing to instantiate Slicer.
		+	** Currently can't be moved into qSlicerApplication as the CLI factories are in QTCl that depends on QTGUI
		+	** Proposed architecture
		+	Base
		+	Application -> classes that are useful to build an application (mix of qSlicerCoreApplication, qSlicerApplication, Main.cxx...)
		+	Core -> formally QtCore
		+	Modules -> contains the factories and module specific code
		+	Loadable
		+	CLI
		+	Scripted
		+	Scripted -> all that is python specific
		+	Cxx
		+	Python
		+	Widgets -> formally QtGUI
		+	* Add category hierarchy in the Settings module panel
		+	* Register factory settings/command-options(e.g. disable-loadable-modules) when registering module factories
		+	** To have the settings panel be generic but have the code proper of each registered factory somewhere else
		+	* Add mechanism for modules to register dialogs (toolbars that open dialogs), e.g. the sceneview module needs to register the sceneView dialog into an icon.

@@ Line 9: / Line 9: @@
 * Links:
 ** [[Slicer3:Execution_Model_Documentation|Slicer3 execution model]] (Slicer4 is very similar)
-** CLI in Slicer4 [http://www.na-mic.org/Wiki/index.php/File:Slicer4_CLI.ppt presentation] (2012_01_11)
+** [http://www.na-mic.org/Wiki/index.php/File:Slicer4_CLI.ppt CLI in Slicer4] (presentation of 2012 NAMIC AHM)
 = Loadable Modules =
@@ Line 17: / Line 17: @@
 * Optimized for heavy computations
 * Links:
-**[http://www.na-mic.org/Wiki/index.php/File:LoadableModules.pptx Loadable modules presentation]
+**[http://www.na-mic.org/Wiki/index.php/File:LoadableModules.pptx Loadable modules] (presentation of 2012 NAMIC AHM)
 **[[Documentation/4.0/Developers/Tutorials/ModuleWriting|How to write a loadable module]]