vtkMRMLFiducialListNode.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: vtkMRMLFiducialListNode.h,v $
  Date:      $Date: 2006/03/19 17:12:28 $
  Version:   $Revision: 1.6 $

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

#ifndef __vtkMRMLFiducialListNode_h
#define __vtkMRMLFiducialListNode_h

// MRML includes
#include "vtkMRMLTransformableNode.h"
class vtkMRMLFiducial;
class vtkMRMLFiducialListStorageNode;

// VTK includes
class vtkMatrix4x4;
class vtkCollection;

// STD includes
#include <string>

struct FiducialListSwappedIndicesStruct
{
    int first;
    int second;
};
using FiducialListSwappedIndices = struct FiducialListSwappedIndicesStruct;

class VTK_MRML_EXPORT vtkMRMLFiducialListNode : public vtkMRMLTransformableNode
{
public:
  static vtkMRMLFiducialListNode *New();
  vtkTypeMacro(vtkMRMLFiducialListNode,vtkMRMLTransformableNode);
  void PrintSelf(ostream& os, vtkIndent indent) override;


  vtkMRMLNode* CreateNodeInstance() override;

  void ReadXMLAttributes( const char** atts) override;

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


  void Copy(vtkMRMLNode *node) override;

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

  void UpdateScene(vtkMRMLScene *scene) override;

  void UpdateReferences() override;

  void SetSymbolScale(double scale);
  vtkGetMacro(SymbolScale,double);


  void SetVisibility(int visible);
  vtkGetMacro(Visibility,int);

  void SetTextScale(double scale);
  vtkGetMacro(TextScale,double);

  void SetColor(double r, double g, double b);
  void SetColor(double c[3]);
  vtkGetVectorMacro(Color,double,3);

  void SetSelectedColor(double r, double g, double b);
  void SetSelectedColor(double c[3]);
  vtkGetVectorMacro(SelectedColor,double,3);


  int GetNumberOfFiducials();

  int SetNthFiducialXYZ(int n, float x, float y, float z);
  int SetNthFiducialOrientation(int n, float w, float x, float y, float z);
  int SetNthFiducialLabelText(int n, const char *text);
  int SetNthFiducialSelected(int n, int flag);
  int SetNthFiducialSelectedNoModified(int n, int flag);
  int SetNthFiducialVisibility(int n, int flag);
  int SetNthFiducialVisibilityNoModified(int n, int flag);
  int SetNthFiducialID(int n, const char *id);

  int SetNthFiducialXYZWorld(int n, float x, float y, float z);

  int SetFiducialXYZ(std::string fiducialID, float x, float y, float z);
  int GetFiducialIndex(std::string fiducialID);

  int SetAllFiducialsSelected(int flag);

  int SetAllFiducialsVisibility(int flag);

  float *GetNthFiducialXYZ(int n);

  int GetNthFiducialXYZWorld(int n, double *worldxyz);
  float *GetNthFiducialOrientation(int n);
  const char *GetNthFiducialLabelText(int n);
  int GetNthFiducialSelected(int n);
  int GetNthFiducialVisibility(int n);
  const char *GetNthFiducialID(int n);

  int AddFiducial( );

  int AddFiducialWithXYZ(float x, float y, float z, int selected);
  int AddFiducialWithLabelXYZSelectedVisibility(const char *label, float x, float y, float z, int selected, int visibility);

  void RemoveFiducial(vtkMRMLFiducial *o);
  void RemoveFiducial(int i);
  void RemoveAllFiducials();
  int  IsFiducialPresent(vtkMRMLFiducial *o);

  void ProcessMRMLEvents ( vtkObject *caller, unsigned long event, void *callData ) override;

  enum
    {
      DisplayModifiedEvent = 19000,
      PolyDataModifiedEvent = 19001,
      FiducialModifiedEvent = 19002,
      FiducialIndexModifiedEvent = 19003
    };

  void SetOpacity(double opacity);
  vtkGetMacro(Opacity, double);

  void SetAmbient(double val);
  vtkGetMacro(Ambient, double);

  void SetDiffuse(double val);
  vtkGetMacro(Diffuse, double);

  void SetSpecular(double val);
  vtkGetMacro(Specular, double);

  void SetPower(double val);
  vtkGetMacro(Power, double);

  void SetLocked(int locked);
  vtkGetMacro(Locked, int);

  enum GlyphShapes
  {
    GlyphMin = 1,
    Vertex2D = GlyphMin,
    Dash2D,
    Cross2D,
    ThickCross2D,
    Triangle2D,
    Square2D,
    Circle2D,
    Diamond2D,
    Arrow2D,
    ThickArrow2D,
    HookedArrow2D,
    StarBurst2D,
    Sphere3D,
    Diamond3D,
    GlyphMax = Diamond3D
  };

  int GetMinimumGlyphType() { return vtkMRMLFiducialListNode::GlyphMin; };
  int GetMaximumGlyphType() { return vtkMRMLFiducialListNode::GlyphMax; };

  void SetGlyphType(int type);
  vtkGetMacro(GlyphType, int);
  int GlyphTypeIs3D(int glyphType);
  int GlyphTypeIs3D() { return this->GlyphTypeIs3D(this->GlyphType); };

  const char* GetGlyphTypeAsString();
  const char* GetGlyphTypeAsString(int g);
  void SetGlyphTypeFromString(const char *glyphString);

  bool CanApplyNonLinearTransforms()const override;
  void ApplyTransform(vtkAbstractTransform* transform) override;

  vtkMRMLStorageNode* CreateDefaultStorageNode() override;

  int MoveFiducialUp(int fidIndex);
  int MoveFiducialDown(int fidIndex);

  void RenumberFiducials(int startFrom = 0);

  void RenameFiducials(const char *newName);

  enum NumberingSchemes
  {
      SchemeMin = 0,
      UseID = SchemeMin,
      UseIndex,
      UsePrevious,
      SchemeMax = UsePrevious
  };

  vtkSetMacro(NumberingScheme, int);
  vtkGetMacro(NumberingScheme, int);

  const char* GetNumberingSchemeAsString();
  const char* GetNumberingSchemeAsString(int g);
  void SetNumberingSchemeFromString(const char *schemeString);

  void SetFiducialLabelTextFromID(vtkMRMLFiducial *fid);

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

  vtkMRMLFiducial* GetNthFiducial(int n);

  double SymbolScale;
  double TextScale;
  int Visibility;
  double Color[3];
  double SelectedColor[3];

  vtkCollection *FiducialList;

  double Opacity;
  double Ambient;
  double Diffuse;
  double Specular;
  double Power;
  int Locked;
  int GlyphType;

  int NumberingScheme;
};

#endif