vtkMRMLModuleLogic Class Reference

Superclass for logic classes of modules. More...

#include <Libs/MRML/Logic/vtkMRMLModuleLogic.h>

Inheritance diagram for vtkMRMLModuleLogic:

Collaboration diagram for vtkMRMLModuleLogic:

Public Types
typedef vtkMRMLAbstractLogic	Superclass
Public Types inherited from vtkMRMLAbstractLogic
typedef vtkObject	Superclass
typedef void(vtkMRMLAbstractLogic::*	TaskFunctionPointer) (void *clientdata)

Public Member Functions
virtual std::vector< vtkSmartPointer< vtkMRMLFileIOHandler > >	CreateFileIOHandlers ()
virtual const char *	GetClassName ()
virtual int	IsA (const char *type)
void	PrintSelf (ostream &os, vtkIndent indent) override
Public Member Functions inherited from vtkMRMLAbstractLogic
virtual vtkMRMLApplicationLogic *	GetMRMLApplicationLogic () const
	Get access to overall application state.
vtkMRMLScene *	GetMRMLScene () const
	Return a reference to the current MRML scene.
void	PrintSelf (ostream &os, vtkIndent indent) override
virtual void	SetMRMLApplicationLogic (vtkMRMLApplicationLogic *logic)
void	SetMRMLScene (vtkMRMLScene *newScene)
	Set and observe the MRMLScene.

Static Public Member Functions
static int	IsTypeOf (const char *type)
static vtkMRMLModuleLogic *	New ()
static vtkMRMLModuleLogic *	SafeDownCast (vtkObject *o)
Static Public Member Functions inherited from vtkMRMLAbstractLogic
static int	IsTypeOf (const char *type)
static vtkMRMLAbstractLogic *	New ()
static vtkMRMLAbstractLogic *	SafeDownCast (vtkObject *o)

Protected Member Functions
	vtkMRMLModuleLogic ()
	~vtkMRMLModuleLogic () override
Protected Member Functions inherited from vtkMRMLAbstractLogic
int	EndModify (bool wasModifying)
virtual bool	EnterMRMLLogicsCallback () const
virtual bool	EnterMRMLNodesCallback () const
virtual bool	EnterMRMLSceneCallback () const
bool	GetDisableModifiedEvent () const
int	GetInMRMLLogicsCallbackFlag () const
int	GetInMRMLNodesCallbackFlag () const
int	GetInMRMLSceneCallbackFlag () const
vtkCallbackCommand *	GetMRMLLogicsCallbackCommand ()
vtkObserverManager *	GetMRMLLogicsObserverManager () const
vtkCallbackCommand *	GetMRMLNodesCallbackCommand ()
vtkObserverManager *	GetMRMLNodesObserverManager () const
vtkCallbackCommand *	GetMRMLSceneCallbackCommand ()
vtkObserverManager *	GetMRMLSceneObserverManager () const
int	GetPendingModifiedEventCount () const
int	GetProcessingMRMLSceneEvent () const
	Return the event id currently processed or 0 if any.
int	InvokePendingModifiedEvent ()
void	Modified () override
virtual void	ObserveMRMLScene ()
virtual void	OnMRMLNodeModified (vtkMRMLNode *)
virtual void	OnMRMLSceneEndBatchProcess ()
virtual void	OnMRMLSceneEndClose ()
virtual void	OnMRMLSceneEndImport ()
virtual void	OnMRMLSceneEndRestore ()
virtual void	OnMRMLSceneNew ()
virtual void	OnMRMLSceneNodeAdded (vtkMRMLNode *)
virtual void	OnMRMLSceneNodeRemoved (vtkMRMLNode *)
virtual void	OnMRMLSceneStartBatchProcess ()
virtual void	OnMRMLSceneStartClose ()
virtual void	OnMRMLSceneStartImport ()
virtual void	OnMRMLSceneStartRestore ()
virtual void	ProcessMRMLLogicsEvents (vtkObject *caller, unsigned long event, void *callData)
virtual void	ProcessMRMLNodesEvents (vtkObject *caller, unsigned long event, void *callData)
virtual void	ProcessMRMLSceneEvents (vtkObject *caller, unsigned long event, void *callData)
virtual void	RegisterNodes ()
void	SetAndObserveMRMLSceneEventsInternal (vtkMRMLScene *newScene, vtkIntArray *events, vtkFloatArray *priorities=nullptr)
void	SetDisableModifiedEvent (bool onOff)
void	SetInMRMLLogicsCallbackFlag (int flag)
void	SetInMRMLNodesCallbackFlag (int flag)
void	SetInMRMLSceneCallbackFlag (int flag)
virtual void	SetMRMLSceneInternal (vtkMRMLScene *newScene)
void	SetProcessingMRMLSceneEvent (int event)
bool	StartModify ()
virtual void	UnobserveMRMLScene ()
virtual void	UpdateFromMRMLScene ()
	vtkMRMLAbstractLogic ()
	~vtkMRMLAbstractLogic () override

Additional Inherited Members
Static Protected Member Functions inherited from vtkMRMLAbstractLogic
static void	MRMLLogicsCallback (vtkObject *caller, unsigned long eid, void *clientData, void *callData)
	MRMLLogicCallback is a static function to relay modified events from the logics.
static void	MRMLNodesCallback (vtkObject *caller, unsigned long eid, void *clientData, void *callData)
	MRMLNodesCallback is a static function to relay modified events from the nodes.
static void	MRMLSceneCallback (vtkObject *caller, unsigned long eid, void *clientData, void *callData)

Detailed Description

Superclass for logic classes of modules.

A module logic is the logic instance that is registered in the application logic by vtkMRMLApplicationLogic::SetModuleLogic(). In addition to the features of vtkMRMLAbstractLogic, a module logic can provide file readers and writers.

Definition at line 38 of file vtkMRMLModuleLogic.h.

Member Typedef Documentation

Superclass

typedef vtkMRMLAbstractLogic vtkMRMLModuleLogic::Superclass

Definition at line 42 of file vtkMRMLModuleLogic.h.

Constructor & Destructor Documentation

vtkMRMLModuleLogic()

vtkMRMLModuleLogic::vtkMRMLModuleLogic ( )

protected

~vtkMRMLModuleLogic()

vtkMRMLModuleLogic::~vtkMRMLModuleLogic ( )

overrideprotected

Member Function Documentation

CreateFileIOHandlers()

virtual std::vector< vtkSmartPointer< vtkMRMLFileIOHandler > > vtkMRMLModuleLogic::CreateFileIOHandlers ( )

virtual

Create new instances of the file readers and writers of the module. The default implementation returns an empty list. Called by vtkMRMLApplicationLogic::SetModuleLogic(), which registers the returned readers and writers (it should not be called directly). Readers and writers must only keep a weak reference to the logic. See https://slicer.readthedocs.io/en/latest/developer_guide/mrml_overview.html#the-reader

Reimplemented in vtkSlicerColorLogic, vtkSlicerDataModuleLogic, vtkSlicerMarkupsLogic, vtkSlicerModelsLogic, vtkSlicerSceneViewsModuleLogic, vtkSlicerSegmentationsModuleLogic, vtkSlicerSequencesLogic, vtkSlicerTablesLogic, vtkSlicerTerminologiesModuleLogic, vtkSlicerTextsLogic, vtkSlicerTransformLogic, vtkSlicerVolumeRenderingLogic, and vtkSlicerVolumesLogic.

GetClassName()

virtual const char * vtkMRMLModuleLogic::GetClassName ( )

virtual

Reimplemented from vtkMRMLAbstractLogic.

Reimplemented in vtkDataIOManagerLogic, vtkMRMLColorLogic, vtkSlicerAnnotationModuleLogic, vtkSlicerCamerasModuleLogic, vtkSlicerCLIModuleLogic, vtkSlicerColorLogic, vtkSlicerCropVolumeLogic, vtkSlicerDataModuleLogic, vtkSlicerGeneralizedReformatLogic, vtkSlicerMarkupsLogic, vtkSlicerModelsLogic, vtkSlicerModuleLogic, vtkSlicerMultiVolumeExplorerLogic, vtkSlicerPlotsLogic, vtkSlicerReformatLogic, vtkSlicerSceneViewsModuleLogic, vtkSlicerScriptedLoadableModuleLogic, vtkSlicerSegmentationsModuleLogic, vtkSlicerSequencesLogic, vtkSlicerSubjectHierarchyModuleLogic, vtkSlicerTablesLogic, vtkSlicerTerminologiesModuleLogic, vtkSlicerTextsLogic, vtkSlicerTransformLogic, vtkSlicerViewControllersLogic, vtkSlicerVolumeRenderingLogic, and vtkSlicerVolumesLogic.

IsA()

virtual int vtkMRMLModuleLogic::IsA ( const char * type )

virtual

Reimplemented from vtkMRMLAbstractLogic.

Reimplemented in vtkDataIOManagerLogic, vtkMRMLColorLogic, vtkSlicerAnnotationModuleLogic, vtkSlicerCamerasModuleLogic, vtkSlicerCLIModuleLogic, vtkSlicerColorLogic, vtkSlicerCropVolumeLogic, vtkSlicerDataModuleLogic, vtkSlicerGeneralizedReformatLogic, vtkSlicerMarkupsLogic, vtkSlicerModelsLogic, vtkSlicerModuleLogic, vtkSlicerMultiVolumeExplorerLogic, vtkSlicerPlotsLogic, vtkSlicerReformatLogic, vtkSlicerSceneViewsModuleLogic, vtkSlicerScriptedLoadableModuleLogic, vtkSlicerSegmentationsModuleLogic, vtkSlicerSequencesLogic, vtkSlicerSubjectHierarchyModuleLogic, vtkSlicerTablesLogic, vtkSlicerTerminologiesModuleLogic, vtkSlicerTextsLogic, vtkSlicerTransformLogic, vtkSlicerViewControllersLogic, vtkSlicerVolumeRenderingLogic, and vtkSlicerVolumesLogic.

IsTypeOf()

static int vtkMRMLModuleLogic::IsTypeOf ( const char * type )

static

New()

static vtkMRMLModuleLogic * vtkMRMLModuleLogic::New ( )

static

PrintSelf()

void vtkMRMLModuleLogic::PrintSelf ( ostream & os, vtkIndent indent )

override

SafeDownCast()

static vtkMRMLModuleLogic * vtkMRMLModuleLogic::SafeDownCast ( vtkObject * o )

static

---

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

• Libs/MRML/Logic/vtkMRMLModuleLogic.h