vtkMRMLMarkupsFiducialNode.h

Go to the documentation of this file.

/*==============================================================================

  Program: 3D Slicer

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

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

  Unless required by applicable law or agreed to in writing, software
  distributed under the License is distributed on an "AS IS" BASIS,
  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  See the License for the specific language governing permissions and
  limitations under the License.

==============================================================================*/

#ifndef __vtkMRMLMarkupsFiducialNode_h
#define __vtkMRMLMarkupsFiducialNode_h

// MRML includes
#include "vtkMRMLDisplayableNode.h"

// Markups includes
#include "vtkSlicerMarkupsModuleMRMLExport.h"
#include "vtkMRMLMarkupsDisplayNode.h"
#include "vtkMRMLMarkupsNode.h"

// VTK includes
#include <vtkSmartPointer.h>

class  VTK_SLICER_MARKUPS_MODULE_MRML_EXPORT vtkMRMLMarkupsFiducialNode : public vtkMRMLMarkupsNode
{
public:
  static vtkMRMLMarkupsFiducialNode *New();
  vtkTypeMacro(vtkMRMLMarkupsFiducialNode,vtkMRMLMarkupsNode);
  void PrintSelf(ostream& os, vtkIndent indent) VTK_OVERRIDE;

  virtual const char* GetIcon() VTK_OVERRIDE {return ":/Icons/MarkupsMouseModePlace.png";}

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

  virtual vtkMRMLNode* CreateNodeInstance() VTK_OVERRIDE;
  virtual const char* GetNodeTagName() VTK_OVERRIDE {return "MarkupsFiducial";}

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

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

  virtual void Copy(vtkMRMLNode *node) VTK_OVERRIDE;

  void UpdateScene(vtkMRMLScene *scene) VTK_OVERRIDE;

  virtual void ProcessMRMLEvents ( vtkObject * /*caller*/,
                                   unsigned long /*event*/,
                                   void * /*callData*/ ) VTK_OVERRIDE;


  virtual vtkMRMLStorageNode* CreateDefaultStorageNode() VTK_OVERRIDE;

  virtual void CreateDefaultDisplayNodes() VTK_OVERRIDE;

  vtkMRMLMarkupsDisplayNode *GetMarkupsDisplayNode();

  // Wrapping some of the generic markup methods

  int GetNumberOfFiducials() { return this->GetNumberOfMarkups(); } ;
  int AddFiducial(double x, double y, double z);
  int AddFiducial(double x, double y, double z, std::string label);
  int AddFiducialFromArray(double pos[3], std::string label = std::string());
  void GetNthFiducialPosition(int n, double pos[3]);
  void SetNthFiducialPosition(int n, double x, double y, double z);
  void SetNthFiducialPositionFromArray(int n, double pos[3]);
  bool GetNthFiducialSelected(int n = 0);
  void SetNthFiducialSelected(int n, bool flag);
  bool GetNthFiducialVisibility(int n = 0);
  void SetNthFiducialVisibility(int n, bool flag);
  std::string GetNthFiducialLabel(int n = 0);
  void SetNthFiducialLabel(int n, std::string label);
  std::string GetNthFiducialAssociatedNodeID(int n = 0);
  void SetNthFiducialAssociatedNodeID(int n, const char* id);
  void SetNthFiducialWorldCoordinates(int n, double coords[4]);
  void GetNthFiducialWorldCoordinates(int n, double coords[4]);

  virtual void GetRASBounds(double bounds[6]) VTK_OVERRIDE;
  virtual void GetBounds(double bounds[6]) VTK_OVERRIDE;

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

};

#endif