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) override;

  enum
    {
      CursorPositionModifiedEvent = 22000
    };

  vtkMRMLNode* CreateNodeInstance() override;

  void ReadXMLAttributes( const char** atts) override;

  void WriteXML(ostream& of, int indent) override;

  vtkMRMLCopyContentMacro(vtkMRMLCrosshairNode);

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

  vtkGetMacro (CrosshairMode, int );
  vtkSetMacro (CrosshairMode, int );
  static const char* GetCrosshairModeAsString(int id);
  static int GetCrosshairModeFromString(const char* name);

  vtkSetClampMacro(CrosshairThickness, int, 1, 3);
  vtkGetMacro(CrosshairThickness, int);
  void SetCrosshairToFine() { this->SetCrosshairThickness(1); }
  void SetCrosshairToMedium() { this->SetCrosshairThickness(2); }
  void SetCrosshairToThick() { this->SetCrosshairThickness(3); }
  static const char* GetCrosshairThicknessAsString(int id);
  static int GetCrosshairThicknessFromString(const char* name);

  vtkGetVector3Macro(CrosshairColor, float);
  vtkSetVector3Macro(CrosshairColor, float);

  vtkGetMacro (CrosshairBehavior, int );
  vtkSetMacro (CrosshairBehavior, int );
  static const char* GetCrosshairBehaviorAsString(int id);
  static int GetCrosshairBehaviorFromString(const char* name);

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


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

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

  vtkSetMacro(FastPick3D, bool);
  vtkGetMacro(FastPick3D, bool);
  vtkBooleanMacro(FastPick3D, bool);

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

  int CrosshairMode{NoCrosshair};
  int CrosshairThickness{Fine};
  int CrosshairBehavior{OffsetJumpSlice};
  float CrosshairColor[3]{1.0f, 0.8f, 0.1f}; // Light yellow

  double CrosshairRAS[3]{0.0, 0.0, 0.0};
  int LightBoxPane{0};

  double CursorPositionRAS[3]{0.0, 0.0, 0.0};
  double CursorPositionXYZ[3]{0.0, 0.0, 0.0};
  vtkWeakPointer<vtkMRMLSliceNode> CursorSliceNode;

  bool CursorPositionRASValid{false};
  bool FastPick3D{false};
};

#endif