Slicer logic class for view manipulation. More...

#include <Libs/MRML/Logic/vtkMRMLViewLogic.h>

Inheritance diagram for vtkMRMLViewLogic:

Collaboration diagram for vtkMRMLViewLogic:

[legend]

Public Types
typedef vtkMRMLAbstractLogic	Superclass

Public Types inherited from vtkMRMLAbstractLogic
typedef vtkObject	Superclass

typedef void(vtkMRMLAbstractLogic::*	TaskFunctionPointer) (void *clientdata)

Public Member Functions
vtkMRMLViewNode *	AddViewNode (const char *layoutName)
	Convenience function for adding a view node and setting it in this logic. More...

void	EndCameraNodeInteraction ()
	Indicate an interaction with the slice node has been completed. More...

void	EndViewNodeInteraction ()
	Indicate an interaction with the view node has been completed. More...

virtual vtkMRMLCameraNode *	GetCameraNode ()
	The MRML camera node for this View logic. More...

virtual const char *	GetClassName ()

virtual const char *	GetName () const

virtual vtkMRMLViewNode *	GetViewNode ()
	The MRML View node for this View logic. More...

virtual int	IsA (const char *type)

void	PrintSelf (ostream &os, vtkIndent indent) override

virtual void	SetName (const char *name)
	Set/Get layout name. This is used for finding the camera and view node in the scene. More...

void	StartCameraNodeInteraction (unsigned int parameters)

void	StartViewNodeInteraction (unsigned int parameters)

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 vtkMRMLCameraNode *	GetCameraNode (vtkMRMLScene scene, const char layoutName)

static vtkMRMLViewNode *	GetViewNode (vtkMRMLScene scene, const char layoutName)

static int	IsTypeOf (const char *type)

static vtkMRMLViewLogic *	New ()
	The Usual VTK class functions. More...

static vtkMRMLViewLogic *	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	OnMRMLSceneNodeAdded (vtkMRMLNode *node) override

void	OnMRMLSceneNodeRemoved (vtkMRMLNode *node) override

void	SetCameraNode (vtkMRMLCameraNode *newCameraNode)

void	SetMRMLSceneInternal (vtkMRMLScene *newScene) override

void	SetViewNode (vtkMRMLViewNode *newViewNode)

void	UpdateFromMRMLScene () override

void	UpdateMRMLNodes ()

	vtkMRMLViewLogic ()

	~vtkMRMLViewLogic () 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	OnMRMLSceneStartBatchProcess ()

virtual void	OnMRMLSceneStartClose ()

virtual void	OnMRMLSceneStartImport ()

virtual void	OnMRMLSceneStartRestore ()

virtual void	ProcessMRMLLogicsEvents (vtkObject caller, unsigned long event, void callData)

virtual void	ProcessMRMLNodesEvents (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 ()

	vtkMRMLAbstractLogic ()

	~vtkMRMLAbstractLogic () override

Protected Attributes
vtkMRMLCameraNode *	CameraNode

std::string	Name

bool	UpdatingMRMLNodes

vtkMRMLViewNode *	ViewNode

Additional Inherited Members
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

Slicer logic class for view manipulation.

This class manages the logic associated with display of view windows (but not the GUI). Features of the class include: – manage the linking of the 3D View linking.

Definition at line 55 of file vtkMRMLViewLogic.h.

Member Typedef Documentation

◆ Superclass

typedef vtkMRMLAbstractLogic vtkMRMLViewLogic::Superclass

Definition at line 60 of file vtkMRMLViewLogic.h.

Constructor & Destructor Documentation

◆ vtkMRMLViewLogic()

vtkMRMLViewLogic::vtkMRMLViewLogic ( )

protected

◆ ~vtkMRMLViewLogic()

vtkMRMLViewLogic::~vtkMRMLViewLogic ( )

overrideprotected

Member Function Documentation

◆ AddViewNode()

vtkMRMLViewNode* vtkMRMLViewLogic::AddViewNode ( const char * layoutName )

Convenience function for adding a view node and setting it in this logic.

◆ EndCameraNodeInteraction()

void vtkMRMLViewLogic::EndCameraNodeInteraction ( )

Indicate an interaction with the slice node has been completed.

◆ EndViewNodeInteraction()

void vtkMRMLViewLogic::EndViewNodeInteraction ( )

Indicate an interaction with the view node has been completed.

◆ GetCameraNode() [1/2]

virtual vtkMRMLCameraNode* vtkMRMLViewLogic::GetCameraNode ( )

virtual

The MRML camera node for this View logic.

◆ GetCameraNode() [2/2]

static vtkMRMLCameraNode* vtkMRMLViewLogic::GetCameraNode	(	vtkMRMLScene *	scene,
		const char *	layoutName
	)

static

Convenient method to get the camera node from scene and name of the Logic. The name of the Logic is the same of the widget one to which it is associated

◆ GetClassName()

virtual const char* vtkMRMLViewLogic::GetClassName ( )

virtual

Reimplemented from vtkMRMLAbstractLogic.

◆ GetName()

virtual const char* vtkMRMLViewLogic::GetName ( ) const

virtual

◆ GetViewNode() [1/2]

virtual vtkMRMLViewNode* vtkMRMLViewLogic::GetViewNode ( )

virtual

The MRML View node for this View logic.

◆ GetViewNode() [2/2]

static vtkMRMLViewNode* vtkMRMLViewLogic::GetViewNode	(	vtkMRMLScene *	scene,
		const char *	layoutName
	)

static

Convenient method to get the view node from scene and name of the Logic. The name of the Logic is the same of the widget one to which it is associated

◆ IsA()

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

virtual

Reimplemented from vtkMRMLAbstractLogic.

◆ IsTypeOf()

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

static

◆ New()

static vtkMRMLViewLogic* vtkMRMLViewLogic::New ( )

static

The Usual VTK class functions.

◆ OnMRMLSceneNodeAdded()

void vtkMRMLViewLogic::OnMRMLSceneNodeAdded ( vtkMRMLNode * )

overrideprotectedvirtual

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 vtkMRMLViewLogic::OnMRMLSceneNodeRemoved ( vtkMRMLNode * )

overrideprotectedvirtual

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 vtkMRMLViewLogic::PrintSelf	(	ostream &	os,
		vtkIndent	indent
	)

override

◆ SafeDownCast()

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

static

◆ SetCameraNode()

void vtkMRMLViewLogic::SetCameraNode ( vtkMRMLCameraNode * newCameraNode )

protected

◆ SetMRMLSceneInternal()

void vtkMRMLViewLogic::SetMRMLSceneInternal ( vtkMRMLScene * newScene )

overrideprotectedvirtual

Called each time a new scene is set. Can be reimplemented in derivated classes. Doesn't observe the scene by default, that means that UpdateFromMRMLScene() won't be called by default when a scene is imported, closed or restored, only when a new scene is set.

See also: SetAndObserveMRMLSceneInternal() SetAndObserveMRMLSceneEventsInternal(); UpdateFromMRMLScene()

Reimplemented from vtkMRMLAbstractLogic.

◆ SetName()

virtual void vtkMRMLViewLogic::SetName ( const char * name )

virtual

Set/Get layout name. This is used for finding the camera and view node in the scene.

◆ SetViewNode()

void vtkMRMLViewLogic::SetViewNode ( vtkMRMLViewNode * newViewNode )

protected

◆ StartCameraNodeInteraction()

void vtkMRMLViewLogic::StartCameraNodeInteraction ( unsigned int parameters )

Indicate an interaction with the camera node is beginning. The parameters of the camera node being manipulated are passed as a bitmask. See vtkMRMLViewNode::InteractionFlagType.

◆ StartViewNodeInteraction()

void vtkMRMLViewLogic::StartViewNodeInteraction ( unsigned int parameters )

Indicate an interaction with the view node is beginning. The parameters of the view node being manipulated are passed as a bitmask. See vtkMRMLViewNode::InteractionFlagType.

◆ UpdateFromMRMLScene()

void vtkMRMLViewLogic::UpdateFromMRMLScene ( )

overrideprotectedvirtual

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.

◆ UpdateMRMLNodes()

void vtkMRMLViewLogic::UpdateMRMLNodes ( )

protected

Member Data Documentation

◆ CameraNode

vtkMRMLCameraNode* vtkMRMLViewLogic::CameraNode

protected

Definition at line 120 of file vtkMRMLViewLogic.h.

◆ Name

std::string vtkMRMLViewLogic::Name

protected

Definition at line 117 of file vtkMRMLViewLogic.h.

◆ UpdatingMRMLNodes

bool vtkMRMLViewLogic::UpdatingMRMLNodes

protected

Definition at line 121 of file vtkMRMLViewLogic.h.

◆ ViewNode

vtkMRMLViewNode* vtkMRMLViewLogic::ViewNode

protected

Definition at line 119 of file vtkMRMLViewLogic.h.

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

Libs/MRML/Logic/vtkMRMLViewLogic.h

Public Types

Public Member Functions

Static Public Member Functions

Protected Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Member Typedef Documentation

◆ Superclass

Constructor & Destructor Documentation

◆ vtkMRMLViewLogic()

◆ ~vtkMRMLViewLogic()

Member Function Documentation

◆ AddViewNode()

◆ EndCameraNodeInteraction()

◆ EndViewNodeInteraction()

◆ GetCameraNode() [1/2]

◆ GetCameraNode() [2/2]

◆ GetClassName()

◆ GetName()

◆ GetViewNode() [1/2]

◆ GetViewNode() [2/2]

◆ IsA()

◆ IsTypeOf()

◆ New()

◆ OnMRMLSceneNodeAdded()

◆ OnMRMLSceneNodeRemoved()

◆ PrintSelf()

◆ SafeDownCast()

◆ SetCameraNode()

◆ SetMRMLSceneInternal()

◆ SetName()

◆ SetViewNode()

◆ StartCameraNodeInteraction()

◆ StartViewNodeInteraction()

◆ UpdateFromMRMLScene()

◆ UpdateMRMLNodes()

Member Data Documentation

◆ CameraNode

◆ Name

◆ UpdatingMRMLNodes

◆ ViewNode