Displayable manager that displays orientation marker in a slice or 3D view. More...

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

Inheritance diagram for vtkMRMLRulerDisplayableManager:

[legend]

Collaboration diagram for vtkMRMLRulerDisplayableManager:

[legend]

Classes
struct	RulerScalePreset

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
void	AddRulerScalePreset (double length, int numberOfMajorDivisons, int numberOfMinorDivisions, const std::string &displayedUnitName, double displayedScale)

virtual const char *	GetClassName ()

virtual int	IsA (const char *type)

void	PrintSelf (ostream &os, vtkIndent indent) override

void	RemoveAllRulerScalePresets ()
	Remove all scale presets.

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

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

static vtkMRMLRulerDisplayableManager *	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
	Observe the View node and initialize the renderer accordingly.

void	OnMRMLDisplayableNodeModifiedEvent (vtkObject *caller) override

void	UpdateFromRenderer ()
	Update the renderer based on the master renderer (the one that the orientation marker follows)

void	UpdateFromViewNode ()
	Update the renderer from the view node properties.

	vtkMRMLRulerDisplayableManager ()

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

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

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)

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.

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

Protected Attributes
std::vector< RulerScalePreset >	RulerScalePresets

Friends
class	vtkRulerRendererUpdateObserver

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 that displays orientation marker in a slice or 3D view.

Definition at line 31 of file vtkMRMLRulerDisplayableManager.h.

Member Typedef Documentation

◆ Superclass

typedef vtkMRMLAbstractDisplayableManager vtkMRMLRulerDisplayableManager::Superclass

Definition at line 37 of file vtkMRMLRulerDisplayableManager.h.

Constructor & Destructor Documentation

◆ vtkMRMLRulerDisplayableManager()

vtkMRMLRulerDisplayableManager::vtkMRMLRulerDisplayableManager ( )

protected

◆ ~vtkMRMLRulerDisplayableManager()

vtkMRMLRulerDisplayableManager::~vtkMRMLRulerDisplayableManager ( )

overrideprotected

Member Function Documentation

◆ AddRulerScalePreset()

void vtkMRMLRulerDisplayableManager::AddRulerScalePreset	(	double	length,
		int	numberOfMajorDivisons,
		int	numberOfMinorDivisions,
		const std::string &	displayedUnitName,
		double	displayedScale )

Adds a scale preset to the list of possible scales. Length: The preset with Length closest to the actual length of the ruler will be used. If a preset exists with the same length then it will be updated with the new parameters. Number of major divisions: how many parts the ruler will be divided to by major ticks. Number of minor divisions: how many parts one division will be divided to by minor ticks. Displayed unit name: unit name displayed in the label. Displayed scale: 1 [actual unit] = displayedScale [displayed unit] (e.g., 1 mm = 0.1 cm) Example: (world coordinate is mm) 1.0 length, 5 major, 2 minor, mm, 1.0 scale 5.0 5 1 mm 1.0 10.0 5 2 cm 0.1

◆ Create()

void vtkMRMLRulerDisplayableManager::Create ( )

overrideprotectedvirtual

Observe the View node and initialize the renderer accordingly.

Reimplemented from vtkMRMLAbstractDisplayableManager.

◆ GetClassName()

virtual const char * vtkMRMLRulerDisplayableManager::GetClassName ( )

virtual

Reimplemented from vtkMRMLAbstractDisplayableManager.

◆ IsA()

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

virtual

Reimplemented from vtkMRMLAbstractDisplayableManager.

◆ IsTypeOf()

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

static

◆ New()

static vtkMRMLRulerDisplayableManager * vtkMRMLRulerDisplayableManager::New ( )

static

◆ OnMRMLDisplayableNodeModifiedEvent()

void vtkMRMLRulerDisplayableManager::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 vtkMRMLAbstractDisplayableManager.

◆ PrintSelf()

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

override

◆ RemoveAllRulerScalePresets()

void vtkMRMLRulerDisplayableManager::RemoveAllRulerScalePresets ( )

Remove all scale presets.

◆ SafeDownCast()

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

static

◆ UpdateFromRenderer()

void vtkMRMLRulerDisplayableManager::UpdateFromRenderer ( )

protected

Update the renderer based on the master renderer (the one that the orientation marker follows)

◆ UpdateFromViewNode()

void vtkMRMLRulerDisplayableManager::UpdateFromViewNode ( )

protected

Update the renderer from the view node properties.

Friends And Related Symbol Documentation

◆ vtkRulerRendererUpdateObserver

friend class vtkRulerRendererUpdateObserver

friend

Definition at line 33 of file vtkMRMLRulerDisplayableManager.h.

Member Data Documentation

◆ RulerScalePresets

std::vector<RulerScalePreset> vtkMRMLRulerDisplayableManager::RulerScalePresets

protected

Definition at line 83 of file vtkMRMLRulerDisplayableManager.h.

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

Libs/MRML/DisplayableManager/vtkMRMLRulerDisplayableManager.h

Classes

Public Types

Public Member Functions

Static Public Member Functions

Protected Member Functions

Protected Attributes

Friends

Additional Inherited Members

Detailed Description

Member Typedef Documentation

◆ Superclass

Constructor & Destructor Documentation

◆ vtkMRMLRulerDisplayableManager()

◆ ~vtkMRMLRulerDisplayableManager()

Member Function Documentation

◆ AddRulerScalePreset()

◆ Create()

◆ GetClassName()

◆ IsA()

◆ IsTypeOf()

◆ New()

◆ OnMRMLDisplayableNodeModifiedEvent()

◆ PrintSelf()

◆ RemoveAllRulerScalePresets()

◆ SafeDownCast()

◆ UpdateFromRenderer()

◆ UpdateFromViewNode()

Friends And Related Symbol Documentation

◆ vtkRulerRendererUpdateObserver

Member Data Documentation

◆ RulerScalePresets