Slicer  4.11
Slicer is a multi-platform, free and open source software package for visualization and medical image computing
List of all members | Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions
vtkSlicerSceneViewsModuleLogic Class Reference

#include <Modules/Loadable/SceneViews/Logic/vtkSlicerSceneViewsModuleLogic.h>

Inheritance diagram for vtkSlicerSceneViewsModuleLogic:
Inheritance graph
[legend]
Collaboration diagram for vtkSlicerSceneViewsModuleLogic:
Collaboration graph
[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

void CreateSceneView (const char *name, const char *description, int screenshotType, vtkImageData *screenshot)
 Create a sceneView.. More...
 
virtual const char * GetClassName ()
 
vtkStdString GetSceneViewDescription (const char *id)
 Return the description of an existing sceneView. More...
 
vtkStdString GetSceneViewName (const char *id)
 Return the name of an existing sceneView. More...
 
vtkImageData * GetSceneViewScreenshot (const char *id)
 Return the screenshot of an existing sceneView. More...
 
int GetSceneViewScreenshotType (const char *id)
 Return the screenshotType of an existing sceneView. More...
 
virtual int IsA (const char *type)
 
void ModifySceneView (vtkStdString id, const char *name, const char *description, int screenshotType, vtkImageData *screenshot)
 Modify an existing sceneView. More...
 
const char * MoveSceneViewDown (const char *id)
 Move sceneView up. More...
 
const char * MoveSceneViewUp (const char *id)
 Move sceneView up. More...
 
void PrintSelf (ostream &os, vtkIndent indent) override
 
void RegisterNodes () override
 Register MRML Node classes to Scene. Gets called automatically when the MRMLScene is attached to this logic class. More...
 
void RemoveSceneViewNode (vtkMRMLSceneViewNode *sceneViewNode)
 Remove a scene view node. More...
 
void RestoreSceneView (const char *id, bool removeNodes=true)
 
void SetMRMLSceneInternal (vtkMRMLScene *newScene) override
 Initialize listening to MRML events. More...
 
- Public Member Functions inherited from vtkSlicerModuleLogic
virtual vtkSlicerApplicationLogicGetApplicationLogic ()
 Get access to overall application state. More...
 
std::string GetModuleShareDirectory () const
 
void PrintSelf (ostream &os, vtkIndent indent) override
 
void SetModuleShareDirectory (const std::string &shareDirectory)
 
- Public Member Functions inherited from vtkMRMLAbstractLogic
virtual vtkMRMLApplicationLogicGetMRMLApplicationLogic () const
 Get access to overall application state. More...
 
vtkMRMLSceneGetMRMLScene () const
 Return a reference to the current MRML scene. More...
 
void PrintSelf (ostream &os, vtkIndent indent) override
 
virtual void SetMRMLApplicationLogic (vtkMRMLApplicationLogic *logic)
 
void SetMRMLScene (vtkMRMLScene *newScene)
 Set and observe the MRMLScene. More...
 

Static Public Member Functions

static int IsTypeOf (const char *type)
 
static vtkSlicerSceneViewsModuleLogicNew ()
 
static vtkSlicerSceneViewsModuleLogicSafeDownCast (vtkObject *o)
 
- Static Public Member Functions inherited from vtkSlicerModuleLogic
static int IsTypeOf (const char *type)
 
static vtkSlicerModuleLogicNew ()
 The Usual vtk class functions. More...
 
static vtkSlicerModuleLogicSafeDownCast (vtkObject *o)
 
- Static Public Member Functions inherited from vtkMRMLAbstractLogic
static int IsTypeOf (const char *type)
 
static vtkMRMLAbstractLogicNew ()
 
static vtkMRMLAbstractLogicSafeDownCast (vtkObject *o)
 

Protected Member Functions

void OnMRMLNodeModified (vtkMRMLNode *node) override
 
void OnMRMLSceneEndClose () override
 
void OnMRMLSceneEndImport () override
 
void OnMRMLSceneEndRestore () override
 
void OnMRMLSceneNodeAdded (vtkMRMLNode *node) override
 
 vtkSlicerSceneViewsModuleLogic ()
 
 ~vtkSlicerSceneViewsModuleLogic () 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 ()
 
vtkObserverManagerGetMRMLLogicsObserverManager () const
 
vtkCallbackCommand * GetMRMLNodesCallbackCommand ()
 
vtkObserverManagerGetMRMLNodesObserverManager () const
 
vtkCallbackCommand * GetMRMLSceneCallbackCommand ()
 
vtkObserverManagerGetMRMLSceneObserverManager () const
 
int GetPendingModifiedEventCount () const
 
int GetProcessingMRMLSceneEvent () const
 Return the event id currently processed or 0 if any. More...
 
int InvokePendingModifiedEvent ()
 
void Modified () override
 
virtual void ObserveMRMLScene ()
 
virtual void OnMRMLSceneEndBatchProcess ()
 
virtual void OnMRMLSceneNew ()
 
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)
 
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
 

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. More...
 
static void MRMLNodesCallback (vtkObject *caller, unsigned long eid, void *clientData, void *callData)
 MRMLNodesCallback is a static function to relay modified events from the nodes. More...
 
static void MRMLSceneCallback (vtkObject *caller, unsigned long eid, void *clientData, void *callData)
 

Detailed Description

Definition at line 44 of file vtkSlicerSceneViewsModuleLogic.h.

Member Typedef Documentation

◆ Superclass

Definition at line 50 of file vtkSlicerSceneViewsModuleLogic.h.

Constructor & Destructor Documentation

◆ vtkSlicerSceneViewsModuleLogic()

vtkSlicerSceneViewsModuleLogic::vtkSlicerSceneViewsModuleLogic ( )
protected

◆ ~vtkSlicerSceneViewsModuleLogic()

vtkSlicerSceneViewsModuleLogic::~vtkSlicerSceneViewsModuleLogic ( )
overrideprotected

Member Function Documentation

◆ CreateSceneView()

void vtkSlicerSceneViewsModuleLogic::CreateSceneView ( const char *  name,
const char *  description,
int  screenshotType,
vtkImageData *  screenshot 
)

Create a sceneView..

◆ GetClassName()

virtual const char* vtkSlicerSceneViewsModuleLogic::GetClassName ( )
virtual

Reimplemented from vtkSlicerModuleLogic.

◆ GetSceneViewDescription()

vtkStdString vtkSlicerSceneViewsModuleLogic::GetSceneViewDescription ( const char *  id)

Return the description of an existing sceneView.

◆ GetSceneViewName()

vtkStdString vtkSlicerSceneViewsModuleLogic::GetSceneViewName ( const char *  id)

Return the name of an existing sceneView.

◆ GetSceneViewScreenshot()

vtkImageData* vtkSlicerSceneViewsModuleLogic::GetSceneViewScreenshot ( const char *  id)

Return the screenshot of an existing sceneView.

◆ GetSceneViewScreenshotType()

int vtkSlicerSceneViewsModuleLogic::GetSceneViewScreenshotType ( const char *  id)

Return the screenshotType of an existing sceneView.

◆ IsA()

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

Reimplemented from vtkSlicerModuleLogic.

◆ IsTypeOf()

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

◆ ModifySceneView()

void vtkSlicerSceneViewsModuleLogic::ModifySceneView ( vtkStdString  id,
const char *  name,
const char *  description,
int  screenshotType,
vtkImageData *  screenshot 
)

Modify an existing sceneView.

◆ MoveSceneViewDown()

const char* vtkSlicerSceneViewsModuleLogic::MoveSceneViewDown ( const char *  id)

Move sceneView up.

◆ MoveSceneViewUp()

const char* vtkSlicerSceneViewsModuleLogic::MoveSceneViewUp ( const char *  id)

Move sceneView up.

◆ New()

static vtkSlicerSceneViewsModuleLogic* vtkSlicerSceneViewsModuleLogic::New ( )
static

◆ OnMRMLNodeModified()

void vtkSlicerSceneViewsModuleLogic::OnMRMLNodeModified ( vtkMRMLNode )
overrideprotectedvirtual

Called after the corresponding MRML event is triggered.

See also
ProcessMRMLNodesEvents

Reimplemented from vtkMRMLAbstractLogic.

◆ OnMRMLSceneEndClose()

void vtkSlicerSceneViewsModuleLogic::OnMRMLSceneEndClose ( )
overrideprotectedvirtual

If vtkMRMLScene::EndCloseEvent has been set to be observed in SetMRMLSceneInternal, it is called when the scene fires the event

See also
ProcessMRMLSceneEvents, SetMRMLSceneInternal
OnMRMLSceneStartClose

Reimplemented from vtkMRMLAbstractLogic.

◆ OnMRMLSceneEndImport()

void vtkSlicerSceneViewsModuleLogic::OnMRMLSceneEndImport ( )
overrideprotectedvirtual

If vtkMRMLScene::EndImportEvent has been set to be observed in SetMRMLSceneInternal, it is called when the scene fires the event

See also
ProcessMRMLSceneEvents, SetMRMLSceneInternal
OnMRMLSceneStartImport, OnMRMLSceneNew

Reimplemented from vtkMRMLAbstractLogic.

◆ OnMRMLSceneEndRestore()

void vtkSlicerSceneViewsModuleLogic::OnMRMLSceneEndRestore ( )
overrideprotectedvirtual

If vtkMRMLScene::EndRestoreEvent has been set to be observed in SetMRMLSceneInternal, it is called when the scene fires the event

See also
ProcessMRMLSceneEvents, SetMRMLSceneInternal
OnMRMLSceneStartRestore

Reimplemented from vtkMRMLAbstractLogic.

◆ OnMRMLSceneNodeAdded()

void vtkSlicerSceneViewsModuleLogic::OnMRMLSceneNodeAdded ( vtkMRMLNode )
overrideprotectedvirtual

If vtkMRMLScene::NodeAddedEvent has been set to be observed in SetMRMLSceneInternal, it is called when the scene fires the event

See also
ProcessMRMLSceneEvents, SetMRMLSceneInternal
OnMRMLSceneNodeRemoved, vtkMRMLScene::NodeAboutToBeAdded

Reimplemented from vtkMRMLAbstractLogic.

◆ PrintSelf()

void vtkSlicerSceneViewsModuleLogic::PrintSelf ( ostream &  os,
vtkIndent  indent 
)
override

◆ RegisterNodes()

void vtkSlicerSceneViewsModuleLogic::RegisterNodes ( )
overridevirtual

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

Reimplemented from vtkMRMLAbstractLogic.

◆ RemoveSceneViewNode()

void vtkSlicerSceneViewsModuleLogic::RemoveSceneViewNode ( vtkMRMLSceneViewNode sceneViewNode)

Remove a scene view node.

◆ RestoreSceneView()

void vtkSlicerSceneViewsModuleLogic::RestoreSceneView ( const char *  id,
bool  removeNodes = true 
)

Restore a sceneView. If removeNodes flag is false, don't restore the scene if it will remove data. removeNodes defaults to true for backward compatibility.

◆ SafeDownCast()

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

◆ SetMRMLSceneInternal()

void vtkSlicerSceneViewsModuleLogic::SetMRMLSceneInternal ( vtkMRMLScene newScene)
overridevirtual

Initialize listening to MRML events.

Reimplemented from vtkMRMLAbstractLogic.


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