Slicer  4.13
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
vtkMRMLAbstractSliceViewDisplayableManager Class Reference

Superclass for displayable manager classes. More...

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

Inheritance diagram for vtkMRMLAbstractSliceViewDisplayableManager:
Inheritance graph
[legend]
Collaboration diagram for vtkMRMLAbstractSliceViewDisplayableManager:
Collaboration graph
[legend]

Public Types

typedef vtkMRMLAbstractSliceViewDisplayableManager Self
 
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

void ConvertDeviceToXYZ (double x, double y, double xyz[3])
 
void ConvertRASToXYZ (double ras[3], double xyz[3])
 
void ConvertXYZToRAS (double xyz[3], double ras[3])
 
virtual const char * GetClassName ()
 
vtkMRMLSliceNodeGetMRMLSliceNode ()
 Get MRML SliceNode. More...
 
virtual int IsA (const char *type)
 
void PrintSelf (ostream &os, vtkIndent indent) override
 
- Public Member Functions inherited from vtkMRMLAbstractDisplayableManager
virtual bool CanProcessInteractionEvent (vtkMRMLInteractionEventData *eventData, double &distance2)
 
virtual std::string GetDataProbeInfoStringForPosition (double vtkNotUsed(xyz)[3])
 
virtual bool GetGrabFocus ()
 Displayable manager can indicate that it would like to get all events (even when mouse pointer is outside the window). More...
 
vtkMRMLInteractionNodeGetInteractionNode ()
 Convenient method to get the current InteractionNode. More...
 
virtual bool GetInteractive ()
 Displayable manager can indicate that the window is in interactive mode (faster updates). More...
 
vtkRenderWindowInteractor * GetInteractor ()
 Convenient method to get the WindowInteractor associated with the Renderer. More...
 
virtual vtkMRMLLightBoxRendererManagerProxyGetLightBoxRendererManagerProxy ()
 
virtual int GetMouseCursor ()
 Displayable manager returns ID of the mouse cursor shape that should be displayed. More...
 
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) override
 
virtual bool ProcessInteractionEvent (vtkMRMLInteractionEventData *eventData)
 
virtual void SetHasFocus (bool hasFocus)
 Set if the widget gets/loses focus (interaction events are processed by this displayable manager). More...
 
virtual void SetLightBoxRendererManagerProxy (vtkMRMLLightBoxRendererManagerProxy *)
 
void SetMouseCursor (int cursor)
 
- 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 void ConvertDeviceToXYZ (vtkRenderWindowInteractor *interactor, vtkMRMLSliceNode *sliceNode, double x, double y, double xyz[3])
 
static void ConvertDeviceToXYZ (vtkRenderer *renderer, vtkMRMLSliceNode *sliceNode, double x, double y, double xyz[3])
 
static void ConvertRASToXYZ (vtkMRMLSliceNode *sliceNode, double ras[3], double xyz[3])
 
static void ConvertXYZToRAS (vtkMRMLSliceNode *sliceNode, double xyz[3], double ras[3])
 
static int IsTypeOf (const char *type)
 
static vtkMRMLAbstractSliceViewDisplayableManagerNew ()
 
static vtkMRMLAbstractSliceViewDisplayableManagerSafeDownCast (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

void OnMRMLDisplayableNodeModifiedEvent (vtkObject *caller) override
 
virtual void OnMRMLSliceNodeModifiedEvent ()
 Could be overloaded if DisplayableManager subclass. More...
 
 vtkMRMLAbstractSliceViewDisplayableManager ()
 
 ~vtkMRMLAbstractSliceViewDisplayableManager () override
 
- 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...
 
virtual void Create ()
 
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 OnInteractorStyleEvent (int eventid)
 
void ProcessMRMLNodesEvents (vtkObject *caller, unsigned long event, void *callData) override
 
virtual void ProcessWidgetsEvents (vtkObject *caller, unsigned long event, void *callData)
 
void RemoveInteractorObservableEvent (int eventid)
 
void RemoveInteractorStyleObservableEvent (int eventid)
 
virtual void RemoveMRMLObservers ()
 Remove MRML observers. More...
 
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)
 
void SetMRMLSceneInternal (vtkMRMLScene *newScene) override
 
virtual void SetRenderer (vtkRenderer *newRenderer)
 
void SetUpdateFromMRMLRequested (bool requested)
 
virtual void UpdateFromMRML ()
 
 vtkMRMLAbstractDisplayableManager ()
 
 ~vtkMRMLAbstractDisplayableManager () 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 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 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
 

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

Superclass for displayable manager classes.

A displayable manager class is responsible to represent a MRMLDisplayable node in a renderer.

Definition at line 35 of file vtkMRMLAbstractSliceViewDisplayableManager.h.

Member Typedef Documentation

◆ Self

Definition at line 40 of file vtkMRMLAbstractSliceViewDisplayableManager.h.

◆ Superclass

Definition at line 45 of file vtkMRMLAbstractSliceViewDisplayableManager.h.

Constructor & Destructor Documentation

◆ vtkMRMLAbstractSliceViewDisplayableManager()

vtkMRMLAbstractSliceViewDisplayableManager::vtkMRMLAbstractSliceViewDisplayableManager ( )
protected

◆ ~vtkMRMLAbstractSliceViewDisplayableManager()

vtkMRMLAbstractSliceViewDisplayableManager::~vtkMRMLAbstractSliceViewDisplayableManager ( )
overrideprotected

Member Function Documentation

◆ ConvertDeviceToXYZ() [1/3]

void vtkMRMLAbstractSliceViewDisplayableManager::ConvertDeviceToXYZ ( double  x,
double  y,
double  xyz[3] 
)

Convert device coordinates (display) to XYZ coordinates (viewport). Parameter xyz is double[3]

See also
ConvertDeviceToXYZ(vtkRenderWindowInteractor *, vtkMRMLSliceNode *, double x, double y, double xyz[3])

◆ ConvertDeviceToXYZ() [2/3]

static void vtkMRMLAbstractSliceViewDisplayableManager::ConvertDeviceToXYZ ( vtkRenderWindowInteractor *  interactor,
vtkMRMLSliceNode sliceNode,
double  x,
double  y,
double  xyz[3] 
)
static

Convenience function allowing to convert device coordinates (display) to XYZ coordinates (viewport). Parameter xyz is double[3]

◆ ConvertDeviceToXYZ() [3/3]

static void vtkMRMLAbstractSliceViewDisplayableManager::ConvertDeviceToXYZ ( vtkRenderer *  renderer,
vtkMRMLSliceNode sliceNode,
double  x,
double  y,
double  xyz[3] 
)
static

Convenience function allowing to convert device coordinates (display) to XYZ coordinates (viewport). Parameter xyz is double[3]

◆ ConvertRASToXYZ() [1/2]

void vtkMRMLAbstractSliceViewDisplayableManager::ConvertRASToXYZ ( double  ras[3],
double  xyz[3] 
)

Convert RAS to XYZ coordinates (viewport). Parameters ras and xyz are double[3]. xyz[2] is the lightbox id.

See also
ConvertRASToXYZ(vtkMRMLSliceNode * sliceNode, double ras[3], double xyz[3])

◆ ConvertRASToXYZ() [2/2]

static void vtkMRMLAbstractSliceViewDisplayableManager::ConvertRASToXYZ ( vtkMRMLSliceNode sliceNode,
double  ras[3],
double  xyz[3] 
)
static

Convenience function allowing to convert RAS to XYZ coordinates (viewport). Parameters ras and xyz are double[3]. xyz[2] is the lightbox id.

◆ ConvertXYZToRAS() [1/2]

void vtkMRMLAbstractSliceViewDisplayableManager::ConvertXYZToRAS ( double  xyz[3],
double  ras[3] 
)

Convert XYZ (viewport) to RAS coordinates. Parameters ras and xyz are double[3]. xyz[2] is the lightbox id.

See also
ConvertXYZToRAS(vtkMRMLSliceNode * sliceNode, double xyz[3], double ras[3])

◆ ConvertXYZToRAS() [2/2]

static void vtkMRMLAbstractSliceViewDisplayableManager::ConvertXYZToRAS ( vtkMRMLSliceNode sliceNode,
double  xyz[3],
double  ras[3] 
)
static

Convenience function allowing to Convert XYZ (viewport) to RAS coordinates. Parameters ras and xyz are double[3]. xyz[2] is the lightbox id.

◆ GetClassName()

virtual const char* vtkMRMLAbstractSliceViewDisplayableManager::GetClassName ( )
virtual

◆ GetMRMLSliceNode()

vtkMRMLSliceNode* vtkMRMLAbstractSliceViewDisplayableManager::GetMRMLSliceNode ( )

Get MRML SliceNode.

◆ IsA()

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

◆ IsTypeOf()

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

◆ New()

static vtkMRMLAbstractSliceViewDisplayableManager* vtkMRMLAbstractSliceViewDisplayableManager::New ( )
static

◆ OnMRMLDisplayableNodeModifiedEvent()

void vtkMRMLAbstractSliceViewDisplayableManager::OnMRMLDisplayableNodeModifiedEvent ( vtkObject *  caller)
overrideprotectedvirtual

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

Reimplemented from vtkMRMLAbstractDisplayableManager.

◆ OnMRMLSliceNodeModifiedEvent()

virtual void vtkMRMLAbstractSliceViewDisplayableManager::OnMRMLSliceNodeModifiedEvent ( )
inlineprotectedvirtual

Could be overloaded if DisplayableManager subclass.

Reimplemented in vtkMRMLCrosshairDisplayableManager, and vtkMRMLScalarBarDisplayableManager.

Definition at line 92 of file vtkMRMLAbstractSliceViewDisplayableManager.h.

◆ PrintSelf()

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

◆ SafeDownCast()

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

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