Slicer  4.8
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
vtkMRMLScriptedDisplayableManager Class Reference

#include <Libs/MRML/DisplayableManager/vtkMRMLScriptedDisplayableManager.h>

Inheritance diagram for vtkMRMLScriptedDisplayableManager:
Inheritance graph
Collaboration diagram for vtkMRMLScriptedDisplayableManager:
Collaboration graph

Public Types

typedef vtkMRMLAbstractDisplayableManager Superclass
- Public Types inherited from vtkMRMLAbstractDisplayableManager
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 int IsA (const char *type)
void PrintSelf (ostream &os, vtkIndent indent) VTK_OVERRIDE
void SetPythonSource (const std::string &pythonSource)
- Public Member Functions inherited from vtkMRMLAbstractDisplayableManager
virtual std::string GetDataProbeInfoStringForPosition (double vtkNotUsed(xyz)[3])
vtkMRMLInteractionNodeGetInteractionNode ()
 Convenient method to get the current InteractionNode. More...
vtkRenderWindowInteractor * GetInteractor ()
 Convenient method to get the WindowInteractor associated with the Renderer. More...
virtual vtkMRMLLightBoxRendererManagerProxyGetLightBoxRendererManagerProxy ()
vtkRenderer * GetRenderer ()
 Get the default renderer for this displayable manager. More...
vtkRenderer * GetRenderer (int idx)
vtkMRMLSelectionNodeGetSelectionNode ()
 Convenient method to get the current SelectionNode. More...
bool IsCreated ()
void PrintSelf (ostream &os, vtkIndent indent) VTK_OVERRIDE
virtual void SetLightBoxRendererManagerProxy (vtkMRMLLightBoxRendererManagerProxy *)
- 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) VTK_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 vtkMRMLScriptedDisplayableManagerNew ()
static vtkMRMLScriptedDisplayableManagerSafeDownCast (vtkObject *o)
- Static Public Member Functions inherited from vtkMRMLAbstractDisplayableManager
static int IsTypeOf (const char *type)
static vtkMRMLAbstractDisplayableManagerNew ()
static vtkMRMLAbstractDisplayableManagerSafeDownCast (vtkObject *o)
- Static Public Member Functions inherited from vtkMRMLAbstractLogic
static int IsTypeOf (const char *type)
static vtkMRMLAbstractLogicNew ()
static vtkMRMLAbstractLogicSafeDownCast (vtkObject *o)

Protected Member Functions

virtual void Create () VTK_OVERRIDE
virtual void OnInteractorStyleEvent (int eventid) VTK_OVERRIDE
virtual void OnMRMLDisplayableNodeModifiedEvent (vtkObject *caller) VTK_OVERRIDE
virtual void ProcessMRMLNodesEvents (vtkObject *caller, unsigned long event, void *callData) VTK_OVERRIDE
virtual void ProcessMRMLSceneEvents (vtkObject *caller, unsigned long event, void *callData) VTK_OVERRIDE
virtual void RemoveMRMLObservers () VTK_OVERRIDE
 Remove MRML observers. More...
virtual void SetMRMLSceneInternal (vtkMRMLScene *newScene) VTK_OVERRIDE
virtual void UpdateFromMRML () VTK_OVERRIDE
 vtkMRMLScriptedDisplayableManager ()
virtual ~vtkMRMLScriptedDisplayableManager ()
- Protected Member Functions inherited from vtkMRMLAbstractDisplayableManager
virtual int ActiveInteractionModes ()
void AddInteractorObservableEvent (int eventid, float priority=0.0)
void AddInteractorStyleObservableEvent (int eventid, float priority=0.0)
virtual void AdditionalInitializeStep ()
void AddMRMLDisplayableManagerEvent (int eventId)
 Allow to specify additional events that the DisplayableNode will observe. More...
void CreateIfPossible ()
int GetInteractorAbortFlag ()
int GetInteractorStyleAbortFlag ()
vtkMRMLDisplayableManagerGroupGetMRMLDisplayableManagerGroup ()
 Get associated DisplayableManager group. More...
vtkMRMLNodeGetMRMLDisplayableNode ()
 Get MRML Displayable Node. More...
vtkCallbackCommand * GetWidgetsCallbackCommand ()
 Get vtkWidget callbackCommand. More...
vtkObserverManagerGetWidgetsObserverManager () const
 Get widget observerManager. More...
void InteractorAbortFlagOff ()
void InteractorAbortFlagOn ()
void InteractorStyleAbortFlagOff ()
void InteractorStyleAbortFlagOn ()
virtual void OnInteractorEvent (int eventid)
virtual void ProcessWidgetsEvents (vtkObject *caller, unsigned long event, void *callData)
void RemoveInteractorObservableEvent (int eventid)
void RemoveInteractorStyleObservableEvent (int eventid)
void RequestRender ()
void SetAndObserveMRMLDisplayableNode (vtkMRMLNode *newMRMLDisplayableNode)
void SetInteractorAbortFlag (int f)
 Set the Abort flag on the Interactor event callback. More...
void SetInteractorStyleAbortFlag (int f)
 Set the Abort flag on the InteractorStyle event callback. More...
virtual void SetMRMLDisplayableManagerGroup (vtkMRMLDisplayableManagerGroup *group)
virtual void SetRenderer (vtkRenderer *newRenderer)
void SetUpdateFromMRMLRequested (bool requested)
 vtkMRMLAbstractDisplayableManager ()
virtual ~vtkMRMLAbstractDisplayableManager ()
- 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 ()
virtual void Modified () VTK_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 RegisterNodes ()
void SetAndObserveMRMLSceneEventsInternal (vtkMRMLScene *newScene, vtkIntArray *events, vtkFloatArray *priorities=0)
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 ()
virtual ~vtkMRMLAbstractLogic ()

Additional Inherited Members

- Static Protected Member Functions inherited from vtkMRMLAbstractDisplayableManager
static void WidgetsCallback (vtkObject *caller, unsigned long eid, void *clientData, void *callData)
 WidgetsCallback is a static function to relay modified events from the vtk widgets. More...
- 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 29 of file vtkMRMLScriptedDisplayableManager.h.

Member Typedef Documentation

◆ Superclass

Definition at line 35 of file vtkMRMLScriptedDisplayableManager.h.

Constructor & Destructor Documentation

◆ vtkMRMLScriptedDisplayableManager()

vtkMRMLScriptedDisplayableManager::vtkMRMLScriptedDisplayableManager ( )

◆ ~vtkMRMLScriptedDisplayableManager()

virtual vtkMRMLScriptedDisplayableManager::~vtkMRMLScriptedDisplayableManager ( )

Member Function Documentation

◆ Create()

virtual void vtkMRMLScriptedDisplayableManager::Create ( )

Called after a valid MRML DisplayableNode is set. By default it simulates a ModifiedEvent event on the displayable node so that ProcessMRMLNodesEvents(displayableNode, ModifiedEvent) is called.

GetRenderer() and GetMRMLDisplayableNode() will return valid object

Reimplemented from vtkMRMLAbstractDisplayableManager.

◆ GetClassName()

virtual const char* vtkMRMLScriptedDisplayableManager::GetClassName ( )

Reimplemented from vtkMRMLAbstractDisplayableManager.

◆ IsA()

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

Reimplemented from vtkMRMLAbstractDisplayableManager.

◆ IsTypeOf()

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

◆ New()

static vtkMRMLScriptedDisplayableManager* vtkMRMLScriptedDisplayableManager::New ( )

◆ OnInteractorStyleEvent()

virtual void vtkMRMLScriptedDisplayableManager::OnInteractorStyleEvent ( int  eventid)

Called after interactor style event specified using AddInteractorStyleObservableEvent are invoked.

The following events are observed by default:
  • vtkCommand::LeftButtonPressEvent
  • vtkCommand::LeftButtonReleaseEvent
  • vtkCommand::RightButtonPressEvent
  • vtkCommand::RightButtonReleaseEvent
  • vtkCommand::MiddleButtonPressEvent
  • vtkCommand::MiddleButtonReleaseEvent
  • vtkCommand::MouseWheelBackwardEvent
  • vtkCommand::MouseWheelForwardEvent
  • vtkCommand::EnterEvent
  • vtkCommand::LeaveEvent
See also
AddInteractorStyleObservableEvent RemoveInteractorStyleObservableEvent

Reimplemented from vtkMRMLAbstractDisplayableManager.

◆ OnMRMLDisplayableNodeModifiedEvent()

virtual void vtkMRMLScriptedDisplayableManager::OnMRMLDisplayableNodeModifiedEvent ( vtkObject *  caller)

ProcessMRMLNodesEvents calls OnMRMLDisplayableNodeModifiedEvent when the displayable node (e.g. vtkMRMLSliceNode, vtkMRMLViewNode) is Modified. Could be overloaded in DisplayableManager subclass.

Reimplemented from vtkMRMLAbstractDisplayableManager.

◆ PrintSelf()

void vtkMRMLScriptedDisplayableManager::PrintSelf ( ostream &  os,
vtkIndent  indent 

◆ ProcessMRMLNodesEvents()

virtual void vtkMRMLScriptedDisplayableManager::ProcessMRMLNodesEvents ( vtkObject *  caller,
unsigned long  event,
void *  callData 

Receives all the events fired by the nodes. To listen to a node, you can add an observer using GetMRMLNodesCallbackCommand() or use the utility macros vtk[SetAndObserve|Observe]MRMLNode[Event]Macro ProcessMRMLNodesEvents calls OnMRMLNodeModified when event is vtkCommand::ModifiedEvent.

See also
ProcessMRMLSceneEvents, ProcessMRMLLogicsEvents, OnMRMLNodeModified(), vtkSetAndObserveMRMLNodeMacro, vtkObserveMRMLNodeMacro, vtkSetAndObserveMRMLNodeEventMacro

Reimplemented from vtkMRMLAbstractDisplayableManager.

◆ ProcessMRMLSceneEvents()

virtual void vtkMRMLScriptedDisplayableManager::ProcessMRMLSceneEvents ( vtkObject *  caller,
unsigned long  event,
void *  callData 

Receives all the events fired by the scene. By default, it calls OnMRMLScene*Event based on the event passed.

Reimplemented from vtkMRMLAbstractLogic.

◆ RemoveMRMLObservers()

virtual void vtkMRMLScriptedDisplayableManager::RemoveMRMLObservers ( )

Remove MRML observers.

Reimplemented from vtkMRMLAbstractDisplayableManager.

◆ SafeDownCast()

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

◆ SetMRMLSceneInternal()

virtual void vtkMRMLScriptedDisplayableManager::SetMRMLSceneInternal ( vtkMRMLScene newScene)

Called by SetMRMLScene - Used to initialize the Scene Observe all the events of the scene and call OnMRMLSceneEndClose() or OnMRMLSceneEndImport() if the new scene is valid

Reimplemented from vtkMRMLAbstractDisplayableManager.

◆ SetPythonSource()

void vtkMRMLScriptedDisplayableManager::SetPythonSource ( const std::string &  pythonSource)

◆ UpdateFromMRML()

virtual void vtkMRMLScriptedDisplayableManager::UpdateFromMRML ( )

Called from RequestRender method if UpdateFromMRMLRequested is true

See also
RequestRender() SetUpdateFromMRMLRequested()

Reimplemented from vtkMRMLAbstractDisplayableManager.

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