slicerqt.py

Go to the documentation of this file.

import vtk, qt, ctk
import slicer

from slicer.util import *
import slicer.cli

#
# loadSlicerRCFile - Let's not add this function to 'slicer.util' so that 
# the global dictionary of the main context is passed to execfile().
#

def loadSlicerRCFile():
  """If it exists, execute slicer resource script '~/.slicerrc.py'"""
  import os
  if os.environ.has_key('SLICERRC'):
    rcfile = os.environ['SLICERRC']
  else:
    import os.path
    rcfile = os.path.expanduser( '~/.slicerrc.py' )

  if os.path.isfile( rcfile ):
    print 'Loading Slicer RC file [%s]' % ( rcfile )
    execfile( rcfile )

#
# Internal
#

class _Internal():

  def __init__( self ):
    import imp

    # Set attribute 'slicer.app'
    setattr( slicer, 'app', _qSlicerCoreApplicationInstance )

    # Listen factory and module manager to update slicer.{modules, moduleNames} when appropriate
    moduleManager = slicer.app.moduleManager()

    # if the qSlicerApplication is only minimally initialized, the factoryManager does not exist.
    # this would be the case if f.e. a commandline module wants to use qSlicerApplication for tcl
    # access but without all the managers.
    # this is not the default behavior.
    if hasattr( moduleManager, 'factoryManager' ):
      factoryManager = moduleManager.factoryManager()
      factoryManager.connect( 'allModulesRegistered()', self.setSlicerModuleNames )
      moduleManager.connect( 'moduleLoaded(qSlicerAbstractCoreModule*)', self.setSlicerModules )

    # Add module 'slicer.moduleNames'
    _moduleNames = imp.new_module( 'moduleNames' )
    setattr( slicer, _moduleNames.__name__, _moduleNames )

    # Add module 'slicer.modules'
    _modules = imp.new_module( 'modules' )
    setattr( slicer, _modules.__name__, _modules )

    # Retrieve current instance of the scene and set 'slicer.mrmlScene'
    setattr( slicer, 'mrmlScene', slicer.app.mrmlScene() )

    # HACK - Since qt.QTimer.singleShot is both a property and a static method, the property
    # is wrapped in python and prevent the call to the convenient static method having
    # the same name. To fix the problem, let's overwrite it's value.
    # Ideally this should be fixed in PythonQt itself.
    def _singleShot( msec, receiverOrCallable, member=None ):
      """Calls either a python function or a slot after a given time interval."""
      # Add 'moduleManager' as parent to prevent the premature destruction of the timer.
      # Doing so, we ensure that the QTimer will be deleted before PythonQt is cleanup.
      # Indeed, the moduleManager is destroyed before the pythonManager.
      timer = qt.QTimer( slicer.app.moduleManager() )
      timer.setSingleShot( True )
      if callable( receiverOrCallable ):
        timer.connect( "timeout()", receiverOrCallable )
      else:
        timer.connect( "timeout()", receiverOrCallable, member )
      timer.start( msec )

    qt.QTimer.singleShot = staticmethod( _singleShot )

  def setSlicerModuleNames( self ):
    """Add module names as attributes of module slicer.moduleNames"""
    for name in moduleNames():
      setattr( slicer.moduleNames, name, name )

  def setSlicerModules( self, module ):
    """Add modules as attributes of module slicer.modules"""
    setattr( slicer.modules, module.name, module )


_internalInstance = _Internal()