Slicer  5.1
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
vtkMRMLColorLegendDisplayableManager Class Reference

Displayable manager for color legends. More...

#include <Modules/Loadable/Colors/MRMLDM/vtkMRMLColorLegendDisplayableManager.h>

Inheritance diagram for vtkMRMLColorLegendDisplayableManager:
Inheritance graph
Collaboration diagram for vtkMRMLColorLegendDisplayableManager:
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 ()
vtkSlicerScalarBarActorGetColorLegendActor (vtkMRMLColorLegendDisplayNode *dispNode) const
 Get scalar bar actor. 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, 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 vtkMRMLColorLegendDisplayableManagerNew ()
static vtkMRMLColorLegendDisplayableManagerSafeDownCast (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 OnMRMLDisplayableNodeModifiedEvent (vtkObject *caller) override
 Called when the SliceNode or Three3DViewNode are modified. May cause ColorLegend to remap its position on screen. More...
void OnMRMLSceneNodeAdded (vtkMRMLNode *node) override
void OnMRMLSceneNodeRemoved (vtkMRMLNode *node) override
void ProcessMRMLNodesEvents (vtkObject *caller, unsigned long event, void *callData) override
void SetMRMLSceneInternal (vtkMRMLScene *newScene) override
void UnobserveMRMLScene () override
void UpdateFromMRML () override
void UpdateFromMRMLScene () override
 vtkMRMLColorLegendDisplayableManager ()
 ~vtkMRMLColorLegendDisplayableManager () 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)
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)
virtual void SetRenderer (vtkRenderer *newRenderer)
void SetUpdateFromMRMLRequested (bool requested)
 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 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 color legends.

This displayable manager implements color legend display in both 2D and 3D views.

Definition at line 33 of file vtkMRMLColorLegendDisplayableManager.h.

Member Typedef Documentation

◆ Superclass

Definition at line 38 of file vtkMRMLColorLegendDisplayableManager.h.

Constructor & Destructor Documentation

◆ vtkMRMLColorLegendDisplayableManager()

vtkMRMLColorLegendDisplayableManager::vtkMRMLColorLegendDisplayableManager ( )

◆ ~vtkMRMLColorLegendDisplayableManager()

vtkMRMLColorLegendDisplayableManager::~vtkMRMLColorLegendDisplayableManager ( )

Member Function Documentation

◆ AdditionalInitializeStep()

void vtkMRMLColorLegendDisplayableManager::AdditionalInitializeStep ( )

Method to perform additional initialization.

Reimplemented from vtkMRMLAbstractDisplayableManager.

◆ Create()

void vtkMRMLColorLegendDisplayableManager::Create ( )

Initialize the displayable manager based on its associated vtkMRMLSliceNode

Reimplemented from vtkMRMLAbstractDisplayableManager.

◆ GetClassName()

virtual const char* vtkMRMLColorLegendDisplayableManager::GetClassName ( )

Reimplemented from vtkMRMLAbstractDisplayableManager.

◆ GetColorLegendActor()

vtkSlicerScalarBarActor* vtkMRMLColorLegendDisplayableManager::GetColorLegendActor ( vtkMRMLColorLegendDisplayNode dispNode) const

Get scalar bar actor.

dispNode- color legend display node
scalar bar actor pointer

◆ IsA()

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

Reimplemented from vtkMRMLAbstractDisplayableManager.

◆ IsTypeOf()

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

◆ New()

static vtkMRMLColorLegendDisplayableManager* vtkMRMLColorLegendDisplayableManager::New ( )

◆ OnMRMLDisplayableNodeModifiedEvent()

void vtkMRMLColorLegendDisplayableManager::OnMRMLDisplayableNodeModifiedEvent ( vtkObject *  caller)

Called when the SliceNode or Three3DViewNode are modified. May cause ColorLegend to remap its position on screen.

Reimplemented from vtkMRMLAbstractDisplayableManager.

◆ OnMRMLSceneNodeAdded()

void vtkMRMLColorLegendDisplayableManager::OnMRMLSceneNodeAdded ( vtkMRMLNode )

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.

◆ OnMRMLSceneNodeRemoved()

void vtkMRMLColorLegendDisplayableManager::OnMRMLSceneNodeRemoved ( vtkMRMLNode )

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

See also
ProcessMRMLSceneEvents, SetMRMLSceneInternal
OnMRMLSceneNodeAdded, vtkMRMLScene::NodeAboutToBeRemoved

Reimplemented from vtkMRMLAbstractLogic.

◆ PrintSelf()

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

◆ ProcessMRMLNodesEvents()

void vtkMRMLColorLegendDisplayableManager::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.

◆ SafeDownCast()

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

◆ SetMRMLSceneInternal()

void vtkMRMLColorLegendDisplayableManager::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.

◆ UnobserveMRMLScene()

void vtkMRMLColorLegendDisplayableManager::UnobserveMRMLScene ( )

Called anytime a scene is not set to the logic anymore (e.g. a new or no scene is set) Reimplement the method to delete all the scene specific information such as a node IDs, pointers...

See also
SetMRMLSceneInternal, ObserveMRMLScene, UpdateFromMRMLScene

Reimplemented from vtkMRMLAbstractLogic.

◆ UpdateFromMRML()

void vtkMRMLColorLegendDisplayableManager::UpdateFromMRML ( )

Called from RequestRender method if UpdateFromMRMLRequested is true

See also
RequestRender() SetUpdateFromMRMLRequested()

Reimplemented from vtkMRMLAbstractDisplayableManager.

◆ UpdateFromMRMLScene()

void vtkMRMLColorLegendDisplayableManager::UpdateFromMRMLScene ( )

Called every time the scene has been significantly changed. If the scene BatchProcessState events are observed (in SetMRMLSceneInternal() ), UpdateFromMRMLScene is called after each batch process (Close, Import, Restore...). It is also being called by default when a new scene is set (SetMRMLScene).

See also
SetMRMLSceneInternal, UnobserveMRMLScene, ObserveMRMLScene

Reimplemented from vtkMRMLAbstractLogic.

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