Slicer  5.1
Slicer is a multi-platform, free and open source software package for visualization and medical image computing
List of all members | Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions
vtkMRMLAnnotationRulerDisplayableManager Class Reference

#include <Modules/Loadable/Annotations/MRMLDM/vtkMRMLAnnotationRulerDisplayableManager.h>

Inheritance diagram for vtkMRMLAnnotationRulerDisplayableManager:
Inheritance graph
[legend]
Collaboration diagram for vtkMRMLAnnotationRulerDisplayableManager:
Collaboration graph
[legend]

Public Types

typedef vtkMRMLAnnotationDisplayableManager Superclass
 
- Public Types inherited from vtkMRMLAnnotationDisplayableManager
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 vtkMRMLAnnotationDisplayableManager
bool AddAnnotation (vtkMRMLAnnotationNode *node)
 
bool CanProcessInteractionEvent (vtkMRMLInteractionEventData *eventData, double &closestDistance2) override
 
bool GetDisplayCoordinatesChanged (double *displayCoordinates1, double *displayCoordinates2)
 Check if there are real changes between two sets of displayCoordinates. More...
 
void GetDisplayToWorldCoordinates (double x, double y, double *worldCoordinates)
 Convert display to world coordinates. More...
 
void GetDisplayToWorldCoordinates (double *displayCoordinates, double *worldCoordinates)
 
int GetLightboxIndex (vtkMRMLAnnotationNode *node, int controlPointIndex=0)
 
virtual double GetScaleFactor2D ()
 
vtkMRMLSliceNodeGetSliceNode ()
 Get the sliceNode, if registered. This would mean it is a 2D SliceView displayableManager. More...
 
bool GetWorldCoordinatesChanged (double *worldCoordinates1, double *worldCoordinates2)
 Check if there are real changes between two sets of worldCoordinates. More...
 
virtual void GetWorldToLocalCoordinates (vtkMRMLAnnotationNode *node, double *worldCoordinates, double *localCoordinates)
 Convert world coordinates to local using mrml parent transform. More...
 
virtual bool Is2DDisplayableManager ()
 
bool IsInLightboxMode ()
 
void PrintSelf (ostream &os, vtkIndent indent) override
 
bool ProcessInteractionEvent (vtkMRMLInteractionEventData *eventData) override
 
void RestrictDisplayCoordinatesToViewport (double *displayCoordinates)
 Check if the displayCoordinates are inside the viewport and if not, correct the displayCoordinates. More...
 
virtual void SetParentTransformToWidget (vtkMRMLAnnotationNode *vtkNotUsed(node), vtkAbstractWidget *vtkNotUsed(widget))
 Set mrml parent transform to widgets. More...
 
virtual void SetScaleFactor2D (double)
 Set/Get the 2d scale factor to divide 3D scale by to show 2D elements appropriately (usually set to 300) More...
 
- Public Member Functions inherited from vtkMRMLAbstractDisplayableManager
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...
 
vtkMRMLInteractionNodeGetInteractionNode ()
 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 vtkMRMLLightBoxRendererManagerProxyGetLightBoxRendererManagerProxy ()
 
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)
 
vtkMRMLSelectionNodeGetSelectionNode ()
 Convenient method to get the current SelectionNode. More...
 
bool IsCreated ()
 
void PrintSelf (ostream &os, vtkIndent indent) override
 
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 vtkMRMLApplicationLogicGetMRMLApplicationLogic () const
 Get access to overall application state. More...
 
vtkMRMLSceneGetMRMLScene () 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 vtkMRMLAnnotationRulerDisplayableManagerNew ()
 
static vtkMRMLAnnotationRulerDisplayableManagerSafeDownCast (vtkObject *o)
 
- Static Public Member Functions inherited from vtkMRMLAnnotationDisplayableManager
static int IsTypeOf (const char *type)
 
static vtkMRMLAnnotationDisplayableManagerNew ()
 
static vtkMRMLAnnotationDisplayableManagerSafeDownCast (vtkObject *o)
 
- Static Public Member Functions inherited from vtkMRMLAbstractDisplayableManager
static int IsTypeOf (const char *type)
 
static vtkMRMLAbstractDisplayableManagerNew ()
 
static vtkMRMLAbstractDisplayableManagerSafeDownCast (vtkObject *o)
 
- Static Public Member Functions inherited from vtkMRMLAbstractLogic
static int IsTypeOf (const char *type)
 
static vtkMRMLAbstractLogicNew ()
 
static vtkMRMLAbstractLogicSafeDownCast (vtkObject *o)
 

Protected Member Functions

double ApplyUnit (double lengthInMM)
 
vtkAbstractWidget * CreateWidget (vtkMRMLAnnotationNode *node) override
 Create a widget. More...
 
double GetDistance (const double *wc1, const double *wc2)
 
std::string GetLabelFormat (vtkMRMLAnnotationRulerNode *rulerNode)
 
void OnClickInRenderWindow (double x, double y, const char *associatedNodeID) override
 Callback for click in RenderWindow. More...
 
void OnMRMLSelectionNodeUnitModifiedEvent (vtkMRMLSelectionNode *selectionNode) override
 
void OnWidgetCreated (vtkAbstractWidget *widget, vtkMRMLAnnotationNode *node) override
 Gets called when widget was created. More...
 
void PropagateMRMLToWidget (vtkMRMLAnnotationNode *node, vtkAbstractWidget *widget) override
 Propagate properties of MRML node to widget. More...
 
void PropagateWidgetToMRML (vtkAbstractWidget *widget, vtkMRMLAnnotationNode *node) override
 Propagate properties of widget to MRML node. More...
 
void UpdatePosition (vtkAbstractWidget *widget, vtkMRMLNode *node) override
 
 vtkMRMLAnnotationRulerDisplayableManager ()
 
 ~vtkMRMLAnnotationRulerDisplayableManager () override=default
 
- Protected Member Functions inherited from vtkMRMLAnnotationDisplayableManager
void AddObserversToInteractionNode ()
 Observe the interaction node. More...
 
void AddObserversToSelectionNode ()
 
void Create () override
 
virtual int GetDisableInteractorStyleEventsProcessing ()
 Accessor for internal flag that disables interactor style event processing. More...
 
void GetDisplayToViewportCoordinates (double x, double y, double *viewportCoordinates)
 Convert display to viewport coordinates. More...
 
void GetDisplayToViewportCoordinates (double *displayCoordinates, double *viewportCoordinates)
 
vtkHandleWidget * GetSeed (int index)
 Return the placed seeds. More...
 
vtkAbstractWidget * GetWidget (vtkMRMLAnnotationNode *node)
 Get the widget of a node. More...
 
void GetWorldToDisplayCoordinates (double r, double a, double s, double *displayCoordinates)
 Convert display to world coordinates. More...
 
void GetWorldToDisplayCoordinates (double *worldCoordinates, double *displayCoordinates)
 
bool IsCorrectDisplayableManager ()
 Check if it is the right displayManager. More...
 
virtual bool IsManageable (vtkMRMLNode *node)
 
virtual bool IsManageable (const char *nodeClassName)
 
virtual bool IsWidgetDisplayable (vtkMRMLSliceNode *sliceNode, vtkMRMLAnnotationNode *node)
 Check, if the widget is displayable in the current slice geometry. More...
 
void OnClickInRenderWindowGetCoordinates ()
 
void OnInteractorStyleEvent (int eventid) override
 Respond to interactor style events. More...
 
virtual void OnMRMLAnnotationControlPointModifiedEvent (vtkMRMLNode *node)
 
virtual void OnMRMLAnnotationDisplayNodeModifiedEvent (vtkMRMLNode *node)
 
virtual void OnMRMLAnnotationNodeLockModifiedEvent (vtkMRMLNode *node)
 
virtual void OnMRMLAnnotationNodeModifiedEvent (vtkMRMLNode *node)
 Preset functions for certain events. More...
 
virtual void OnMRMLAnnotationNodeTransformModifiedEvent (vtkMRMLNode *node)
 
void OnMRMLDisplayableNodeModifiedEvent (vtkObject *caller) override
 Called after the corresponding MRML View container was modified. More...
 
void OnMRMLSceneEndClose () override
 
void OnMRMLSceneNodeAdded (vtkMRMLNode *node) override
 
void OnMRMLSceneNodeRemoved (vtkMRMLNode *node) override
 
virtual void OnMRMLSliceNodeModifiedEvent (vtkMRMLSliceNode *sliceNode)
 Handler for specific SliceView actions. More...
 
virtual void PlaceSeed (double x, double y)
 Place a seed for widgets. More...
 
void ProcessMRMLNodesEvents (vtkObject *caller, unsigned long event, void *callData) override
 
void RemoveMRMLObservers () override
 Remove MRML observers. More...
 
void RemoveObserversFromInteractionNode ()
 
void RemoveObserversFromSelectionNode ()
 
virtual void RequestRender ()
 wrap the superclass render request in a check for batch processing More...
 
void SetAndObserveNode (vtkMRMLAnnotationNode *annotationNode)
 Observe one node. More...
 
void SetAndObserveNodes ()
 Observe all associated nodes. More...
 
void SetMRMLSceneInternal (vtkMRMLScene *newScene) override
 
void UpdateFromMRML () override
 
void UpdateFromMRMLScene () override
 
virtual void UpdatePosition (vtkAbstractWidget *vtkNotUsed(widget), vtkMRMLNode *vtkNotUsed(node))
 Update just the position for the widget, implemented by subclasses. More...
 
 vtkMRMLAnnotationDisplayableManager ()
 
 ~vtkMRMLAnnotationDisplayableManager () 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. More...
 
void CreateIfPossible ()
 
int GetInteractorAbortFlag ()
 
int GetInteractorStyleAbortFlag ()
 
vtkMRMLDisplayableManagerGroupGetMRMLDisplayableManagerGroup ()
 Get associated DisplayableManager group. More...
 
vtkMRMLNodeGetMRMLDisplayableNode ()
 Get MRML Displayable Node. More...
 
vtkCallbackCommand * GetWidgetsCallbackCommand ()
 Get vtkWidget callbackCommand. More...
 
vtkObserverManagerGetWidgetsObserverManager () const
 Get widget observerManager. More...
 
void InteractorAbortFlagOff ()
 
void InteractorAbortFlagOn ()
 
void InteractorStyleAbortFlagOff ()
 
void InteractorStyleAbortFlagOn ()
 
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)
 
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)
 
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 ()
 
vtkObserverManagerGetMRMLLogicsObserverManager () const
 
vtkCallbackCommand * GetMRMLNodesCallbackCommand ()
 
vtkObserverManagerGetMRMLNodesObserverManager () const
 
vtkCallbackCommand * GetMRMLSceneCallbackCommand ()
 
vtkObserverManagerGetMRMLSceneObserverManager () 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 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 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
 

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)
 
- Protected Attributes inherited from vtkMRMLAnnotationDisplayableManager
vtkMRMLAnnotationDisplayableManagerHelperHelper
 
double LastClickWorldCoordinates [4]
 
vtkMRMLAnnotationClickCounterm_ClickCounter
 Counter for clicks in Render Window. More...
 
const char * m_Focus
 Focus of this displayableManager is set to a specific annotation type when inherited. More...
 
int m_Updating
 Disable processing when updating is in progress. More...
 

Detailed Description

Definition at line 32 of file vtkMRMLAnnotationRulerDisplayableManager.h.

Member Typedef Documentation

◆ Superclass

Definition at line 39 of file vtkMRMLAnnotationRulerDisplayableManager.h.

Constructor & Destructor Documentation

◆ vtkMRMLAnnotationRulerDisplayableManager()

vtkMRMLAnnotationRulerDisplayableManager::vtkMRMLAnnotationRulerDisplayableManager ( )
inlineprotected

Definition at line 44 of file vtkMRMLAnnotationRulerDisplayableManager.h.

◆ ~vtkMRMLAnnotationRulerDisplayableManager()

vtkMRMLAnnotationRulerDisplayableManager::~vtkMRMLAnnotationRulerDisplayableManager ( )
overrideprotecteddefault

Member Function Documentation

◆ ApplyUnit()

double vtkMRMLAnnotationRulerDisplayableManager::ApplyUnit ( double  lengthInMM)
protected

Apply the current unit to a length in mm.

See also
GetDistance()

◆ CreateWidget()

vtkAbstractWidget* vtkMRMLAnnotationRulerDisplayableManager::CreateWidget ( vtkMRMLAnnotationNode node)
overrideprotectedvirtual

Create a widget.

Reimplemented from vtkMRMLAnnotationDisplayableManager.

◆ GetClassName()

virtual const char* vtkMRMLAnnotationRulerDisplayableManager::GetClassName ( )
virtual

◆ GetDistance()

double vtkMRMLAnnotationRulerDisplayableManager::GetDistance ( const double *  wc1,
const double *  wc2 
)
protected

Compute the distance in mm between 2 world coordinates points

See also
ApplyUnit()

◆ GetLabelFormat()

std::string vtkMRMLAnnotationRulerDisplayableManager::GetLabelFormat ( vtkMRMLAnnotationRulerNode rulerNode)
protected

◆ IsA()

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

◆ IsTypeOf()

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

◆ New()

static vtkMRMLAnnotationRulerDisplayableManager* vtkMRMLAnnotationRulerDisplayableManager::New ( )
static

◆ OnClickInRenderWindow()

void vtkMRMLAnnotationRulerDisplayableManager::OnClickInRenderWindow ( double  x,
double  y,
const char *  associatedNodeID 
)
overrideprotectedvirtual

Callback for click in RenderWindow.

Reimplemented from vtkMRMLAnnotationDisplayableManager.

◆ OnMRMLSelectionNodeUnitModifiedEvent()

void vtkMRMLAnnotationRulerDisplayableManager::OnMRMLSelectionNodeUnitModifiedEvent ( vtkMRMLSelectionNode selectionNode)
overrideprotectedvirtual

When the unit has changed, modify the ruler nodes to refresh the label.

See also
AddObserversToSelectionNode(), RemoveObserversFromSelectionNode()

Reimplemented from vtkMRMLAnnotationDisplayableManager.

◆ OnWidgetCreated()

void vtkMRMLAnnotationRulerDisplayableManager::OnWidgetCreated ( vtkAbstractWidget *  widget,
vtkMRMLAnnotationNode node 
)
overrideprotectedvirtual

Gets called when widget was created.

Reimplemented from vtkMRMLAnnotationDisplayableManager.

◆ PrintSelf()

void vtkMRMLAnnotationRulerDisplayableManager::PrintSelf ( ostream &  os,
vtkIndent  indent 
)
override

◆ PropagateMRMLToWidget()

void vtkMRMLAnnotationRulerDisplayableManager::PropagateMRMLToWidget ( vtkMRMLAnnotationNode node,
vtkAbstractWidget *  widget 
)
overrideprotectedvirtual

Propagate properties of MRML node to widget.

Reimplemented from vtkMRMLAnnotationDisplayableManager.

◆ PropagateWidgetToMRML()

void vtkMRMLAnnotationRulerDisplayableManager::PropagateWidgetToMRML ( vtkAbstractWidget *  widget,
vtkMRMLAnnotationNode node 
)
overrideprotectedvirtual

Propagate properties of widget to MRML node.

Reimplemented from vtkMRMLAnnotationDisplayableManager.

◆ SafeDownCast()

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

◆ UpdatePosition()

void vtkMRMLAnnotationRulerDisplayableManager::UpdatePosition ( vtkAbstractWidget *  widget,
vtkMRMLNode node 
)
overrideprotected

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