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

Inheritance diagram for vtkMRMLScriptedDisplayableManager:

[legend]

Collaboration diagram for vtkMRMLScriptedDisplayableManager:

[legend]

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

void	SetPythonSource (const std::string &filePath)

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

vtkMRMLInteractionNode *	GetInteractionNode ()
	Convenient method to get the current InteractionNode.

virtual bool	GetInteractive ()
	Displayable manager can indicate that the window is in interactive mode (faster updates).

vtkRenderWindowInteractor *	GetInteractor ()
	Convenient method to get the WindowInteractor associated with the Renderer.

virtual vtkMRMLLightBoxRendererManagerProxy *	GetLightBoxRendererManagerProxy ()

virtual int	GetMouseCursor ()
	Displayable manager returns ID of the mouse cursor shape that should be displayed.

vtkRenderer *	GetRenderer ()
	Get the default renderer for this displayable manager.

vtkRenderer *	GetRenderer (int idx)

vtkMRMLSelectionNode *	GetSelectionNode ()
	Convenient method to get the current SelectionNode.

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

virtual void	SetLightBoxRendererManagerProxy (vtkMRMLLightBoxRendererManagerProxy *)

void	SetMouseCursor (int cursor)

Public Member Functions inherited from vtkMRMLAbstractLogic
virtual vtkMRMLApplicationLogic *	GetMRMLApplicationLogic () const
	Get access to overall application state.

vtkMRMLScene *	GetMRMLScene () const
	Return a reference to the current MRML scene.

void	PrintSelf (ostream &os, vtkIndent indent) override

virtual void	SetMRMLApplicationLogic (vtkMRMLApplicationLogic *logic)

void	SetMRMLScene (vtkMRMLScene *newScene)
	Set and observe the MRMLScene.

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

static vtkMRMLScriptedDisplayableManager *	New ()

static vtkMRMLScriptedDisplayableManager *	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	Create () override

void	OnInteractorStyleEvent (int eventid) override

void	OnMRMLDisplayableNodeModifiedEvent (vtkObject *caller) override

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

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

void	RemoveMRMLObservers () override
	Remove MRML observers.

void	SetMRMLSceneInternal (vtkMRMLScene *newScene) override

void	UpdateFromMRML () override

	vtkMRMLScriptedDisplayableManager ()

	~vtkMRMLScriptedDisplayableManager () 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.

void	CreateIfPossible ()

vtkMRMLDisplayableManagerGroup *	GetMRMLDisplayableManagerGroup ()
	Get associated DisplayableManager group.

vtkMRMLNode *	GetMRMLDisplayableNode ()
	Get MRML Displayable Node.

vtkCallbackCommand *	GetWidgetsCallbackCommand ()
	Get vtkWidget callbackCommand.

vtkObserverManager *	GetWidgetsObserverManager () const
	Get widget observerManager.

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)

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

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.

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

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.

static void	MRMLNodesCallback (vtkObject caller, unsigned long eid, void clientData, void *callData)
	MRMLNodesCallback is a static function to relay modified events from the nodes.

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

typedef vtkMRMLAbstractDisplayableManager vtkMRMLScriptedDisplayableManager::Superclass

Definition at line 35 of file vtkMRMLScriptedDisplayableManager.h.

Constructor & Destructor Documentation

◆ vtkMRMLScriptedDisplayableManager()

vtkMRMLScriptedDisplayableManager::vtkMRMLScriptedDisplayableManager ( )

protected

◆ ~vtkMRMLScriptedDisplayableManager()

vtkMRMLScriptedDisplayableManager::~vtkMRMLScriptedDisplayableManager ( )

overrideprotected

Member Function Documentation

◆ Create()

void vtkMRMLScriptedDisplayableManager::Create ( )

overrideprotectedvirtual

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.

Note: GetRenderer() and GetMRMLDisplayableNode() will return valid object

Reimplemented from vtkMRMLAbstractDisplayableManager.

◆ GetClassName()

virtual const char * vtkMRMLScriptedDisplayableManager::GetClassName ( )

virtual

Reimplemented from vtkMRMLAbstractDisplayableManager.

◆ IsA()

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

virtual

Reimplemented from vtkMRMLAbstractDisplayableManager.

◆ IsTypeOf()

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

static

◆ New()

static vtkMRMLScriptedDisplayableManager * vtkMRMLScriptedDisplayableManager::New ( )

static

◆ OnInteractorStyleEvent()

void vtkMRMLScriptedDisplayableManager::OnInteractorStyleEvent ( int eventid )

overrideprotectedvirtual

Called after interactor style event specified using AddInteractorStyleObservableEvent are invoked.

Note

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

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

◆ PrintSelf()

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

override

◆ ProcessMRMLNodesEvents()

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

overrideprotectedvirtual

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

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

overrideprotectedvirtual

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

Reimplemented from vtkMRMLAbstractLogic.

◆ RemoveMRMLObservers()

void vtkMRMLScriptedDisplayableManager::RemoveMRMLObservers ( )

overrideprotectedvirtual

Remove MRML observers.

Reimplemented from vtkMRMLAbstractDisplayableManager.

◆ SafeDownCast()

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

static

◆ SetMRMLSceneInternal()

void vtkMRMLScriptedDisplayableManager::SetMRMLSceneInternal ( vtkMRMLScene * newScene )

overrideprotectedvirtual

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 & filePath )

◆ UpdateFromMRML()

void vtkMRMLScriptedDisplayableManager::UpdateFromMRML ( )

overrideprotectedvirtual

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:

Libs/MRML/DisplayableManager/vtkMRMLScriptedDisplayableManager.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

◆ vtkMRMLScriptedDisplayableManager()

◆ ~vtkMRMLScriptedDisplayableManager()

Member Function Documentation

◆ Create()

◆ GetClassName()

◆ IsA()

◆ IsTypeOf()

◆ New()

◆ OnInteractorStyleEvent()

◆ OnMRMLDisplayableNodeModifiedEvent()

◆ PrintSelf()

◆ ProcessMRMLNodesEvents()

◆ ProcessMRMLSceneEvents()

◆ RemoveMRMLObservers()

◆ SafeDownCast()

◆ SetMRMLSceneInternal()

◆ SetPythonSource()

◆ UpdateFromMRML()