vtkMRMLCrosshairNode.h

Go to the documentation of this file.

/*=auto=========================================================================

  Portions (c) Copyright 2005 Brigham and Women's Hospital (BWH) All Rights Reserved.

  See COPYRIGHT.txt
  or http://www.slicer.org/copyright/copyright.txt for details.

  Program:   3D Slicer
  Module:    $RCSfile: vtkMRMLCrosshairNode.h,v $
  Date:      $Date: 2006/03/19 17:12:29 $
  Version:   $Revision: 1.3 $

=========================================================================auto=*/

#ifndef __vtkMRMLCrosshairNode_h
#define __vtkMRMLCrosshairNode_h

#include "vtkMRMLNode.h"
#include "vtkMRMLSliceNode.h"

class VTK_MRML_EXPORT vtkMRMLCrosshairNode : public vtkMRMLNode
{
  public:
  static vtkMRMLCrosshairNode *New();
  vtkTypeMacro(vtkMRMLCrosshairNode,vtkMRMLNode);
  void PrintSelf(ostream& os, vtkIndent indent) VTK_OVERRIDE;

  enum
    {
      CursorPositionModifiedEvent = 22000
    };

  virtual vtkMRMLNode* CreateNodeInstance() VTK_OVERRIDE;

  virtual void ReadXMLAttributes( const char** atts) VTK_OVERRIDE;

  virtual void WriteXML(ostream& of, int indent) VTK_OVERRIDE;

  virtual void Copy(vtkMRMLNode *node) VTK_OVERRIDE;

  virtual const char* GetNodeTagName() VTK_OVERRIDE {return "Crosshair";};

  vtkGetMacro (CrosshairMode, int );
  vtkSetMacro (CrosshairMode, int );
  vtkGetMacro (CrosshairBehavior, int );
  vtkSetMacro (CrosshairBehavior, int );
  vtkSetClampMacro (CrosshairThickness, int, 1, 3);
  vtkGetMacro (CrosshairThickness, int);
  void SetCrosshairToFine() { this->SetCrosshairThickness(1); }
  void SetCrosshairToMedium() { this->SetCrosshairThickness(2); }
  void SetCrosshairToThick() { this->SetCrosshairThickness(3); }

  void SetCursorPositionRAS(double ras[3]);

  void SetCursorPositionXYZ(double xyz[3], vtkMRMLSliceNode *sliceNode);

  void SetCursorPositionInvalid();

  bool GetCursorPositionRAS(double ras[3]);

  vtkMRMLSliceNode* GetCursorPositionXYZ(double xyz[3]);

  vtkSetVector3Macro(CrosshairRAS, double);
  vtkGetVector3Macro(CrosshairRAS, double);

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

  vtkGetMacro(LightBoxPane, int);


  vtkSetMacro(Navigation, int);
  vtkGetMacro(Navigation, int);
  vtkBooleanMacro(Navigation, int);

  void SetCrosshairName(const char *name) {
    this->SetSingletonTag(name);
  }
  char *GetCrosshairName() {
    return this->GetSingletonTag();
  }

  enum
    {
      NoCrosshair = 0,
      ShowBasic,
      ShowIntersection,
      ShowHashmarks,
      ShowAll,
      ShowSmallBasic,
      ShowSmallIntersection
    };
  enum
    {
      Fine = 1,
      Medium,
      Thick
    };
  enum
    {
      NoAction = 0,
      OffsetJumpSlice = 1,
      CenteredJumpSlice = 2,
      Normal = 1,   // Deprecated
      JumpSlice = 1 // Deprecated
    };

protected:
  vtkMRMLCrosshairNode();
  ~vtkMRMLCrosshairNode();
  vtkMRMLCrosshairNode(const vtkMRMLCrosshairNode&);
  void operator=(const vtkMRMLCrosshairNode&);

  int CrosshairMode;
  int CrosshairThickness;
  int CrosshairBehavior;

  int Navigation;

  double CrosshairRAS[3];
  int LightBoxPane;

  double CursorPositionRAS[3];
  double CursorPositionXYZ[3];
  vtkWeakPointer<vtkMRMLSliceNode> CursorSliceNode;

  bool CursorPositionRASValid;
};

#endif