Slicer3:Extensions:Directories

2009-07-28T18:01:18Z

Tgl:

Slicer3:Extensions:Directories

2009-07-28T18:01:05Z

Tgl:

'''TemporaryDirectory''' is user-defined via Application Settings, defaults to /Users/$USER/Slicer3$USER
'''ExtensionInstallPath''' is user-defined via Application Settings, defaults to value of TemporaryDirectory if not set by user

* Zip files downloaded to TemporaryDirectory
* Extensions installed to Slicer3 SVN Revision-based subdirectory of ExtensionInstallPath (default: /Users/$USER/Slicer3$USER/@SVN@)
* Slicer3 "default" extensions in Slicer3_INSTALL_MODULES_LIB_DIR

Slicer3:Extensions:Directories

2009-07-28T17:58:58Z

Tgl:

Zip files downloaded to TemporaryDirectory (default: /Users/$USER/Slicer3$USER)
Extensions installed to ExtensionInstallPath (default: /Users/$USER/Slicer3$USER/@SVN@)
Slicer3 "default" extensions in Slicer3_INSTALL_MODULES_LIB_DIR

Slicer3:Extensions:Directories

2009-07-28T17:29:51Z

Tgl: New page: TemporaryDirectory /Users/$USER/Slicer3$USER ExtensionsInstallPath $TemporaryDirectory/$SLICER_SVN_REVISION Slicer3 "installed" extensions $Slicer3_INSTALL_MODULES_LIB_DIR Extension

TemporaryDirectory /Users/$USER/Slicer3$USER
ExtensionsInstallPath $TemporaryDirectory/$SLICER_SVN_REVISION
Slicer3 "installed" extensions $Slicer3_INSTALL_MODULES_LIB_DIR
Extension

Slicer3:Extensions:TODO-2009-06-16

2009-06-23T19:10:58Z

2009-02-28T22:22:30Z

Tgl: /* Example */

In order to allow a module to be detected and loaded at runtime a number of changes are required. The first is within the module's GUI class. The vtkSlicerModuleGUI-derived class _must_ implement "void SetModuleLogic(vtkSlicerLogic*)". This allows the library loading methods to load the GUI without knowing the specific class type.

A text file named after the module must also be created.

Last, macros for module creation and handling must be added to the CMakeLists file.

For more information on these edits, plus some optional changes, see below.

== vtkModuleNameGUI ==

vtkModuleNameGUI.h/cxx

'''Do not create this class if you want your module to be GUI-less'''

=== Required ===

For your vtkSlicerModuleGUI-derived class, declare and implement:

virtual void SetModuleLogic(vtkSlicerLogic*)

This is necessary so that the Loadable module code does not need to cast the Logic pointer returned from the defined entry point.

=== Optional ===

To add module-specific MRML events to observe, declare and implement:

virtual vtkIntArray* NewObservableEvents();

To add module-specific initialization code, declare and implement:

virtual void Init();

This is useful to have your module register callbacks for Picking (See QdecModule).

== vtkModuleNameLogic ==

vtkModuleNameLogic.h/cxx

=== Optional ===

To add module-specific MRML events to observe, declare and implement:

virtual vtkIntArray* NewObservableEvents();

== ModuleName.xml ==

ModuleName.xml

Create ModuleName.xml in the module's directory. ModuleName should follow the naming convention for the *GUI and *Logic classes.

For example, with two classes named vtkOpenIGTLinkLogic & vtkOpenIGTLinkGUI, create an XML file named OpenIGTLink.xml

This file contains naming directives, as well as lists dependencies. At a minimum, the module name & GUI name must be specified:

<Name>Open IGT Link</Name>
<GUIName>OpenIGT</GUIName>

'''When creating a GUI-less module, omit the GUIName directive.'''

Optionally, other attributes may be listed:

<Description>This is a description of my module.</Description>
<SourceLocation>https://use/the/source/luke</SourceLocation>
<HomePage>http://my/module/homepage</HomePage>
<Version>1.0</Version>
<Dependency>Module One</Dependency>
<Dependency>Module Two</Dependency>
<Author>Karl Fardman</Author>
<Acknowledgement>All the little people</Acknowledgement>

== CMakeLists.txt ==

CMakeLists.txt

Most modules will be defined outside of the main Slicer3 build tree. To enable your module to be loaded dynamically, a couple entries in CMakeLists.txt are required.

Near the top of the file, include the directives that will locate the Slicer 3 build tree:

if(NOT Slicer3_SOURCE_DIR)
find_package(Slicer3 REQUIRED)
include(${Slicer3_USE_FILE})
slicer3_set_default_install_prefix_for_external_projects()
endif(NOT Slicer3_SOURCE_DIR)

Next, tell CMake to generate the supporting files for Loadable Module:

generatelm(OpenIGTLink_SRCS OpenIGTLink.txt)

NOTE: The macro should be placed after TCL wrapping is done, as it adds to the source variable. For more details, check the [http://svn.na-mic.org/NAMICSandBox/trunk/IGTLoadableModules/NeuroNav/CMakeLists.txt NeuroNav module CMakeLists.txt] file, as it provides a good starting point.

Finally, direct CMake to copy the binary files to the Slicer3 library location. This should be the last entry in your CMakeLists file:

install(TARGETS ${lib_name}
RUNTIME DESTINATION ${Slicer3_INSTALL_MODULES_BIN_DIR} COMPONENT RuntimeLibraries
LIBRARY DESTINATION ${Slicer3_INSTALL_MODULES_LIB_DIR} COMPONENT RuntimeLibraries
ARCHIVE DESTINATION ${Slicer3_INSTALL_MODULES_LIB_DIR} COMPONENT Development
)

== Examples ==

[http://tinyurl.com/53jqbp Loadable Module]

[http://tinyurl.com/c6e7ab Loadable GUI-less Module]