Slicer  5.0
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
vtkMRMLScalarBarDisplayableManager Class Reference

Displayable manager for window/level adjustment of volumes. More...

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

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

Public Types

typedef vtkMRMLAbstractSliceViewDisplayableManager Superclass
 
- Public Types inherited from vtkMRMLAbstractSliceViewDisplayableManager
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

bool CanProcessInteractionEvent (vtkMRMLInteractionEventData *eventData, double &closestDistance2) override
 
bool GetAdjustBackgroundWindowLevelEnabled ()
 
bool GetAdjustForegroundWindowLevelEnabled ()
 
virtual const char * GetClassName ()
 
vtkMRMLWindowLevelWidgetGetWindowLevelWidget ()
 
virtual int IsA (const char *type)
 
void PrintSelf (ostream &os, vtkIndent indent) override
 
bool ProcessInteractionEvent (vtkMRMLInteractionEventData *eventData) override
 
void SetAdjustBackgroundWindowLevelEnabled (bool enabled)
 
void SetAdjustForegroundWindowLevelEnabled (bool enabled)
 
- Public Member Functions inherited from vtkMRMLAbstractSliceViewDisplayableManager
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])
 
vtkMRMLSliceNodeGetMRMLSliceNode ()
 Get MRML SliceNode. More...
 
void PrintSelf (ostream &os, vtkIndent indent) override
 
- Public Member Functions inherited from vtkMRMLAbstractDisplayableManager
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 void SetHasFocus (bool hasFocus, vtkMRMLInteractionEventData *eventData)
 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 int IsTypeOf (const char *type)
 
static vtkMRMLScalarBarDisplayableManagerNew ()
 
static vtkMRMLScalarBarDisplayableManagerSafeDownCast (vtkObject *o)
 
- Static Public Member Functions inherited from vtkMRMLAbstractSliceViewDisplayableManager
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 AdditionalInitializeStep () override
 Method to perform additional initialization. More...
 
void Create () override
 
void OnMRMLSliceNodeModifiedEvent () override
 Called when the SliceNode is modified. May cause ScalarBar to remap its position on screen. More...
 
 vtkMRMLScalarBarDisplayableManager ()
 
 ~vtkMRMLScalarBarDisplayableManager () override
 
- Protected Member Functions inherited from vtkMRMLAbstractSliceViewDisplayableManager
void OnMRMLDisplayableNodeModifiedEvent (vtkObject *caller) override
 
 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)
 
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 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 ()
 
 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

Displayable manager for window/level adjustment of volumes.

This displayable manager only manages window/level adjustment events, does not display "scalar bar" (color legend). Its name was given because orinally it was intended for displaying color legend as well, but later a dedicated displayable manager was added for that purpose (that can be used in any view types, for any displayable node types).

Definition at line 35 of file vtkMRMLScalarBarDisplayableManager.h.

Member Typedef Documentation

◆ Superclass

Definition at line 41 of file vtkMRMLScalarBarDisplayableManager.h.

Constructor & Destructor Documentation

◆ vtkMRMLScalarBarDisplayableManager()

vtkMRMLScalarBarDisplayableManager::vtkMRMLScalarBarDisplayableManager ( )
protected

◆ ~vtkMRMLScalarBarDisplayableManager()

vtkMRMLScalarBarDisplayableManager::~vtkMRMLScalarBarDisplayableManager ( )
overrideprotected

Member Function Documentation

◆ AdditionalInitializeStep()

void vtkMRMLScalarBarDisplayableManager::AdditionalInitializeStep ( )
overrideprotectedvirtual

Method to perform additional initialization.

Reimplemented from vtkMRMLAbstractDisplayableManager.

◆ CanProcessInteractionEvent()

bool vtkMRMLScalarBarDisplayableManager::CanProcessInteractionEvent ( vtkMRMLInteractionEventData eventData,
double &  distance2 
)
overridevirtual

Return true if the displayable manager can process the event. Distance2 is the squared distance in display coordinates from the closest interaction position. The displayable manager with the closest distance will get the chance to process the interaction event.

Reimplemented from vtkMRMLAbstractDisplayableManager.

◆ Create()

void vtkMRMLScalarBarDisplayableManager::Create ( )
overrideprotectedvirtual

Initialize the displayable manager based on its associated vtkMRMLSliceNode

Reimplemented from vtkMRMLAbstractDisplayableManager.

◆ GetAdjustBackgroundWindowLevelEnabled()

bool vtkMRMLScalarBarDisplayableManager::GetAdjustBackgroundWindowLevelEnabled ( )

◆ GetAdjustForegroundWindowLevelEnabled()

bool vtkMRMLScalarBarDisplayableManager::GetAdjustForegroundWindowLevelEnabled ( )

◆ GetClassName()

virtual const char* vtkMRMLScalarBarDisplayableManager::GetClassName ( )
virtual

◆ GetWindowLevelWidget()

vtkMRMLWindowLevelWidget* vtkMRMLScalarBarDisplayableManager::GetWindowLevelWidget ( )

◆ IsA()

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

◆ IsTypeOf()

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

◆ New()

static vtkMRMLScalarBarDisplayableManager* vtkMRMLScalarBarDisplayableManager::New ( )
static

◆ OnMRMLSliceNodeModifiedEvent()

void vtkMRMLScalarBarDisplayableManager::OnMRMLSliceNodeModifiedEvent ( )
overrideprotectedvirtual

Called when the SliceNode is modified. May cause ScalarBar to remap its position on screen.

Reimplemented from vtkMRMLAbstractSliceViewDisplayableManager.

◆ PrintSelf()

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

◆ ProcessInteractionEvent()

bool vtkMRMLScalarBarDisplayableManager::ProcessInteractionEvent ( vtkMRMLInteractionEventData eventData)
overridevirtual

Process an interaction event. Returns true if the event should be aborted (not processed any further by other event observers).

Reimplemented from vtkMRMLAbstractDisplayableManager.

◆ SafeDownCast()

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

◆ SetAdjustBackgroundWindowLevelEnabled()

void vtkMRMLScalarBarDisplayableManager::SetAdjustBackgroundWindowLevelEnabled ( bool  enabled)

◆ SetAdjustForegroundWindowLevelEnabled()

void vtkMRMLScalarBarDisplayableManager::SetAdjustForegroundWindowLevelEnabled ( bool  enabled)

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