Displayable manager that configures a vtkRenderer from a vtkMRMLViewNode and its associated active vtkMRMLCameraNode. It essentially configures: More...

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

Inheritance diagram for vtkMRMLViewDisplayableManager:

[legend]

Collaboration diagram for vtkMRMLViewDisplayableManager:

[legend]

Public Types
typedef vtkMRMLAbstractThreeDViewDisplayableManager	Superclass

Public Types inherited from vtkMRMLAbstractThreeDViewDisplayableManager
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) override

Public Member Functions inherited from vtkMRMLAbstractThreeDViewDisplayableManager
vtkMRMLViewNode *	GetMRMLViewNode ()
	Get MRML ViewNode. More...

virtual const char *	GetPickedNodeID ()
	Get the MRML ID of the picked node, returns empty string if no pick. More...

virtual int	Pick3D (double vtkNotUsed(ras)[3])

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...

vtkMRMLInteractionNode *	GetInteractionNode ()
	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 vtkMRMLLightBoxRendererManagerProxy *	GetLightBoxRendererManagerProxy ()

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)

vtkMRMLSelectionNode *	GetSelectionNode ()
	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 vtkMRMLApplicationLogic *	GetMRMLApplicationLogic () const
	Get access to overall application state. More...

vtkMRMLScene *	GetMRMLScene () 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 vtkMRMLViewDisplayableManager *	New ()

static vtkMRMLViewDisplayableManager *	SafeDownCast (vtkObject *o)

Static Public Member Functions inherited from vtkMRMLAbstractThreeDViewDisplayableManager
static int	IsTypeOf (const char *type)

static vtkMRMLAbstractThreeDViewDisplayableManager *	New ()

static vtkMRMLAbstractThreeDViewDisplayableManager *	SafeDownCast (vtkObject *o)

Static Public Member Functions inherited from vtkMRMLAbstractDisplayableManager
static int	IsTypeOf (const char *type)

static vtkMRMLAbstractDisplayableManager *	New ()

static vtkMRMLAbstractDisplayableManager *	SafeDownCast (vtkObject *o)

Static Public Member Functions inherited from vtkMRMLAbstractLogic
static int	IsTypeOf (const char *type)

static vtkMRMLAbstractLogic *	New ()

static vtkMRMLAbstractLogic *	SafeDownCast (vtkObject *o)

Protected Member Functions
void	AdditionalInitializeStep () override

void	Create () override
	Observe the View node and initialize the renderer accordingly. More...

void	OnMRMLDisplayableNodeModifiedEvent (vtkObject *caller) override

void	ProcessMRMLNodesEvents (vtkObject caller, unsigned long event, void callData) override
	Receives events from the view and the camera nodes. More...

void	ProcessWidgetsEvents (vtkObject caller, unsigned long event, void callData) override

void	SetAndObserveCameraNode (vtkMRMLCameraNode *cameraNodeToObserve)

void	UpdateFromCameraNode ()

void	UpdateFromViewNode ()

	vtkMRMLViewDisplayableManager ()

	~vtkMRMLViewDisplayableManager () override

Protected Member Functions inherited from vtkMRMLAbstractThreeDViewDisplayableManager
virtual void	OnMRMLViewNodeModifiedEvent ()
	Could be overloaded in DisplayableManager subclass. More...

virtual void	PassThroughInteractorStyleEvent (int eventid)

	vtkMRMLAbstractThreeDViewDisplayableManager ()

	~vtkMRMLAbstractThreeDViewDisplayableManager () 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 ()

vtkMRMLDisplayableManagerGroup *	GetMRMLDisplayableManagerGroup ()
	Get associated DisplayableManager group. More...

vtkMRMLNode *	GetMRMLDisplayableNode ()
	Get MRML Displayable Node. More...

vtkCallbackCommand *	GetWidgetsCallbackCommand ()
	Get vtkWidget callbackCommand. More...

vtkObserverManager *	GetWidgetsObserverManager () const
	Get widget observerManager. More...

void	InteractorAbortFlagOff ()

void	InteractorAbortFlagOn ()

void	InteractorStyleAbortFlagOff ()

void	InteractorStyleAbortFlagOn ()

virtual void	OnInteractorEvent (int eventid)

virtual void	OnInteractorStyleEvent (int eventid)

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 ()

vtkObserverManager *	GetMRMLLogicsObserverManager () const

vtkCallbackCommand *	GetMRMLNodesCallbackCommand ()

vtkObserverManager *	GetMRMLNodesObserverManager () const

vtkCallbackCommand *	GetMRMLSceneCallbackCommand ()

vtkObserverManager *	GetMRMLSceneObserverManager () 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

Displayable manager that configures a vtkRenderer from a vtkMRMLViewNode and its associated active vtkMRMLCameraNode. It essentially configures:

the axis cube
the axis labels
the background colors (gradient) When the view is rotated, the "closest" axis label is hidden.

Definition at line 38 of file vtkMRMLViewDisplayableManager.h.

Member Typedef Documentation

◆ Superclass

typedef vtkMRMLAbstractThreeDViewDisplayableManager vtkMRMLViewDisplayableManager::Superclass

Definition at line 44 of file vtkMRMLViewDisplayableManager.h.

Constructor & Destructor Documentation

◆ vtkMRMLViewDisplayableManager()

vtkMRMLViewDisplayableManager::vtkMRMLViewDisplayableManager ( )

protected

◆ ~vtkMRMLViewDisplayableManager()

vtkMRMLViewDisplayableManager::~vtkMRMLViewDisplayableManager ( )

overrideprotected

Member Function Documentation

◆ AdditionalInitializeStep()

void vtkMRMLViewDisplayableManager::AdditionalInitializeStep ( )

overrideprotectedvirtual

Sub-class could overload that function and perform additional initialization steps

Note: Called by SetRenderer(); Initialization occurs before the MRMLDisplayableNode is set and observed

Warning: That function should NOT be used directly !

See also: SetRenderer

Reimplemented from vtkMRMLAbstractDisplayableManager.

◆ Create()

void vtkMRMLViewDisplayableManager::Create ( )

overrideprotectedvirtual

Observe the View node and initialize the renderer accordingly.

Reimplemented from vtkMRMLAbstractDisplayableManager.

◆ GetClassName()

virtual const char* vtkMRMLViewDisplayableManager::GetClassName ( )

virtual

Reimplemented from vtkMRMLAbstractThreeDViewDisplayableManager.

◆ IsA()

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

virtual

Reimplemented from vtkMRMLAbstractThreeDViewDisplayableManager.

◆ IsTypeOf()

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

static

◆ New()

static vtkMRMLViewDisplayableManager* vtkMRMLViewDisplayableManager::New ( )

static

◆ OnMRMLDisplayableNodeModifiedEvent()

void vtkMRMLViewDisplayableManager::OnMRMLDisplayableNodeModifiedEvent ( vtkObject * caller )

overrideprotectedvirtual

Called each time the view node is modified. Internally update the renderer from the view node.

See also: UpdateFromMRMLViewNode()

Reimplemented from vtkMRMLAbstractThreeDViewDisplayableManager.

◆ PrintSelf()

void vtkMRMLViewDisplayableManager::PrintSelf	(	ostream &	os,
		vtkIndent	indent
	)

override

◆ ProcessMRMLNodesEvents()

void vtkMRMLViewDisplayableManager::ProcessMRMLNodesEvents	(	vtkObject *	caller,
		unsigned long	event,
		void *	callData
	)

overrideprotectedvirtual

Receives events from the view and the camera nodes.

Reimplemented from vtkMRMLAbstractDisplayableManager.

◆ ProcessWidgetsEvents()

void vtkMRMLViewDisplayableManager::ProcessWidgetsEvents	(	vtkObject *	caller,
		unsigned long	event,
		void *	callData
	)

overrideprotectedvirtual

Receives all the events fired by any graphical object interacted by the user (typically vtk widgets). A typical use case is to listen to mrml nodes (using GetMRMLNodesCallbackCommand()) and update the graphical objects like mappers, actors, widgets... in ProcessMRMLNodesEvent, and to listen to user interactions (using (using GetWidgetsCallbackCommand()) like widgets and update the mrml nodes in ProcessWidgetsEvents. To listen to a widget (or any vtk Object), you can add an observer using GetWidgetsCallbackCommand(). ProcessWidgetsEvents doesn't do anything by default, you need to reimplement it.

Reimplemented from vtkMRMLAbstractDisplayableManager.

◆ SafeDownCast()

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

static

◆ SetAndObserveCameraNode()

void vtkMRMLViewDisplayableManager::SetAndObserveCameraNode ( vtkMRMLCameraNode * cameraNodeToObserve )

protected

Set, Observe and Update from the camera node.

See also: UpdateFromMRMLCameraNode()

◆ UpdateFromCameraNode()

void vtkMRMLViewDisplayableManager::UpdateFromCameraNode ( )

protected

Each time the camera is modified, the closest label to the camera is hidden.

See also: SetAndObserveFromMRMLCameraNode, UpdateFromViewNode()

◆ UpdateFromViewNode()

void vtkMRMLViewDisplayableManager::UpdateFromViewNode ( )

protected

Update the renderer from the view node properties.

See also: UpdateFromCameraNode

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

Libs/MRML/DisplayableManager/vtkMRMLViewDisplayableManager.h

Public Types

Public Member Functions

Static Public Member Functions

Protected Member Functions

Additional Inherited Members

Detailed Description

Member Typedef Documentation

◆ Superclass

Constructor & Destructor Documentation

◆ vtkMRMLViewDisplayableManager()

◆ ~vtkMRMLViewDisplayableManager()

Member Function Documentation

◆ AdditionalInitializeStep()

◆ Create()

◆ GetClassName()

◆ IsA()

◆ IsTypeOf()

◆ New()

◆ OnMRMLDisplayableNodeModifiedEvent()

◆ PrintSelf()

◆ ProcessMRMLNodesEvents()

◆ ProcessWidgetsEvents()

◆ SafeDownCast()

◆ SetAndObserveCameraNode()

◆ UpdateFromCameraNode()

◆ UpdateFromViewNode()