vtkMRMLAnnotationControlPointsNode.h

Go to the documentation of this file.

// .NAME vtkMRMLAnnotationControlPointsNode - MRML node to represent a fiber bundle from tractography in DTI data.
// .SECTION Description
// Annotation nodes contains control points, internally represented as vtkPolyData.
// A Annotation node contains many control points  and forms the smallest logical unit of tractography
// that MRML will manage/read/write. Each control point has accompanying data.
// Visualization parameters for these nodes are controlled by the vtkMRMLAnnotationPointDisplayNode class.
//

#ifndef __vtkMRMLAnnotationControlPointsNode_h
#define __vtkMRMLAnnotationControlPointsNode_h

#include "vtkMRMLAnnotationNode.h"

class vtkMRMLAnnotationPointDisplayNode;

class  VTK_SLICER_ANNOTATIONS_MODULE_MRML_EXPORT vtkMRMLAnnotationControlPointsNode
  : public vtkMRMLAnnotationNode
{
public:
  static vtkMRMLAnnotationControlPointsNode *New();
  vtkTypeMacro(vtkMRMLAnnotationControlPointsNode,vtkMRMLAnnotationNode);

  // void PrintSelf(ostream& os, vtkIndent indent) override;
  // Description:
  // Just prints short summary
  void PrintAnnotationInfo(ostream& os, vtkIndent indent, int titleFlag = 1) override;

  //--------------------------------------------------------------------------
  // MRMLNode methods
  //--------------------------------------------------------------------------

  vtkMRMLNode* CreateNodeInstance() override;
  // Description:
  // Get node XML tag name (like Volume, Model)
  const char* GetNodeTagName() override {return "AnnotationControlPoints";}

  // Description:
  // Read node attributes from XML file
  void ReadXMLAttributes( const char** atts) override;

  // Description:
  // Write this node's information to a MRML file in XML format.
  void WriteXML(ostream& of, int indent) override;

  void WriteCLI(std::vector<std::string>& commandLine,
                        std::string prefix, int coordinateSystem = 0,
                        int multipleFlag = 1) override;

  vtkMRMLCopyContentDefaultMacro(vtkMRMLAnnotationControlPointsNode);

  void UpdateScene(vtkMRMLScene *scene) override;

  // Description:
  // alternative method to propagate events generated in Display nodes
  void ProcessMRMLEvents ( vtkObject * /*caller*/,
                                   unsigned long /*event*/,
                                   void * /*callData*/ ) override;


  enum
    {
      ControlPointModifiedEvent = 19010,
    };

  void Modified() override
    {
    Superclass::Modified();

    if (!this->GetDisableModifiedEvent())
      {
      this->InvokeEvent(vtkMRMLAnnotationControlPointsNode::ControlPointModifiedEvent);
      }
    }

  int InvokePendingModifiedEvent () override
    {
    if ( this->GetModifiedEventPending() )
      {
      this->InvokeEvent(vtkMRMLAnnotationControlPointsNode::ControlPointModifiedEvent);
      }
    return Superclass::InvokePendingModifiedEvent();
    }

  // Description:
  // get associated display node or nullptr if not set
  vtkMRMLAnnotationPointDisplayNode* GetAnnotationPointDisplayNode();

  // Description:
  // Create default storage node or nullptr if does not have one
  vtkMRMLStorageNode* CreateDefaultStorageNode() override;

  int  AddControlPoint(double newControl[3],int selectedFlag, int visibleFlag);

  int  SetControlPoint(int id, double newControl[3],int selectedFlag, int visibleFlag);

  int  SetControlPointWorldCoordinates(int id, double newControl[3], int selectedFlag, int visibleFlag);

  int  SetControlPoint(int id, double newControl[3]);

  int  SetControlPointWorldCoordinates(int id, double newControl[3]);

  void DeleteControlPoint(int id);
  double* GetControlPointCoordinates(vtkIdType id);

  void GetControlPointWorldCoordinates(vtkIdType id, double *point);

  int GetNumberOfControlPoints();

  enum
  {
    CP_SELECTED =  vtkMRMLAnnotationNode::NUM_TEXT_ATTRIBUTE_TYPES,
    CP_VISIBLE,
    NUM_CP_ATTRIBUTE_TYPES
  };

  const char *GetAttributeTypesEnumAsString(int val) override;


  // Description:
  // Initializes all variables associated with annotations
  void ResetAnnotations() override;

  // Description:
  // add display node if not already present
  void CreateAnnotationPointDisplayNode();

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


  virtual void SetNumberingScheme(int numberingScheme);
  vtkGetMacro(NumberingScheme, int);

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

  void Initialize(vtkMRMLScene* mrmlScene) override;

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

  // Description:
  // Create Poly data with substructures necessary for this class
  void CreatePolyData();

  // Description:
  // Initializes control points as well as attributes
  void ResetControlPoints();

  // Description:
  // Initializes all attributes
  void ResetControlPointsAttributesAll();

  int NumberingScheme;
};

#endif