vtkMRMLMarkupsPlaneNode.h

Go to the documentation of this file.

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

  Copyright (c) Laboratory for Percutaneous Surgery (PerkLab)
  Queen's University, Kingston, ON, Canada. 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.

  This file was originally developed by Kyle Sunderland, PerkLab, Queen's University
  and was supported through CANARIE's Research Software Program, Cancer
  Care Ontario, OpenAnatomy, and Brigham and Women's Hospital through NIH grant R01MH112748.

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

#ifndef __vtkMRMLMarkupsPlaneNode_h
#define __vtkMRMLMarkupsPlaneNode_h

// MRML includes
#include "vtkMRMLDisplayableNode.h"

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

// VTK includes
#include <vtkMatrix4x4.h>

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

  const char* GetIcon() override {return ":/Icons/MarkupsPlaneMouseModePlace.png";}

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

  enum
  {
    SizeModeAuto,
    SizeModeAbsolute,
    SizeMode_Last,
  };

  vtkMRMLNode* CreateNodeInstance() override;
  const char* GetNodeTagName() override {return "MarkupsPlane";}

  void ReadXMLAttributes( const char** atts) override;

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

  vtkMRMLCopyContentMacro(vtkMRMLMarkupsPlaneNode);

  vtkSetMacro(SizeMode, int);
  vtkGetMacro(SizeMode, int);
  const char* GetSizeModeAsString(int sizeMode);
  int GetSizeModeFromString(const char* sizeMode);

  vtkGetMacro(AutoSizeScalingFactor, double);
  vtkSetMacro(AutoSizeScalingFactor, double);

  void GetPlaneBounds(double bounds[6]);
  vtkSetVector6Macro(PlaneBounds, double);

  void GetNormal(double normal[3]);
  void SetNormal(const double normal[3]);
  void GetNormalWorld(double normal[3]);
  void SetNormalWorld(const double normal[3]);

  void GetOrigin(double origin[3]);
  void SetOrigin(const double origin[3]);
  void GetOriginWorld(double origin[3]);
  void SetOriginWorld(const double origin[3]);

  void GetAxes(double x[3], double y[3], double z[3]);
  void SetAxes(const double x[3], const double y[3], const double z[3]);
  void GetAxesWorld(double x[3], double y[3], double z[3]);
  void SetAxesWorld(const double x[3], const double y[3], const double z[3]);

  // Mapping from XYZ plane coordinates to local coordinates
  virtual void GetPlaneToLocalMatrix(vtkMatrix4x4* planeToLocalMatrix);
  // Mapping from XYZ plane coordinates to world coordinates
  virtual void GetPlaneToWorldMatrix(vtkMatrix4x4* planeToWorldMatrix);

  virtual vtkMatrix4x4* GetPlaneToPlaneOffsetMatrix();

  double GetClosestPointOnPlaneWorld(const double posWorld[3], double closestPosWorld[3], bool infinitePlane = true);

protected:

  void CalculateAxesFromPoints(const double point0[3], const double point1[3], const double point2[3], double x[3], double y[3], double z[3]);

  int SizeMode;
  double AutoSizeScalingFactor;
  double PlaneBounds[6];
  vtkSmartPointer<vtkMatrix4x4> PlaneToPlaneOffsetMatrix;

  void CreatePlane();

  void UpdateInteractionHandleToWorldMatrix() override;

  vtkMRMLMarkupsPlaneNode();
  ~vtkMRMLMarkupsPlaneNode() override;
  vtkMRMLMarkupsPlaneNode(const vtkMRMLMarkupsPlaneNode&);
  void operator=(const vtkMRMLMarkupsPlaneNode&);
};

#endif