Displayable manager for showing segmentations in slice (2D) views. More...

#include <Modules/Loadable/Segmentations/MRMLDM/vtkMRMLSegmentationsDisplayableManager2D.h>

Inheritance diagram for vtkMRMLSegmentationsDisplayableManager2D:

[legend]

Collaboration diagram for vtkMRMLSegmentationsDisplayableManager2D:

[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
int	AddCustomSegmentRenderer (const std::string &segmentationDisplayNodeID, const std::string &segmentID)

virtual const char *	GetClassName ()

std::string	GetCustomSegmentRendererSegmentationDisplayNodeID (int index)

std::string	GetCustomSegmentRendererSegmentID (int index)

int	GetCustomSegmentRendererTag (const std::string &segmentationDisplayNodeID, const std::string &segmentID)

int	GetCustomSegmentRendererTag (int index)

std::string	GetDataProbeInfoStringForPosition (double xyz[3]) override

int	GetNumberOfCustomSegmentsRenderers ()
	Get information on custom segment renderers. Intended for troubleshooting.

virtual void	GetVisibleSegmentsForPosition (double ras[3], vtkMRMLSegmentationDisplayNode displayNode, vtkStringArray segmentIDs, vtkDoubleArray *segmentValues=nullptr)

bool	HasCustomSegmentRenderer (const std::string &segmentationDisplayNodeID, const std::string &segmentID)

virtual int	IsA (const char *type)

void	PrintSelf (ostream &os, vtkIndent indent) override

bool	RemoveCustomSegmentRenderer (int tag)

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

vtkMRMLSliceNode *	GetMRMLSliceNode ()
	Get MRML SliceNode.

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

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 vtkMRMLSegmentationsDisplayableManager2D *	New ()

static vtkMRMLSegmentationsDisplayableManager2D *	SafeDownCast (vtkObject *o)

Static Public Member Functions inherited from vtkMRMLAbstractSliceViewDisplayableManager
static void	ConvertDeviceToXYZ (vtkRenderer renderer, vtkMRMLSliceNode sliceNode, double x, double y, double xyz[3])

static void	ConvertDeviceToXYZ (vtkRenderWindowInteractor interactor, 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 vtkMRMLAbstractSliceViewDisplayableManager *	New ()

static vtkMRMLAbstractSliceViewDisplayableManager *	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
	Initialize the displayable manager based on its associated vtkMRMLSliceNode.

void	OnMRMLSceneEndBatchProcess () override

void	OnMRMLSceneEndClose () override

void	OnMRMLSceneNodeAdded (vtkMRMLNode *node) override

void	OnMRMLSceneNodeRemoved (vtkMRMLNode *node) override

void	OnMRMLSceneStartClose () override

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

void	UnobserveMRMLScene () override

void	UpdateFromMRML () override
	Update Actors based on transforms in the scene.

	vtkMRMLSegmentationsDisplayableManager2D ()

	~vtkMRMLSegmentationsDisplayableManager2D () override

Protected Member Functions inherited from vtkMRMLAbstractSliceViewDisplayableManager
void	OnMRMLDisplayableNodeModifiedEvent (vtkObject *caller) override

virtual void	OnMRMLSliceNodeModifiedEvent ()
	Could be overloaded if DisplayableManager subclass.

	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)

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

void	RequestRender ()

void	SetAndObserveMRMLDisplayableNode (vtkMRMLNode *newMRMLDisplayableNode)

virtual void	SetMRMLDisplayableManagerGroup (vtkMRMLDisplayableManagerGroup *group)

void	SetMRMLSceneInternal (vtkMRMLScene *newScene) override

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

virtual void	OnMRMLSceneEndRestore ()

virtual void	OnMRMLSceneNew ()

virtual void	OnMRMLSceneStartBatchProcess ()

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

	vtkMRMLAbstractLogic ()

	~vtkMRMLAbstractLogic () override

Friends
class	vtkInternal

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

Displayable manager for showing segmentations in slice (2D) views.

Displays segmentations in slice viewers as labelmaps or contour lines

Definition at line 37 of file vtkMRMLSegmentationsDisplayableManager2D.h.

Member Typedef Documentation

◆ Superclass

typedef vtkMRMLAbstractSliceViewDisplayableManager vtkMRMLSegmentationsDisplayableManager2D::Superclass

Definition at line 43 of file vtkMRMLSegmentationsDisplayableManager2D.h.

Constructor & Destructor Documentation

◆ vtkMRMLSegmentationsDisplayableManager2D()

vtkMRMLSegmentationsDisplayableManager2D::vtkMRMLSegmentationsDisplayableManager2D ( )

protected

◆ ~vtkMRMLSegmentationsDisplayableManager2D()

vtkMRMLSegmentationsDisplayableManager2D::~vtkMRMLSegmentationsDisplayableManager2D ( )

overrideprotected

Member Function Documentation

◆ AddCustomSegmentRenderer()

int vtkMRMLSegmentationsDisplayableManager2D::AddCustomSegmentRenderer	(	const std::string &	segmentationDisplayNodeID,
		const std::string &	segmentID )

Specify that a segment is temporarily displayed with a custom renderer, so that this displayable manager should not display it. Only one custom renderer can be added for a specific segment for each segmentation display node.

Returns: An integer tag that can be used for removing the custom renderer using RemoveCustomRenderer(). If the returned tag value is 0 it means that this segment for this display node has already a custom renderer and no additional custom renderer is registered.

◆ Create()

void vtkMRMLSegmentationsDisplayableManager2D::Create ( )

overrideprotectedvirtual

Initialize the displayable manager based on its associated vtkMRMLSliceNode.

Reimplemented from vtkMRMLAbstractDisplayableManager.

◆ GetClassName()

virtual const char * vtkMRMLSegmentationsDisplayableManager2D::GetClassName ( )

virtual

Reimplemented from vtkMRMLAbstractSliceViewDisplayableManager.

◆ GetCustomSegmentRendererSegmentationDisplayNodeID()

std::string vtkMRMLSegmentationsDisplayableManager2D::GetCustomSegmentRendererSegmentationDisplayNodeID ( int index )

◆ GetCustomSegmentRendererSegmentID()

std::string vtkMRMLSegmentationsDisplayableManager2D::GetCustomSegmentRendererSegmentID ( int index )

◆ GetCustomSegmentRendererTag() [1/2]

int vtkMRMLSegmentationsDisplayableManager2D::GetCustomSegmentRendererTag	(	const std::string &	segmentationDisplayNodeID,
		const std::string &	segmentID )

◆ GetCustomSegmentRendererTag() [2/2]

int vtkMRMLSegmentationsDisplayableManager2D::GetCustomSegmentRendererTag ( int index )

◆ GetDataProbeInfoStringForPosition()

std::string vtkMRMLSegmentationsDisplayableManager2D::GetDataProbeInfoStringForPosition ( double xyz[3] )

override

Assemble and return info string to display in Data probe for a given viewer XYZ position.

Returns: Invalid string by default, meaning no information to display.

◆ GetNumberOfCustomSegmentsRenderers()

int vtkMRMLSegmentationsDisplayableManager2D::GetNumberOfCustomSegmentsRenderers ( )

Get information on custom segment renderers. Intended for troubleshooting.

◆ GetVisibleSegmentsForPosition()

virtual void vtkMRMLSegmentationsDisplayableManager2D::GetVisibleSegmentsForPosition	(	double	ras[3],
		vtkMRMLSegmentationDisplayNode *	displayNode,
		vtkStringArray *	segmentIDs,
		vtkDoubleArray *	segmentValues = nullptr )

virtual

Get list of segments visible at selected display position. segmentValues is optional, if not nullptr then it returns value for each segment for fractional representations

◆ HasCustomSegmentRenderer()

bool vtkMRMLSegmentationsDisplayableManager2D::HasCustomSegmentRenderer	(	const std::string &	segmentationDisplayNodeID,
		const std::string &	segmentID )

◆ IsA()

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

virtual

Reimplemented from vtkMRMLAbstractSliceViewDisplayableManager.

◆ IsTypeOf()

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

static

◆ New()

static vtkMRMLSegmentationsDisplayableManager2D * vtkMRMLSegmentationsDisplayableManager2D::New ( )

static

◆ OnMRMLSceneEndBatchProcess()

void vtkMRMLSegmentationsDisplayableManager2D::OnMRMLSceneEndBatchProcess ( )

overrideprotectedvirtual

If vtkMRMLScene::EndBatchProcessEvent has been set to be observed in SetMRMLSceneInternal, it is called when the scene fires the event Internally calls UpdateFromMRMLScene. Can be reimplemented to change the default behavior.

See also: ProcessMRMLSceneEvents, SetMRMLSceneInternal; OnMRMLSceneStartBatchProcess

Reimplemented from vtkMRMLAbstractLogic.

◆ OnMRMLSceneEndClose()

void vtkMRMLSegmentationsDisplayableManager2D::OnMRMLSceneEndClose ( )

overrideprotectedvirtual

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

See also: ProcessMRMLSceneEvents, SetMRMLSceneInternal; OnMRMLSceneStartClose

Reimplemented from vtkMRMLAbstractLogic.

◆ OnMRMLSceneNodeAdded()

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

◆ OnMRMLSceneStartClose()

void vtkMRMLSegmentationsDisplayableManager2D::OnMRMLSceneStartClose ( )

overrideprotectedvirtual

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

See also: ProcessMRMLSceneEvents, SetMRMLSceneInternal; OnMRMLSceneEndClose

Reimplemented from vtkMRMLAbstractLogic.

◆ PrintSelf()

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

override

◆ ProcessMRMLNodesEvents()

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

◆ RemoveCustomSegmentRenderer()

bool vtkMRMLSegmentationsDisplayableManager2D::RemoveCustomSegmentRenderer ( int tag )

Remove custom renderer that was added using AddCustomSegmentRenderer()

Returns: true if there was a custom renderer with the specified tag.

◆ SafeDownCast()

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

static

◆ UnobserveMRMLScene()

void vtkMRMLSegmentationsDisplayableManager2D::UnobserveMRMLScene ( )

overrideprotectedvirtual

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 vtkMRMLSegmentationsDisplayableManager2D::UpdateFromMRML ( )

overrideprotectedvirtual

Update Actors based on transforms in the scene.

Reimplemented from vtkMRMLAbstractDisplayableManager.

Friends And Related Symbol Documentation

◆ vtkInternal

friend class vtkInternal

friend

Definition at line 109 of file vtkMRMLSegmentationsDisplayableManager2D.h.

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

Modules/Loadable/Segmentations/MRMLDM/vtkMRMLSegmentationsDisplayableManager2D.h

Public Types

Public Member Functions

Static Public Member Functions

Protected Member Functions

Friends

Additional Inherited Members

Detailed Description

Member Typedef Documentation

◆ Superclass

Constructor & Destructor Documentation

◆ vtkMRMLSegmentationsDisplayableManager2D()

◆ ~vtkMRMLSegmentationsDisplayableManager2D()

Member Function Documentation

◆ AddCustomSegmentRenderer()

◆ Create()

◆ GetClassName()

◆ GetCustomSegmentRendererSegmentationDisplayNodeID()

◆ GetCustomSegmentRendererSegmentID()

◆ GetCustomSegmentRendererTag() [1/2]

◆ GetCustomSegmentRendererTag() [2/2]

◆ GetDataProbeInfoStringForPosition()

◆ GetNumberOfCustomSegmentsRenderers()

◆ GetVisibleSegmentsForPosition()

◆ HasCustomSegmentRenderer()

◆ IsA()

◆ IsTypeOf()

◆ New()

◆ OnMRMLSceneEndBatchProcess()

◆ OnMRMLSceneEndClose()

◆ OnMRMLSceneNodeAdded()

◆ OnMRMLSceneNodeRemoved()

◆ OnMRMLSceneStartClose()

◆ PrintSelf()

◆ ProcessMRMLNodesEvents()

◆ RemoveCustomSegmentRenderer()

◆ SafeDownCast()

◆ UnobserveMRMLScene()

◆ UpdateFromMRML()

Friends And Related Symbol Documentation

◆ vtkInternal