#include <Base/Logic/vtkSlicerApplicationLogic.h>

Inheritance diagram for vtkSlicerApplicationLogic:

[legend]

Collaboration diagram for vtkSlicerApplicationLogic:

[legend]

Public Types
enum	RequestEvents { RequestModifiedEvent = vtkMRMLApplicationLogic::RequestInvokeEvent + 1 , RequestReadDataEvent , RequestWriteDataEvent , RequestProcessedEvent }
	List of events potentially fired by the application logic. More...

typedef vtkMRMLApplicationLogic	Superclass

Public Types inherited from vtkMRMLApplicationLogic
enum	Events { RequestInvokeEvent = vtkCommand::UserEvent + 1 , PauseRenderEvent = vtkCommand::UserEvent + 101 , ResumeRenderEvent , EditNodeEvent , ShowViewContextMenuEvent }
	List of custom events fired by the class. More...

enum	IntersectingSlicesOperation { IntersectingSlicesVisibility , IntersectingSlicesInteractive , IntersectingSlicesTranslation , IntersectingSlicesRotation , IntersectingSlicesThickSlabInteractive }

enum	Layers { LabelLayer = 0x1 , ForegroundLayer = 0x2 , BackgroundLayer = 0x4 , AllLayers = LabelLayer \| ForegroundLayer \| BackgroundLayer }

typedef vtkMRMLAbstractLogic	Superclass

Public Types inherited from vtkMRMLAbstractLogic
typedef vtkObject	Superclass

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

Public Member Functions
void	CreateProcessingThread ()
	Create a thread for processing.

virtual const char *	GetClassName ()

unsigned int	GetReadDataQueueSize ()

vtkPersonInformation *	GetUserInformation ()

vtkMRMLAbstractDisplayableManager *	GetViewDisplayableManagerByClassName (vtkMRMLAbstractViewNode viewNode, const char className) const

virtual int	IsA (const char *type)

void	PrintSelf (ostream &os, vtkIndent indent) override

void	ProcessModified ()

void	ProcessReadData ()

void	ProcessWriteData ()
	Process a request to write data from a referenced node.

vtkMTimeType	RequestAddNodeReference (const std::string &referencingNode, const std::string &referencedNode, const std::string &role)

vtkMTimeType	RequestModified (vtkObject *)

vtkMTimeType	RequestReadFile (const char refNode, const char filename, int displayData=false, int deleteFile=false)

vtkMTimeType	RequestReadScene (const std::string &filename, std::vector< std::string > &targetIDs, std::vector< std::string > &sourceIDs, int displayData=false, int deleteFile=false)

vtkMTimeType	RequestUpdateParentTransform (const std::string &updatedNode, const std::string &parentTransformNode)

vtkMTimeType	RequestUpdateSubjectHierarchyLocation (const std::string &updatedNode, const std::string &siblingNode)

vtkMTimeType	RequestWriteData (const char refNode, const char filename)

int	ScheduleTask (vtkSlicerTask *)

void	SetMRMLSceneDataIO (vtkMRMLScene scene, vtkMRMLRemoteIOLogic remoteIOLogic, vtkDataIOManagerLogic *dataIOManagerLogic)

void	SetTracingOff ()

void	SetTracingOn ()

void	TerminateProcessingThread ()
	Shutdown the processing thread.

Public Member Functions inherited from vtkMRMLApplicationLogic
virtual void	EditNode (vtkMRMLNode *node)
	Requests the application to show user interface for editing a node.

void	FitSliceToAll (bool onlyIfPropagateVolumeSelectionAllowed=false, bool resetOrientation=true)

void	FitSliceToBackground (bool onlyIfPropagateVolumeSelectionAllowed=false, bool resetOrientation=true)

vtkMRMLColorLogic *	GetColorLogic () const

std::string	GetFontFilePath (const std::string &fontFileName)
	Get full path to custom font file for rendering views from font file name.

std::string	GetFontsDirectory ()
	Get folder where font files are stored ("Fonts" subfolder in application share folder).

vtkMRMLInteractionNode *	GetInteractionNode () const
	Get default Interaction node.

bool	GetIntersectingSlicesEnabled (IntersectingSlicesOperation operation)

int	GetIntersectingSlicesIntersectionMode ()

int	GetIntersectingSlicesLineThicknessMode ()

vtkMRMLAbstractLogic *	GetModuleLogic (const char *moduleName) const

vtkMRMLSelectionNode *	GetSelectionNode () const
	Get default Selection node.

vtkMRMLSliceLogic *	GetSliceLogic (vtkMRMLSliceNode *sliceNode) const

vtkMRMLSliceLogic *	GetSliceLogicByLayoutName (const char *layoutName) const

vtkMRMLSliceLogic *	GetSliceLogicByModelDisplayNode (vtkMRMLModelDisplayNode *displayNode) const
	Get slice logic from slice model display node.

vtkCollection *	GetSliceLogics () const

const char *	GetTemporaryPath ()
	Return the temporary path that was set by the application.

vtkMRMLViewLogic *	GetViewLogic (vtkMRMLViewNode *viewNode) const

vtkMRMLViewLogic *	GetViewLogicByLayoutName (const char *layoutName) const

vtkCollection *	GetViewLogics () const

void	InvokeEventWithDelay (unsigned int delayInMs, vtkObject caller, unsigned long eventID=vtkCommand::ModifiedEvent, void callData=nullptr)
	Conveniently calls an InvokeEvent on an object with a delay.

bool	OpenSlicerDataBundle (const char sdbFilePath, const char temporaryDirectory, vtkMRMLMessageCollection *userMessages=nullptr)

virtual void	PauseRender ()

void	PrintSelf (ostream &os, vtkIndent indent) override

void	PropagateBackgroundVolumeSelection (int fit=1)

void	PropagateForegroundVolumeSelection (int fit=1)

void	PropagateLabelVolumeSelection (int fit=1)

void	PropagatePlotChartSelection ()
	Propagate selected PlotChart in the SelectionNode to Plot view nodes.

void	PropagateTableSelection ()
	Propagate selected table in the SelectionNode to table view nodes.

void	PropagateVolumeSelection (int fit=1)

void	PropagateVolumeSelection (int layer, int fit)

virtual void	ResumeRender ()

void	SaveSceneScreenshot (vtkImageData *screenshot)

bool	SaveSceneToSlicerDataBundleDirectory (const char sdbDir, vtkImageData screenShot=nullptr, vtkMRMLMessageCollection *userMessages=nullptr)

void	SetColorLogic (vtkMRMLColorLogic *newColorLogic)

void	SetIntersectingSlicesEnabled (IntersectingSlicesOperation operation, bool enabled)

void	SetIntersectingSlicesIntersectionMode (int mode)

void	SetIntersectingSlicesLineThicknessMode (int mode)

void	SetModuleLogic (const char moduleName, vtkMRMLAbstractLogic moduleLogic)

void	SetSliceLogics (vtkCollection *sliceLogics)
	All the slice logics in the application.

void	SetTemporaryPath (const char *path)
	Set the temporary path the logics can use. The path should be set by the application.

void	SetViewLogics (vtkCollection *viewLogics)
	All the view logics in the application.

std::string	UnpackSlicerDataBundle (const char sdbFilePath, const char temporaryDirectory)

bool	Unzip (const char zipFileName, const char destinationDirectory)

void	UseCustomFontFile (vtkTextProperty *textProperty)

bool	Zip (const char zipFileName, const char directoryToZip)

void	SetFontFileName (int fontFamily, const std::string &fontFileName)

std::string	GetFontFileName (int fontFamily)

void	SetHomeDirectory (const std::string &path)

const std::string &	GetHomeDirectory () const

void	SetShareDirectory (const std::string &path)

const std::string &	GetShareDirectory () const

std::string	GetShareFilePath (const std::string &fileName) const

std::string	GetShareFilePath (const std::string &subfolderName, const std::string &fileName) const

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 std::string	GetModuleShareDirectory (const std::string &moduleName, const std::string &filePath)
	Get share directory associated with moduleName located in filePath.

static std::string	GetModuleSlicerXYLibDirectory (const std::string &filePath)
	Get Slicer-X.Y lib directory associated with module located in filePath.

static std::string	GetModuleSlicerXYShareDirectory (const std::string &filePath)
	Get Slicer-X.Y share directory associated with module located in filePath.

static bool	IsEmbeddedModule (const std::string &filePath, const std::string &applicationHomeDir, const std::string &slicerRevision, const std::string &extensionsDirBase="")

static bool	IsPluginBuiltIn (const std::string &filePath, const std::string &applicationHomeDir, const std::string &slicerRevision, const std::string &extensionsDirBase="")

static bool	IsPluginInstalled (const std::string &filePath, const std::string &applicationHomeDir, const std::string &organizationDomain="", const std::string &organizationName="", const std::string &extensionsDirBase="")

static int	IsTypeOf (const char *type)

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

static void	RequestModifiedCallback (vtkObject caller, unsigned long eid, void clientData, void *callData)

static vtkSlicerApplicationLogic *	SafeDownCast (vtkObject *o)

Static Public Member Functions inherited from vtkMRMLApplicationLogic
static std::string	CreateUniqueFileName (const std::string &filename, const std::string &knownExtension="")

static int	IsTypeOf (const char *type)

static int	LoadDefaultParameterSets (vtkMRMLScene *scene, const std::vector< std::string > &directories)

static vtkMRMLApplicationLogic *	New ()

static std::string	PercentEncode (std::string s)

static vtkMRMLApplicationLogic *	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	ProcessNetworkingTasks ()
	Networking Task processing loop that is run in a networking thread.

void	ProcessProcessingTasks ()
	Task processing loop that is run in the processing thread.

void	ProcessReadSceneData (ReadDataRequest &req)

void	ProcessWriteSceneData (WriteDataRequest &req)

virtual void	SetCurrentThreadPriorityToBackground ()

	vtkSlicerApplicationLogic ()

	~vtkSlicerApplicationLogic () override

Protected Member Functions inherited from vtkMRMLApplicationLogic
void	FitSliceToContent (bool all, bool onlyIfPropagateVolumeSelectionAllowed=false, bool resetOrientation=true)

void	OnMRMLSceneEndBatchProcess () override

void	OnMRMLSceneEndImport () override

void	OnMRMLSceneEndRestore () override

void	OnMRMLSceneStartBatchProcess () override

void	OnMRMLSceneStartImport () override

void	OnMRMLSceneStartRestore () override

void	ProcessMRMLNodesEvents (vtkObject caller, unsigned long event, void callData) override

void	SetInteractionNode (vtkMRMLInteractionNode *)

void	SetMRMLSceneInternal (vtkMRMLScene *newScene) override

void	SetSelectionNode (vtkMRMLSelectionNode *)

	vtkMRMLApplicationLogic ()

	~vtkMRMLApplicationLogic () 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	OnMRMLSceneEndClose ()

virtual void	OnMRMLSceneNew ()

virtual void	OnMRMLSceneNodeAdded (vtkMRMLNode *)

virtual void	OnMRMLSceneNodeRemoved (vtkMRMLNode *)

virtual void	OnMRMLSceneStartClose ()

virtual void	ProcessMRMLLogicsEvents (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)

void	SetProcessingMRMLSceneEvent (int event)

bool	StartModify ()

virtual void	UnobserveMRMLScene ()

virtual void	UpdateFromMRMLScene ()

	vtkMRMLAbstractLogic ()

	~vtkMRMLAbstractLogic () override

Static Protected Member Functions
static void	NetworkingThreaderCallback (vtkSlicerApplicationLogic *appLogic)
	Callback used by a std::thread to start a networking thread.

static void	ProcessingThreaderCallback (vtkSlicerApplicationLogic *appLogic)
	Callback used by a std::thread to start a processing thread.

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 49 of file vtkSlicerApplicationLogic.h.

Member Typedef Documentation

◆ Superclass

typedef vtkMRMLApplicationLogic vtkSlicerApplicationLogic::Superclass

Definition at line 54 of file vtkSlicerApplicationLogic.h.

Member Enumeration Documentation

◆ RequestEvents

enum vtkSlicerApplicationLogic::RequestEvents

List of events potentially fired by the application logic.

Enumerator
RequestModifiedEvent
RequestReadDataEvent
RequestWriteDataEvent
RequestProcessedEvent	Event fired when a readData, writeData or readScene request has been processed. The UID of the request is passed as callData. Todo Add support for "modified" request.

Definition at line 72 of file vtkSlicerApplicationLogic.h.

Constructor & Destructor Documentation

◆ vtkSlicerApplicationLogic()

vtkSlicerApplicationLogic::vtkSlicerApplicationLogic ( )

protected

◆ ~vtkSlicerApplicationLogic()

vtkSlicerApplicationLogic::~vtkSlicerApplicationLogic ( )

overrideprotected

Member Function Documentation

◆ CreateProcessingThread()

void vtkSlicerApplicationLogic::CreateProcessingThread ( )

Create a thread for processing.

◆ GetClassName()

virtual const char * vtkSlicerApplicationLogic::GetClassName ( )

virtual

Reimplemented from vtkMRMLApplicationLogic.

◆ GetModuleShareDirectory()

static std::string vtkSlicerApplicationLogic::GetModuleShareDirectory	(	const std::string &	moduleName,
		const std::string &	filePath )

static

Get share directory associated with moduleName located in filePath.

◆ GetModuleSlicerXYLibDirectory()

static std::string vtkSlicerApplicationLogic::GetModuleSlicerXYLibDirectory ( const std::string & filePath )

static

Get Slicer-X.Y lib directory associated with module located in filePath.

◆ GetModuleSlicerXYShareDirectory()

static std::string vtkSlicerApplicationLogic::GetModuleSlicerXYShareDirectory ( const std::string & filePath )

static

Get Slicer-X.Y share directory associated with module located in filePath.

◆ GetReadDataQueueSize()

unsigned int vtkSlicerApplicationLogic::GetReadDataQueueSize ( )

Return the number of items that need to be read from the queue (this allows code that invokes command line modules to know when multiple items are being returned and have all been returned).

◆ GetUserInformation()

vtkPersonInformation * vtkSlicerApplicationLogic::GetUserInformation ( )

Get information about the current user (name, login, email, organization, etc.) Values are allowed to be modified.

◆ GetViewDisplayableManagerByClassName()

vtkMRMLAbstractDisplayableManager * vtkSlicerApplicationLogic::GetViewDisplayableManagerByClassName	(	vtkMRMLAbstractViewNode *	viewNode,
		const char *	className ) const

Get view displayable manager given its class name.

This provides a Qt-independent way to access displayable managers, by looking up the vtkMRMLDisplayableManagerGroup associated with a vtkMRMLViewNode (3D) or vtkMRMLSliceNode (2D).

Parameters

viewNode	MRML view node (slice or 3D) whose displayable manager group will be queried.
className	Class name of the displayable manager (e.g., "vtkMRMLCameraDisplayableManager").

Returns: The displayable manager instance if found, otherwise nullptr. The returned pointer is owned by the displayable manager group and must not be deleted by the caller.

This API is primarily intended for accessing low-level VTK actors or widgets without going through Qt view classes, and is especially useful in headless contexts or alternative frontends (e.g., trame).

◆ IsA()

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

virtual

Reimplemented from vtkMRMLApplicationLogic.

◆ IsEmbeddedModule()

static bool vtkSlicerApplicationLogic::IsEmbeddedModule	(	const std::string &	filePath,
		const std::string &	applicationHomeDir,
		const std::string &	slicerRevision,
		const std::string &	extensionsDirBase = "" )

static

Return True if filePath is a descendant of applicationHomeDir.

Note: On macOS extensions are installed in the "<extensionsDirBase>-<slicerRevision>" folder being a sub directory of the application dir, an extra test is performed to make sure the tested filePath doesn't belong to that "<extensionsDirBase>-<slicerRevision>" folder. If this is the case, False will be returned.; If extensionsDirBase is empty, this function assumes that Slicer was built without extension manager support (Slicer_BUILD_EXTENSIONMANAGER_SUPPORT is OFF)

◆ IsPluginBuiltIn()

static bool vtkSlicerApplicationLogic::IsPluginBuiltIn	(	const std::string &	filePath,
		const std::string &	applicationHomeDir,
		const std::string &	slicerRevision,
		const std::string &	extensionsDirBase = "" )

static

Return true if the plugin identified with its filePath is a built-in Slicer module.

Note: If extensionsDirBase is empty, this function assumes that Slicer was build with without extension manager support (Slicer_BUILD_EXTENSIONMANAGER_SUPPORT is OFF)

◆ IsPluginInstalled()

static bool vtkSlicerApplicationLogic::IsPluginInstalled	(	const std::string &	filePath,
		const std::string &	applicationHomeDir,
		const std::string &	organizationDomain = "",
		const std::string &	organizationName = "",
		const std::string &	extensionsDirBase = "" )

static

Return true if the plugin identified with its filePath is loaded from an install tree.

Warning: Since internally the function looks for the existence of CMakeCache.txt, it will return an incorrect result if the plugin is installed in the build tree of an other project.

Note: If extensionsDirBase is empty, this function assumes that Slicer was build with without extension manager support (Slicer_BUILD_EXTENSIONMANAGER_SUPPORT is OFF); If organizationDomain or organizationName is empty, this function won't check the associated directory!

◆ IsTypeOf()

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

static

◆ NetworkingThreaderCallback()

static void vtkSlicerApplicationLogic::NetworkingThreaderCallback ( vtkSlicerApplicationLogic * appLogic )

staticprotected

Callback used by a std::thread to start a networking thread.

◆ New()

static vtkSlicerApplicationLogic * vtkSlicerApplicationLogic::New ( )

static

The Usual vtk class functions.

◆ PrintSelf()

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

override

◆ ProcessingThreaderCallback()

static void vtkSlicerApplicationLogic::ProcessingThreaderCallback ( vtkSlicerApplicationLogic * appLogic )

staticprotected

Callback used by a std::thread to start a processing thread.

◆ ProcessModified()

void vtkSlicerApplicationLogic::ProcessModified ( )

Process a request on the Modified queue. This method is called in the main thread of the application because calls to Modified() can cause an update to the GUI. (Method needs to be public to fit in the event callback chain.)

◆ ProcessNetworkingTasks()

void vtkSlicerApplicationLogic::ProcessNetworkingTasks ( )

protected

Networking Task processing loop that is run in a networking thread.

◆ ProcessProcessingTasks()

void vtkSlicerApplicationLogic::ProcessProcessingTasks ( )

protected

Task processing loop that is run in the processing thread.

◆ ProcessReadData()

void vtkSlicerApplicationLogic::ProcessReadData ( )

Process a request to read data and set it on a referenced node. This method is called in the main thread of the application because calls to load data will cause a Modified() on a node which can force a render.

◆ ProcessReadSceneData()

void vtkSlicerApplicationLogic::ProcessReadSceneData ( ReadDataRequest & req )

protected

Process a request to read data into a scene. This method is called by ProcessReadData() in the application main thread because calls to load data will cause a Modified() on a node which can force a render.

◆ ProcessWriteData()

void vtkSlicerApplicationLogic::ProcessWriteData ( )

Process a request to write data from a referenced node.

◆ ProcessWriteSceneData()

void vtkSlicerApplicationLogic::ProcessWriteSceneData ( WriteDataRequest & req )

protected

◆ RequestAddNodeReference()

vtkMTimeType vtkSlicerApplicationLogic::RequestAddNodeReference	(	const std::string &	referencingNode,
		const std::string &	referencedNode,
		const std::string &	role )

Request adding a node reference The request will executed on the main thread. Return the request UID (monotonically increasing) of the request or 0 if the request failed to be registered. When the request is processed, RequestProcessedEvent is invoked with the request UID as calldata.

See also: RequestReadScene(), RequestWriteData(), RequestModified()

◆ RequestModified()

vtkMTimeType vtkSlicerApplicationLogic::RequestModified ( vtkObject * )

Request a Modified call on an object. This method allows a processing thread to request a Modified call on an object to be performed in the main thread. This allows the call to Modified to trigger GUI changes. RequestModified() is called from the processing thread to modify an object in the main thread. Return the request UID (monotonically increasing) of the request or 0 if the request failed to be registered.

Todo: Fire RequestProcessedEvent when processing Modified requests.

See also: RequestReadData(), RequestWriteData()

◆ RequestModifiedCallback()

static void vtkSlicerApplicationLogic::RequestModifiedCallback	(	vtkObject *	caller,
		unsigned long	eid,
		void *	clientData,
		void *	callData )

static

Callback function to request invoking a modified event on the main thread. This function may be called from any thread.

◆ RequestReadFile()

vtkMTimeType vtkSlicerApplicationLogic::RequestReadFile	(	const char *	refNode,
		const char *	filename,
		int	displayData = false,
		int	deleteFile = false )

Request that data be read from a file and set it on the referenced node. The request will be sent to the main thread which will be responsible for reading the data, setting it on the referenced node, and updating the display. Return the request UID (monotonically increasing) of the request or 0 if the request failed to be registered. When the request is processed, RequestProcessedEvent is invoked with the request UID as calldata.

See also: RequestReadScene(), RequestWriteData(), RequestModified()

◆ RequestReadScene()

vtkMTimeType vtkSlicerApplicationLogic::RequestReadScene	(	const std::string &	filename,
		std::vector< std::string > &	targetIDs,
		std::vector< std::string > &	sourceIDs,
		int	displayData = false,
		int	deleteFile = false )

Request that a scene be read from a file. Mappings of node IDs in the file (sourceIDs) to node IDs in the main scene (targetIDs) can be specified. Only nodes listed in sourceIDs are loaded back into the main scene. Hierarchical nodes will be handled specially, in that only the top node needs to be listed in the sourceIds. Return the request UID (monotonically increasing) of the request or 0 if the request failed to be registered. When the request is processed, RequestProcessedEvent is invoked with the request UID as calldata.

See also: RequestReadData(), RequestWriteData()

◆ RequestUpdateParentTransform()

vtkMTimeType vtkSlicerApplicationLogic::RequestUpdateParentTransform	(	const std::string &	updatedNode,
		const std::string &	parentTransformNode )

Request setting of parent transform. The request will executed on the main thread. Return the request UID (monotonically increasing) of the request or 0 if the request failed to be registered. When the request is processed, RequestProcessedEvent is invoked with the request UID as calldata.

See also: RequestReadScene(), RequestWriteData(), RequestModified()

◆ RequestUpdateSubjectHierarchyLocation()

vtkMTimeType vtkSlicerApplicationLogic::RequestUpdateSubjectHierarchyLocation	(	const std::string &	updatedNode,
		const std::string &	siblingNode )

Request setting of subject hierarchy location (will have the same parent and same level as sibling node). The request will executed on the main thread. Return the request UID (monotonically increasing) of the request or 0 if the request failed to be registered. When the request is processed, RequestProcessedEvent is invoked with the request UID as calldata.

See also: RequestReadScene(), RequestWriteData(), RequestModified()

◆ RequestWriteData()

vtkMTimeType vtkSlicerApplicationLogic::RequestWriteData	(	const char *	refNode,
		const char *	filename )

Request that data be written from a file to a remote destination. Return the request UID (monotonically increasing) of the request or 0 if the request failed to be registered. When the request is processed, RequestProcessedEvent is invoked with the request UID as calldata.

See also: RequestReadData(), RequestReadScene()

◆ SafeDownCast()

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

static

◆ ScheduleTask()

int vtkSlicerApplicationLogic::ScheduleTask ( vtkSlicerTask * )

Schedule a task to run in the processing thread. Returns true if task was successfully scheduled. ScheduleTask() is called from the main thread to run something in the processing thread.

◆ SetCurrentThreadPriorityToBackground()

virtual void vtkSlicerApplicationLogic::SetCurrentThreadPriorityToBackground ( )

protectedvirtual

Set background thread (background processing, networking) priority, which can be set via an environment variable SLICER_BACKGROUND_THREAD_PRIORITY. Value of the variable must be an integer specifying background threads priority (default: 20).

◆ SetMRMLSceneDataIO()

void vtkSlicerApplicationLogic::SetMRMLSceneDataIO	(	vtkMRMLScene *	scene,
		vtkMRMLRemoteIOLogic *	remoteIOLogic,
		vtkDataIOManagerLogic *	dataIOManagerLogic )

Update the data IO, local and remote, with the new scene For stand alone applications, follow the set up steps in qSlicerCoreApplicationPrivate::initDataIO() to set up the remote IO logic and data manager logic and then call this method to hook them into the scene.

See also: qSlicerCoreApplicationPrivate::initDataIO(); vtkMRMLRemoteIOLogic::AddDataIOToScene()

◆ SetTracingOff()

void vtkSlicerApplicationLogic::SetTracingOff ( )

inline

Definition at line 181 of file vtkSlicerApplicationLogic.h.

◆ SetTracingOn()

void vtkSlicerApplicationLogic::SetTracingOn ( )

inline

These routings act as place holders so that test scripts can turn on and off tracing. These are just hooks for use with external tracing tool (such as AQTime)

Definition at line 180 of file vtkSlicerApplicationLogic.h.

◆ TerminateProcessingThread()

void vtkSlicerApplicationLogic::TerminateProcessingThread ( )

Shutdown the processing thread.

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

Base/Logic/vtkSlicerApplicationLogic.h

Public Types

Public Member Functions

Static Public Member Functions

Protected Member Functions

Static Protected Member Functions

Detailed Description

Member Typedef Documentation

◆ Superclass

Member Enumeration Documentation

◆ RequestEvents

Constructor & Destructor Documentation

◆ vtkSlicerApplicationLogic()

◆ ~vtkSlicerApplicationLogic()

Member Function Documentation

◆ CreateProcessingThread()

◆ GetClassName()

◆ GetModuleShareDirectory()

◆ GetModuleSlicerXYLibDirectory()

◆ GetModuleSlicerXYShareDirectory()

◆ GetReadDataQueueSize()

◆ GetUserInformation()

◆ GetViewDisplayableManagerByClassName()

◆ IsA()

◆ IsEmbeddedModule()

◆ IsPluginBuiltIn()

◆ IsPluginInstalled()

◆ IsTypeOf()

◆ NetworkingThreaderCallback()

◆ New()

◆ PrintSelf()

◆ ProcessingThreaderCallback()

◆ ProcessModified()

◆ ProcessNetworkingTasks()

◆ ProcessProcessingTasks()

◆ ProcessReadData()

◆ ProcessReadSceneData()

◆ ProcessWriteData()

◆ ProcessWriteSceneData()

◆ RequestAddNodeReference()

◆ RequestModified()

◆ RequestModifiedCallback()

◆ RequestReadFile()

◆ RequestReadScene()

◆ RequestUpdateParentTransform()

◆ RequestUpdateSubjectHierarchyLocation()

◆ RequestWriteData()

◆ SafeDownCast()

◆ ScheduleTask()

◆ SetCurrentThreadPriorityToBackground()

◆ SetMRMLSceneDataIO()

◆ SetTracingOff()

◆ SetTracingOn()

◆ TerminateProcessingThread()