#include <Modules/Loadable/Data/Logic/vtkSlicerDataModuleLogic.h>

Inheritance diagram for vtkSlicerDataModuleLogic:

[legend]

Collaboration diagram for vtkSlicerDataModuleLogic:

[legend]

Public Types
typedef vtkSlicerModuleLogic	Superclass

Public Types inherited from vtkSlicerModuleLogic
typedef vtkMRMLAbstractLogic	Superclass

Public Types inherited from vtkMRMLAbstractLogic
typedef vtkObject	Superclass

typedef void(vtkMRMLAbstractLogic::*	TaskFunctionPointer) (void *clientdata)

Public Member Functions
virtual const char *	GetClassName ()

virtual bool	GetSceneChanged ()

virtual int	IsA (const char *type)

void	PrintSelf (ostream &os, vtkIndent indent) override

virtual void	SceneChangedOff ()

virtual void	SceneChangedOn ()

virtual void	SetSceneChanged (bool)

Public Member Functions inherited from vtkSlicerModuleLogic
virtual vtkSlicerApplicationLogic *	GetApplicationLogic ()
	Get access to overall application state.

virtual vtkMRMLAbstractLogic *	GetModuleLogic (const char *moduleName)
	Convenience method for getting another module's logic from the application logic.

std::string	GetModuleShareDirectory () const

void	PrintSelf (ostream &os, vtkIndent indent) override

void	SetModuleShareDirectory (const std::string &shareDirectory)

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 vtkSlicerDataModuleLogic *	New ()

static vtkSlicerDataModuleLogic *	SafeDownCast (vtkObject *o)

Static Public Member Functions inherited from vtkSlicerModuleLogic
static int	IsTypeOf (const char *type)

static vtkSlicerModuleLogic *	New ()
	The Usual vtk class functions.

static vtkSlicerModuleLogic *	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
void	OnMRMLSceneNodeRemoved (vtkMRMLNode *removedNode) override

void	RegisterNodes () override
	Register MRML Node classes to Scene. Gets called automatically when the MRMLScene is attached to this logic class.

void	SetMRMLSceneInternal (vtkMRMLScene *newScene) override

void	UpdateFromMRMLScene () override

	vtkSlicerDataModuleLogic ()

	~vtkSlicerDataModuleLogic () override

Protected Member Functions inherited from vtkSlicerModuleLogic
	vtkSlicerModuleLogic ()

	~vtkSlicerModuleLogic () 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	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)

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)

void	SetProcessingMRMLSceneEvent (int event)

bool	StartModify ()

virtual void	UnobserveMRMLScene ()

	vtkMRMLAbstractLogic ()

	~vtkMRMLAbstractLogic () override

Protected Attributes
bool	AutoRemoveDisplayAndStorageNodes

bool	SceneChanged
	Flag indicating if the scene has recently changed (update of the module GUI if needed)

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

Definition at line 35 of file vtkSlicerDataModuleLogic.h.

Member Typedef Documentation

◆ Superclass

typedef vtkSlicerModuleLogic vtkSlicerDataModuleLogic::Superclass

Definition at line 40 of file vtkSlicerDataModuleLogic.h.

Constructor & Destructor Documentation

◆ vtkSlicerDataModuleLogic()

vtkSlicerDataModuleLogic::vtkSlicerDataModuleLogic ( )

protected

◆ ~vtkSlicerDataModuleLogic()

vtkSlicerDataModuleLogic::~vtkSlicerDataModuleLogic ( )

overrideprotected

Member Function Documentation

◆ GetClassName()

virtual const char * vtkSlicerDataModuleLogic::GetClassName ( )

virtual

Reimplemented from vtkSlicerModuleLogic.

◆ GetSceneChanged()

virtual bool vtkSlicerDataModuleLogic::GetSceneChanged ( )

virtual

◆ IsA()

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

virtual

Reimplemented from vtkSlicerModuleLogic.

◆ IsTypeOf()

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

static

◆ New()

static vtkSlicerDataModuleLogic * vtkSlicerDataModuleLogic::New ( )

static

◆ OnMRMLSceneNodeRemoved()

void vtkSlicerDataModuleLogic::OnMRMLSceneNodeRemoved ( vtkMRMLNode * removedNode )

overrideprotectedvirtual

Reimplemented to delete the storage/display nodes when a displayable node is being removed.

Reimplemented from vtkMRMLAbstractLogic.

◆ PrintSelf()

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

override

◆ RegisterNodes()

void vtkSlicerDataModuleLogic::RegisterNodes ( )

overrideprotectedvirtual

Register MRML Node classes to Scene. Gets called automatically when the MRMLScene is attached to this logic class.

Reimplemented from vtkMRMLAbstractLogic.

◆ SafeDownCast()

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

static

◆ SceneChangedOff()

virtual void vtkSlicerDataModuleLogic::SceneChangedOff ( )

virtual

◆ SceneChangedOn()

virtual void vtkSlicerDataModuleLogic::SceneChangedOn ( )

virtual

◆ SetMRMLSceneInternal()

void vtkSlicerDataModuleLogic::SetMRMLSceneInternal ( vtkMRMLScene * newScene )

overrideprotectedvirtual

Called each time a new scene is set. Can be reimplemented in derived classes. Doesn't observe the scene by default, that means that UpdateFromMRMLScene() won't be called by default when a scene is imported, closed or restored, only when a new scene is set.

See also: SetAndObserveMRMLSceneInternal() SetAndObserveMRMLSceneEventsInternal(); UpdateFromMRMLScene()

Reimplemented from vtkMRMLAbstractLogic.

◆ SetSceneChanged()

virtual void vtkSlicerDataModuleLogic::SetSceneChanged ( bool )

virtual

◆ UpdateFromMRMLScene()

void vtkSlicerDataModuleLogic::UpdateFromMRMLScene ( )

overrideprotectedvirtual

Called every time the scene has been significantly changed. If the scene BatchProcessState events are observed (in SetMRMLSceneInternal() ), UpdateFromMRMLScene is called after each batch process (Close, Import, Restore...). It is also being called by default when a new scene is set (SetMRMLScene).

See also: SetMRMLSceneInternal, UnobserveMRMLScene, ObserveMRMLScene

Reimplemented from vtkMRMLAbstractLogic.

Member Data Documentation

◆ AutoRemoveDisplayAndStorageNodes

bool vtkSlicerDataModuleLogic::AutoRemoveDisplayAndStorageNodes

protected

This property controls whether the removal from the scene of a model node automatically removes its display and storage nodes or not. This automatic behavior (true by default) is used to prevent the user from seeing a model (display node) in a 3D view after a model node has been deleted/removed (delete from a tree view qt widget). If the nodes were not removed/deleted, the display and storage nodes would be zombie nodes in the scene with no one pointing on them.

Definition at line 70 of file vtkSlicerDataModuleLogic.h.

◆ SceneChanged

bool vtkSlicerDataModuleLogic::SceneChanged

protected

Flag indicating if the scene has recently changed (update of the module GUI if needed)

Definition at line 78 of file vtkSlicerDataModuleLogic.h.

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

Modules/Loadable/Data/Logic/vtkSlicerDataModuleLogic.h

Public Types

Public Member Functions

Static Public Member Functions

Protected Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Member Typedef Documentation

◆ Superclass

Constructor & Destructor Documentation

◆ vtkSlicerDataModuleLogic()

◆ ~vtkSlicerDataModuleLogic()

Member Function Documentation

◆ GetClassName()

◆ GetSceneChanged()

◆ IsA()

◆ IsTypeOf()

◆ New()

◆ OnMRMLSceneNodeRemoved()

◆ PrintSelf()

◆ RegisterNodes()

◆ SafeDownCast()

◆ SceneChangedOff()

◆ SceneChangedOn()

◆ SetMRMLSceneInternal()

◆ SetSceneChanged()

◆ UpdateFromMRMLScene()

Member Data Documentation

◆ AutoRemoveDisplayAndStorageNodes

◆ SceneChanged