vtkMRMLAnnotationTextDisplayNode.h

Go to the documentation of this file.

// .NAME vtkMRMLAnnotationTextDisplayNode - MRML node to represent display properties for tractography.
// .SECTION Description
// vtkMRMLAnnotationTextDisplayNode nodes store display properties of trajectories
// from tractography in diffusion MRI data, including color type (by bundle, by fiber,
// or by scalar invariants), display on/off for tensor glyphs and display of
// trajectory as a line or tube.
//
 
#ifndef __vtkMRMLAnnotationTextDisplayNode_h
#define __vtkMRMLAnnotationTextDisplayNode_h
 
#include "vtkMRML.h"
#include "vtkMRMLAnnotationDisplayNode.h"
#include "vtkSlicerAnnotationsModuleMRMLExport.h"
 
class VTK_SLICER_ANNOTATIONS_MODULE_MRML_EXPORT vtkMRMLAnnotationTextDisplayNode : public vtkMRMLAnnotationDisplayNode
{
public:
  static vtkMRMLAnnotationTextDisplayNode* New();
  vtkTypeMacro(vtkMRMLAnnotationTextDisplayNode, vtkMRMLAnnotationDisplayNode);
  void PrintSelf(ostream& os, vtkIndent indent) override;
 
  //--------------------------------------------------------------------------
  // MRMLNode methods
  //--------------------------------------------------------------------------
 
  vtkMRMLNode* CreateNodeInstance() override;
 
  // Description:
  // Read node attributes from XML (MRML) 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;
 
  // Description:
  // Copy the node's attributes to this object
  void Copy(vtkMRMLNode* node) override;
 
  // Description:
  // Get node XML tag name (like Volume, Annotation)
  const char* GetNodeTagName() override { return "AnnotationTextDisplay"; }
 
  // Description:
  // Finds the storage node and read the data
  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;
 
  // Description:
  // Get/Set for Text scale
  void SetTextScale(double scale);
  vtkGetMacro(TextScale, double);

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

  vtkSetMacro(MaxCharactersPerLine, unsigned int);
  vtkGetMacro(MaxCharactersPerLine, unsigned int);


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

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

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

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

  vtkSetClampMacro(LeaderGlyphSize, double, 0.0, 0.1);
  vtkGetMacro(LeaderGlyphSize, double);

  vtkSetClampMacro(MaximumLeaderGlyphSize, int, 1, 1000);
  vtkGetMacro(MaximumLeaderGlyphSize, int);

  vtkSetClampMacro(Padding, int, 0, 50);
  vtkGetMacro(Padding, int);

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

  void CreateBackup() override;
  void RestoreBackup() override;

  std::string GetLineWrappedText(std::string inputText);
 
protected:
  vtkMRMLAnnotationTextDisplayNode();
  ~vtkMRMLAnnotationTextDisplayNode() override = default;
  vtkMRMLAnnotationTextDisplayNode(const vtkMRMLAnnotationTextDisplayNode&);
  void operator=(const vtkMRMLAnnotationTextDisplayNode&);
 
  double TextScale;
 
  int UseLineWrap;
  unsigned int MaxCharactersPerLine;
 
  int ShowBorder;
  int ShowLeader;
  int ShowArrowHead;
  int UseThreeDimensionalLeader;
  double LeaderGlyphSize;
  int MaximumLeaderGlyphSize;
  int Padding;
  int AttachEdgeOnly;
};
 
#endif