Slicer  4.11
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 | Protected Attributes
vtkMRMLCrosshairNode Class Reference

MRML node for storing a crosshair through RAS space. More...

#include <Libs/MRML/Core/vtkMRMLCrosshairNode.h>

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

Public Types

enum  { CursorPositionModifiedEvent = 22000 }
 
enum  {
  NoCrosshair = 0, ShowBasic, ShowIntersection, ShowHashmarks,
  ShowAll, ShowSmallBasic, ShowSmallIntersection
}
 Modes for crosshair display. More...
 
enum  { Fine = 1, Medium, Thick }
 
enum  {
  NoAction = 0, OffsetJumpSlice = 1, CenteredJumpSlice = 2, Normal = 1,
  JumpSlice = 1
}
 Behavior when crosshair position is changed. More...
 
typedef vtkMRMLNode Superclass
 
- Public Types inherited from vtkMRMLNode
enum  {
  HierarchyModifiedEvent = 16000, IDChangedEvent = 16001, ReferenceAddedEvent, ReferenceModifiedEvent,
  ReferenceRemovedEvent, ReferencedNodeModifiedEvent
}
 
typedef vtkObject Superclass
 

Public Member Functions

void Copy (vtkMRMLNode *node) override
 
Copy the node's attributes to this object More...
 
vtkMRMLNodeCreateNodeInstance () override
 Create instance of the default node. Like New only virtual. More...
 
virtual const char * GetClassName ()
 
virtual int GetCrosshairBehavior ()
 
virtual int GetCrosshairMode ()
 
configures the crosshair appearance and behavior More...
 
char * GetCrosshairName ()
 
virtual double * GetCrosshairRAS ()
 
virtual void GetCrosshairRAS (double &, double &, double &)
 
virtual void GetCrosshairRAS (double [3])
 
virtual int GetCrosshairThickness ()
 
bool GetCursorPositionRAS (double ras[3])
 
vtkMRMLSliceNodeGetCursorPositionXYZ (double xyz[3])
 
virtual int GetLightBoxPane ()
 Get the pane of the lightbox that was last cached. More...
 
virtual int GetNavigation ()
 
const char * GetNodeTagName () override
 
Get node XML tag name (like Volume, Model) More...
 
virtual int IsA (const char *type)
 
virtual void NavigationOff ()
 
virtual void NavigationOn ()
 
void PrintSelf (ostream &os, vtkIndent indent) override
 
void ReadXMLAttributes (const char **atts) override
 
Set node attributes More...
 
virtual void SetCrosshairBehavior (int)
 
virtual void SetCrosshairMode (int)
 
void SetCrosshairName (const char *name)
 
Name of the layout More...
 
virtual void SetCrosshairRAS (double [3])
 
virtual void SetCrosshairRAS (double, double, double)
 
Set crosshair position More...
 
void SetCrosshairRAS (double ras[3], int id)
 
virtual void SetCrosshairThickness (int)
 
void SetCrosshairToFine ()
 
void SetCrosshairToMedium ()
 
void SetCrosshairToThick ()
 
void SetCursorPositionInvalid ()
 Invalidates the cursor position. This should be called whenever the mouse moves out of a view. More...
 
void SetCursorPositionRAS (double ras[3])
 
void SetCursorPositionXYZ (double xyz[3], vtkMRMLSliceNode *sliceNode)
 
virtual void SetNavigation (int)
 
More...
 
void WriteXML (ostream &of, int indent) override
 
Write this node's information to a MRML file in XML format. More...
 
- Public Member Functions inherited from vtkMRMLNode
vtkMRMLNodeAddAndObserveNodeReferenceID (const char *referenceRole, const char *referencedNodeID, vtkIntArray *events=nullptr)
 Add and observe a reference node from this node for a specific referenceRole. More...
 
vtkMRMLNodeAddNodeReferenceID (const char *referenceRole, const char *referencedNodeID)
 Convenience method that adds a referencedNodeID at the end of the list. More...
 
void AddNodeReferenceRole (const char *referenceRole, const char *mrmlAttributeName=nullptr, vtkIntArray *events=nullptr)
 Add a referenceRole. More...
 
virtual void AddToSceneOff ()
 
virtual void AddToSceneOn ()
 
virtual void CopyReferences (vtkMRMLNode *node)
 Copy the references of the node into this. More...
 
void CopyWithoutModifiedEvent (vtkMRMLNode *node)
 
void CopyWithScene (vtkMRMLNode *node)
 Copy everything (including Scene and ID) from another node of the same type. More...
 
void CopyWithSceneWithSingleModifiedEvent (vtkMRMLNode *node)
 Copy everything (including Scene and ID) from another node of the same type. More...
 
void CopyWithSingleModifiedEvent (vtkMRMLNode *node)
 
void DisableModifiedEventOff ()
 
void DisableModifiedEventOn ()
 
virtual int EndModify (int previousDisableModifiedEventState)
 End modifying the node. More...
 
virtual int GetAddToScene ()
 node added to MRML scene. More...
 
const char * GetAttribute (const char *name)
 Get value of a name value pair attribute. More...
 
std::vector< std::string > GetAttributeNames ()
 Get all attribute names. More...
 
void GetAttributeNames (vtkStringArray *attributeNames)
 Get all attribute names. Python-wrappable version. More...
 
virtual char * GetDescription ()
 
virtual int GetDisableModifiedEvent ()
 Turn on/off generating InvokeEvent for set macros. More...
 
virtual int GetHideFromEditors ()
 Describes if the node is hidden. More...
 
virtual char * GetID ()
 ID use by other nodes to reference this node in XML. More...
 
virtual int GetInMRMLCallbackFlag ()
 Flags to avoid event loops. More...
 
virtual int GetModifiedEventPending ()
 
virtual char * GetName ()
 
vtkMRMLNodeGetNodeReference (const char *referenceRole)
 
const char * GetNodeReferenceID (const char *referenceRole)
 Utility function that returns the first node id for a specific referenceRole. More...
 
void GetNodeReferenceIDs (const char *referenceRole, std::vector< const char *> &referencedNodeIDs)
 Return a list of the referenced node IDs. More...
 
void GetNodeReferenceRoles (std::vector< std::string > &roles)
 
void GetNodeReferences (const char *referenceRole, std::vector< vtkMRMLNode *> &nodes)
 Return a list of the referenced nodes. More...
 
vtkMRMLNodeGetNthNodeReference (const char *referenceRole, int n)
 Get referenced MRML node for a specific referenceRole. More...
 
const char * GetNthNodeReferenceID (const char *referenceRole, int n)
 Return the string of the Nth node ID for a specific reference role. More...
 
const char * GetNthNodeReferenceRole (int n)
 
int GetNumberOfNodeReferenceRoles ()
 
int GetNumberOfNodeReferences (const char *referenceRole)
 Return the number of node IDs for a specific reference role (and nodes as they always have the same size). More...
 
virtual int GetSaveWithScene ()
 Save node with MRML scene. More...
 
virtual vtkMRMLSceneGetScene ()
 Get the scene this node has been added to. More...
 
virtual int GetSelectable ()
 Describes if the node is selectable. More...
 
virtual int GetSelected ()
 Get/Set for Selected. More...
 
virtual char * GetSingletonTag ()
 
virtual bool GetUndoEnabled ()
 
bool HasNodeReferenceID (const char *referenceRole, const char *referencedNodeID)
 Return true if referencedNodeID is in the node ID list for a specific referenceRole. More...
 
virtual void HideFromEditorsOff ()
 
virtual void HideFromEditorsOn ()
 
virtual void InvokeCustomModifiedEvent (int eventId, void *callData=nullptr)
 This method allows the node to compress events. More...
 
virtual int InvokePendingModifiedEvent ()
 Invokes any modified events that are pending. More...
 
bool IsSingleton ()
 
void Modified () override
 Customized version of Modified() allowing to compress vtkCommand::ModifiedEvent. More...
 
virtual void OnNodeAddedToScene ()
 
void PrintSelf (ostream &os, vtkIndent indent) override
 
virtual void ProcessChildNode (vtkMRMLNode *)
 Set dependencies between this node and a child node when parsing XML file. More...
 
virtual void ProcessMRMLEvents (vtkObject *caller, unsigned long event, void *callData)
 Propagate events generated in mrml. More...
 
void RemoveAttribute (const char *name)
 Remove attribute with the specified name. More...
 
void RemoveNodeReferenceIDs (const char *referenceRole)
 Remove all node IDs and associated nodes for a specific referenceRole. More...
 
void RemoveNthNodeReferenceID (const char *referenceRole, int n)
 Convenience method that removes the Nth node ID from the list. More...
 
virtual void Reset (vtkMRMLNode *defaultNode)
 Reset node attributes to the initial state as defined in the constructor or the passed default node. More...
 
virtual void SaveWithSceneOff ()
 
virtual void SaveWithSceneOn ()
 
virtual void SelectableOff ()
 
virtual void SelectableOn ()
 
virtual void SelectedOff ()
 
virtual void SelectedOn ()
 
virtual void SetAddToScene (int)
 
void SetAddToSceneNoModify (int value)
 
vtkMRMLNodeSetAndObserveNodeReferenceID (const char *referenceRole, const char *referencedNodeID, vtkIntArray *events=nullptr)
 Set and observe a reference node from this node for a specific referenceRole. More...
 
vtkMRMLNodeSetAndObserveNthNodeReferenceID (const char *referenceRole, int n, const char *referencedNodeID, vtkIntArray *events=nullptr)
 Set and observe the Nth node ID for a specific reference role. More...
 
void SetAttribute (const char *name, const char *value)
 Set a name value pair attribute. More...
 
virtual void SetDescription (const char *)
 Text description of this node, to be set by the user. More...
 
void SetDisableModifiedEvent (int onOff)
 
virtual void SetHideFromEditors (int)
 
void SetInMRMLCallbackFlag (int flag)
 
virtual void SetName (const char *)
 Name of this node, to be set by the user. More...
 
vtkMRMLNodeSetNodeReferenceID (const char *referenceRole, const char *referencedNodeID)
 Set a reference to a node with specified nodeID from this node for a specific referenceRole. More...
 
vtkMRMLNodeSetNthNodeReferenceID (const char *referenceRole, int n, const char *referencedNodeID)
 Set a N-th reference from this node with specified referencedNodeID for a specific referenceRole. More...
 
virtual void SetSaveWithScene (int)
 
virtual void SetScene (vtkMRMLScene *scene)
 This method is for internal use only. Use AddNode method of vtkMRMLScene to add a node to the scene. More...
 
virtual void SetSceneReferences ()
 Update the references of the node to the scene. More...
 
virtual void SetSelectable (int)
 
virtual void SetSelected (int)
 
void SetSingletonOff ()
 
void SetSingletonOn ()
 
virtual void SetSingletonTag (const char *)
 Tag that make this node a singleton in the scene. More...
 
virtual void SetUndoEnabled (bool)
 
virtual int StartModify ()
 Start modifying the node. Disable Modify events. More...
 
virtual void UndoEnabledOff ()
 
virtual void UndoEnabledOn ()
 
virtual void UpdateReferenceID (const char *oldID, const char *newID)
 Update the stored reference to another node in the scene. More...
 
virtual void UpdateReferences ()
 The method should remove all pointers and observations to all nodes that are not in the scene anymore. More...
 
virtual void UpdateScene (vtkMRMLScene *)
 
const char * URLDecodeString (const char *inString)
 Decode a URL string. More...
 
const char * URLEncodeString (const char *inString)
 Encode a URL string. More...
 
virtual void WriteNodeBodyXML (ostream &of, int indent)
 Write this node's body to a MRML file in XML format. More...
 
std::string XMLAttributeDecodeString (const std::string &inString)
 Decode an XML attribute string. More...
 
std::string XMLAttributeEncodeString (const std::string &inString)
 Encode an XML attribute string (replaces special characters by code sequences) More...
 

Static Public Member Functions

static int IsTypeOf (const char *type)
 
static vtkMRMLCrosshairNodeNew ()
 
static vtkMRMLCrosshairNodeSafeDownCast (vtkObject *o)
 
- Static Public Member Functions inherited from vtkMRMLNode
static int IsTypeOf (const char *type)
 
static vtkMRMLNodeSafeDownCast (vtkObject *o)
 

Protected Member Functions

void operator= (const vtkMRMLCrosshairNode &)
 
 vtkMRMLCrosshairNode ()
 
 vtkMRMLCrosshairNode (const vtkMRMLCrosshairNode &)
 
 ~vtkMRMLCrosshairNode () override
 
- Protected Member Functions inherited from vtkMRMLNode
virtual const char * GetMRMLAttributeNameFromReferenceRole (const char *refRole)
 Return the mrml attribute name (if found) associated with a reference role. Return 0 otherwise. More...
 
virtual const char * GetReferenceRoleFromMRMLAttributeName (const char *attName)
 Return the reference role (if found) associated with the attribute name found in a MRML scene file. Return 0 otherwise. More...
 
virtual char * GetTempURLString ()
 
void GetUpdatedReferencedNodeEventList (int &oldReferencedNodeUseCount, int &newReferencedNodeUseCount, vtkIntArray *oldConsolidatedEventList, vtkIntArray *newConsolidatedEventList, vtkMRMLNode *oldReferencedNode, vtkMRMLNode *newReferencedNode, vtkMRMLNodeReference *referenceToIgnore, vtkIntArray *newEvents)
 
virtual void InvalidateNodeReferences ()
 
virtual bool IsReferenceRoleGeneric (const char *refRole)
 Return true if the reference role is generic (ends with '/') or false otherwise. More...
 
virtual void OnNodeReferenceAdded (vtkMRMLNodeReference *reference)
 
virtual void OnNodeReferenceModified (vtkMRMLNodeReference *reference)
 Called when a referenced node pointer is modified. More...
 
virtual void OnNodeReferenceRemoved (vtkMRMLNodeReference *reference)
 Called when a referenced node pointer is removed (set to nullptr). More...
 
void operator= (const vtkMRMLNode &)
 
void ParseReferencesAttribute (const char *attValue, std::map< std::string, std::string > &references)
 
virtual void SetTempURLString (const char *)
 Get/Set the string used to manage encoding/decoding of strings/URLs with special characters. More...
 
vtkMRMLNodeUpdateNodeReferenceEventObserver (vtkMRMLNode *oldReferencedNode, vtkMRMLNode *newReferencedNode, vtkIntArray *newEvents, vtkMRMLNodeReference *referenceToIgnore)
 
virtual void UpdateNodeReferences (const char *referenceRole=nullptr)
 
virtual void UpdateNthNodeReference (const char *referenceRole, int n)
 
 vtkMRMLNode ()
 
 vtkMRMLNode (const vtkMRMLNode &)
 
 ~vtkMRMLNode () override
 critical to have a virtual destructor! More...
 

Protected Attributes

int CrosshairBehavior
 
int CrosshairMode
 
double CrosshairRAS [3]
 
int CrosshairThickness
 
double CursorPositionRAS [3]
 
bool CursorPositionRASValid
 Set to false if the cursor is not in a view. More...
 
double CursorPositionXYZ [3]
 
vtkWeakPointer< vtkMRMLSliceNodeCursorSliceNode
 
int LightBoxPane
 
int Navigation
 
- Protected Attributes inherited from vtkMRMLNode
int AddToScene
 
AttributesType Attributes
 
char * Description
 
int HideFromEditors
 
char * ID
 
int InMRMLCallbackFlag
 
Flag to avoid event loops More...
 
vtkCallbackCommand * MRMLCallbackCommand
 Holders for MRML callbacks. More...
 
vtkObserverManagerMRMLObserverManager
 
char * Name
 
NodeReferenceEventsType NodeReferenceEvents
 
std::map< std::string, std::string > NodeReferenceMRMLAttributeNames
 
NodeReferencesType NodeReferences
 
int SaveWithScene
 
vtkWeakPointer< vtkMRMLSceneScene
 
int Selectable
 
int Selected
 
bool UndoEnabled
 

Additional Inherited Members

- Protected Types inherited from vtkMRMLNode
typedef std::map< std::string, std::string > AttributesType
 
typedef std::map< std::string, vtkSmartPointer< vtkIntArray > > NodeReferenceEventsType
 
typedef std::vector< vtkSmartPointer< vtkMRMLNodeReference > > NodeReferenceListType
 
typedef std::map< std::string, NodeReferenceListTypeNodeReferencesType
 
- Static Protected Member Functions inherited from vtkMRMLNode
static void MRMLCallback (vtkObject *caller, unsigned long eid, void *clientData, void *callData)
 

Detailed Description

MRML node for storing a crosshair through RAS space.

This node stores the information about a crosshair (position, style, attributes)

Definition at line 25 of file vtkMRMLCrosshairNode.h.

Member Typedef Documentation

◆ Superclass

Definition at line 29 of file vtkMRMLCrosshairNode.h.

Member Enumeration Documentation

◆ anonymous enum

anonymous enum

CursorPositionModifiedEvent is invoked when the cursor position is modified, for example a mouse pointer is moved in a slice view.

Enumerator
CursorPositionModifiedEvent 

Definition at line 34 of file vtkMRMLCrosshairNode.h.

◆ anonymous enum

anonymous enum

Modes for crosshair display.

Enumerator
NoCrosshair 
ShowBasic 
ShowIntersection 
ShowHashmarks 
ShowAll 
ShowSmallBasic 
ShowSmallIntersection 

Definition at line 128 of file vtkMRMLCrosshairNode.h.

◆ anonymous enum

anonymous enum
Enumerator
Fine 
Medium 
Thick 

Definition at line 138 of file vtkMRMLCrosshairNode.h.

◆ anonymous enum

anonymous enum

Behavior when crosshair position is changed.

Enumerator
NoAction 
OffsetJumpSlice 
CenteredJumpSlice 
Normal 
Deprecated:
Use OffsetJumpSlice instead
JumpSlice 
Deprecated:
Use CenterdJumpSlice instead

Definition at line 145 of file vtkMRMLCrosshairNode.h.

Constructor & Destructor Documentation

◆ vtkMRMLCrosshairNode() [1/2]

vtkMRMLCrosshairNode::vtkMRMLCrosshairNode ( )
protected

◆ ~vtkMRMLCrosshairNode()

vtkMRMLCrosshairNode::~vtkMRMLCrosshairNode ( )
overrideprotected

◆ vtkMRMLCrosshairNode() [2/2]

vtkMRMLCrosshairNode::vtkMRMLCrosshairNode ( const vtkMRMLCrosshairNode )
protected

Member Function Documentation

◆ Copy()

void vtkMRMLCrosshairNode::Copy ( vtkMRMLNode node)
overridevirtual


Copy the node's attributes to this object

Reimplemented from vtkMRMLNode.

◆ CreateNodeInstance()

vtkMRMLNode* vtkMRMLCrosshairNode::CreateNodeInstance ( )
overridevirtual

Create instance of the default node. Like New only virtual.

Note
Subclasses should implement this method

Implements vtkMRMLNode.

◆ GetClassName()

virtual const char* vtkMRMLCrosshairNode::GetClassName ( )
virtual

Reimplemented from vtkMRMLNode.

◆ GetCrosshairBehavior()

virtual int vtkMRMLCrosshairNode::GetCrosshairBehavior ( )
virtual

◆ GetCrosshairMode()

virtual int vtkMRMLCrosshairNode::GetCrosshairMode ( )
virtual


configures the crosshair appearance and behavior

◆ GetCrosshairName()

char* vtkMRMLCrosshairNode::GetCrosshairName ( )
inline

Definition at line 123 of file vtkMRMLCrosshairNode.h.

◆ GetCrosshairRAS() [1/3]

virtual double* vtkMRMLCrosshairNode::GetCrosshairRAS ( )
virtual

◆ GetCrosshairRAS() [2/3]

virtual void vtkMRMLCrosshairNode::GetCrosshairRAS ( double &  ,
double &  ,
double &   
)
virtual

◆ GetCrosshairRAS() [3/3]

virtual void vtkMRMLCrosshairNode::GetCrosshairRAS ( double  [3])
virtual

◆ GetCrosshairThickness()

virtual int vtkMRMLCrosshairNode::GetCrosshairThickness ( )
virtual

◆ GetCursorPositionRAS()

bool vtkMRMLCrosshairNode::GetCursorPositionRAS ( double  ras[3])

Get the position of the cursor in the current view in RAS coordinate system. Returns false if the cursor position is unknown. This is typically called by other classes to get the current cursor position after receiving CursorPositionModifiedEvent event.

◆ GetCursorPositionXYZ()

vtkMRMLSliceNode* vtkMRMLCrosshairNode::GetCursorPositionXYZ ( double  xyz[3])

Get the position of the cursor in the current view in XYZ coordinate system. Returns nullptr if the cursor is not in a slice viewer. This is typically called by other classes to get the current cursor position after receiving CursorPositionModifiedEvent event.

◆ GetLightBoxPane()

virtual int vtkMRMLCrosshairNode::GetLightBoxPane ( )
virtual

Get the pane of the lightbox that was last cached.

◆ GetNavigation()

virtual int vtkMRMLCrosshairNode::GetNavigation ( )
virtual

◆ GetNodeTagName()

const char* vtkMRMLCrosshairNode::GetNodeTagName ( )
inlineoverridevirtual


Get node XML tag name (like Volume, Model)

Implements vtkMRMLNode.

Definition at line 55 of file vtkMRMLCrosshairNode.h.

◆ IsA()

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

Reimplemented from vtkMRMLNode.

◆ IsTypeOf()

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

◆ NavigationOff()

virtual void vtkMRMLCrosshairNode::NavigationOff ( )
virtual

◆ NavigationOn()

virtual void vtkMRMLCrosshairNode::NavigationOn ( )
virtual

◆ New()

static vtkMRMLCrosshairNode* vtkMRMLCrosshairNode::New ( )
static

◆ operator=()

void vtkMRMLCrosshairNode::operator= ( const vtkMRMLCrosshairNode )
protected

◆ PrintSelf()

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

◆ ReadXMLAttributes()

void vtkMRMLCrosshairNode::ReadXMLAttributes ( const char **  atts)
overridevirtual


Set node attributes

Reimplemented from vtkMRMLNode.

◆ SafeDownCast()

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

◆ SetCrosshairBehavior()

virtual void vtkMRMLCrosshairNode::SetCrosshairBehavior ( int  )
virtual

◆ SetCrosshairMode()

virtual void vtkMRMLCrosshairNode::SetCrosshairMode ( int  )
virtual

◆ SetCrosshairName()

void vtkMRMLCrosshairNode::SetCrosshairName ( const char *  name)
inline


Name of the layout

Definition at line 120 of file vtkMRMLCrosshairNode.h.

◆ SetCrosshairRAS() [1/3]

virtual void vtkMRMLCrosshairNode::SetCrosshairRAS ( double  ,
double  ,
double   
)
virtual


Set crosshair position

◆ SetCrosshairRAS() [2/3]

virtual void vtkMRMLCrosshairNode::SetCrosshairRAS ( double  [3])
virtual

◆ SetCrosshairRAS() [3/3]

void vtkMRMLCrosshairNode::SetCrosshairRAS ( double  ras[3],
int  id 
)

Set the crosshair position and cache which pane of lightbox that position was in

◆ SetCrosshairThickness()

virtual void vtkMRMLCrosshairNode::SetCrosshairThickness ( int  )
virtual

◆ SetCrosshairToFine()

void vtkMRMLCrosshairNode::SetCrosshairToFine ( )
inline

Definition at line 65 of file vtkMRMLCrosshairNode.h.

◆ SetCrosshairToMedium()

void vtkMRMLCrosshairNode::SetCrosshairToMedium ( )
inline

Definition at line 66 of file vtkMRMLCrosshairNode.h.

◆ SetCrosshairToThick()

void vtkMRMLCrosshairNode::SetCrosshairToThick ( )
inline

Definition at line 67 of file vtkMRMLCrosshairNode.h.

◆ SetCursorPositionInvalid()

void vtkMRMLCrosshairNode::SetCursorPositionInvalid ( )

Invalidates the cursor position. This should be called whenever the mouse moves out of a view.

◆ SetCursorPositionRAS()

void vtkMRMLCrosshairNode::SetCursorPositionRAS ( double  ras[3])

Set cursor position in 3D. This should be called whenever the cursor is moved by using a 3D positioning device (that does not have an associated slice viewer). GetCursorPositionXYZ returns with nullptr if SetCursorPositionRAS is used for setting the cursor position, so if slice position is available then SetCursorPositionXYZ method should be used instead (it sets both XYZ and RAS position, too).

◆ SetCursorPositionXYZ()

void vtkMRMLCrosshairNode::SetCursorPositionXYZ ( double  xyz[3],
vtkMRMLSliceNode sliceNode 
)

Set cursor position in a 2D slice view. The method also computes the RAS position. This method should be called whenever the mouse moves in a slice viewer.

◆ SetNavigation()

virtual void vtkMRMLCrosshairNode::SetNavigation ( int  )
virtual


Deprecated:
This member has no effect anymore and will be removed in the future.

◆ WriteXML()

void vtkMRMLCrosshairNode::WriteXML ( ostream &  of,
int  indent 
)
overridevirtual


Write this node's information to a MRML file in XML format.

Reimplemented from vtkMRMLNode.

Member Data Documentation

◆ CrosshairBehavior

int vtkMRMLCrosshairNode::CrosshairBehavior
protected

Definition at line 162 of file vtkMRMLCrosshairNode.h.

◆ CrosshairMode

int vtkMRMLCrosshairNode::CrosshairMode
protected

Definition at line 160 of file vtkMRMLCrosshairNode.h.

◆ CrosshairRAS

double vtkMRMLCrosshairNode::CrosshairRAS[3]
protected

Definition at line 166 of file vtkMRMLCrosshairNode.h.

◆ CrosshairThickness

int vtkMRMLCrosshairNode::CrosshairThickness
protected

Definition at line 161 of file vtkMRMLCrosshairNode.h.

◆ CursorPositionRAS

double vtkMRMLCrosshairNode::CursorPositionRAS[3]
protected

Last known cursor position in RAS coordinate system. If CursorPositionValid is false then this position is not up-to-date anymore.

Definition at line 171 of file vtkMRMLCrosshairNode.h.

◆ CursorPositionRASValid

bool vtkMRMLCrosshairNode::CursorPositionRASValid
protected

Set to false if the cursor is not in a view.

Definition at line 181 of file vtkMRMLCrosshairNode.h.

◆ CursorPositionXYZ

double vtkMRMLCrosshairNode::CursorPositionXYZ[3]
protected

Last known cursor position in XYZ coordinate system. If CursorSliceNode is nullptr then this position is not up-to-date anymore.

Definition at line 174 of file vtkMRMLCrosshairNode.h.

◆ CursorSliceNode

vtkWeakPointer<vtkMRMLSliceNode> vtkMRMLCrosshairNode::CursorSliceNode
protected

CursorSliceNode points to the slice where the cursor is. It is not stored as a MRML node reference as its value is not saved with the scene and also it changes frequently therefore it is better to keep a lightweight reference.

Definition at line 178 of file vtkMRMLCrosshairNode.h.

◆ LightBoxPane

int vtkMRMLCrosshairNode::LightBoxPane
protected

Definition at line 167 of file vtkMRMLCrosshairNode.h.

◆ Navigation

int vtkMRMLCrosshairNode::Navigation
protected

Definition at line 164 of file vtkMRMLCrosshairNode.h.


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