mitkGizmo.h

Go to the documentation of this file.

/*============================================================================
 
The Medical Imaging Interaction Toolkit (MITK)
 
Copyright (c) German Cancer Research Center (DKFZ)
All rights reserved.
 
Use of this source code is governed by a 3-clause BSD license that can be
found in the LICENSE file.
 
============================================================================*/
 
#ifndef mitkGizmo_h
#define mitkGizmo_h
 
#include <mitkDataNode.h>
#include <mitkSurface.h>
 
#include <MitkGizmoExports.h>
 
namespace mitk
{
  class DataStorage;
  class GizmoRemover;
 
  class MITKGIZMO_EXPORT Gizmo : public Surface
  {
  public:
    enum AxisType
    {
      AxisX,
      AxisY,
      AxisZ
    };
 
    enum HandleType
    {
      MoveFreely, //< the central sphere
      MoveAlongAxisX,
      MoveAlongAxisY,
      MoveAlongAxisZ,
      RotateAroundAxisX,
      RotateAroundAxisY,
      RotateAroundAxisZ,
      ScaleX,
      ScaleY,
      ScaleZ,
      NoHandle //< to indicate picking failure
    };
 
    static std::string HandleTypeToString(HandleType type);
 
    mitkClassMacro(Gizmo, Surface);
    itkNewMacro(Gizmo);
 
    itkGetConstMacro(Center, Point3D);
    itkSetMacro(Center, Point3D);
 
    itkGetConstMacro(AxisX, Vector3D);
    itkSetMacro(AxisX, Vector3D);
 
    itkGetConstMacro(AxisY, Vector3D);
    itkSetMacro(AxisY, Vector3D);
 
    itkGetConstMacro(AxisZ, Vector3D);
    itkSetMacro(AxisZ, Vector3D);
 
    itkGetConstMacro(Radius, Vector3D);
    itkSetMacro(Radius, Vector3D);
 
    itkGetConstMacro(AllowTranslation, bool);
    itkSetMacro(AllowTranslation, bool);
    itkBooleanMacro(AllowTranslation);
 
    itkGetConstMacro(AllowRotation, bool);
    itkSetMacro(AllowRotation, bool);
    itkBooleanMacro(AllowRotation);
 
    itkGetConstMacro(AllowScaling, bool);
    itkSetMacro(AllowScaling, bool);
    itkBooleanMacro(AllowScaling);
 
    double GetLongestRadius() const;
 
    void UpdateRepresentation();
 
    void FollowGeometry(BaseGeometry *geom);
 
    void OnFollowedGeometryModified();
 
    HandleType GetHandleFromPointID(vtkIdType id);
 
    mitk::Gizmo::HandleType GetHandleFromPointDataValue(double value);
 
    static DataNode::Pointer AddGizmoToNode(DataNode *node, DataStorage *storage);
 
    static bool RemoveGizmoFromNode(DataNode *node, DataStorage *storage);
 
    static bool HasGizmoAttached(mitk::DataNode *node, DataStorage *storage);
 
  protected:
    Gizmo();
    ~Gizmo() override;
 
    Gizmo(const Gizmo &);            // = delete;
    Gizmo &operator=(const Gizmo &); // = delete;
 
    vtkSmartPointer<vtkPolyData> BuildGizmo();
 
  private:
    Point3D m_Center;
    Vector3D m_AxisX;
    Vector3D m_AxisY;
    Vector3D m_AxisZ;
    Vector3D m_Radius;
 
    bool m_AllowTranslation;
    bool m_AllowRotation;
    bool m_AllowScaling;
 
    BaseGeometry::Pointer m_FollowedGeometry;
    unsigned long m_FollowerTag;
 
    std::unique_ptr<GizmoRemover> m_GizmoRemover;
  };
}
#endif