vtkMRMLInteractionWidgetRepresentation.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 vtkSlicerInteractionRepresentation_h
#define vtkSlicerInteractionRepresentation_h
 
// MRMLDM includes
#include "vtkMRMLDisplayableManagerExport.h"
#include "vtkMRMLAbstractWidgetRepresentation.h"
 
// MRML includes
#include <vtkMRMLSliceNode.h>
 
// VTK includes
#include <vtkActor.h>
#include <vtkFloatArray.h>
#include <vtkGlyph3DMapper.h>
#include <vtkIntArray.h>
#include <vtkPlane.h>
#include <vtkPointPlacer.h>
#include <vtkProperty.h>
#include <vtkSmartPointer.h>
#include <vtkTransform.h>
#include <vtkUnsignedCharArray.h>
#include <vtkWeakPointer.h>
 
// STD includes
#include <map>
#include <memory>
#include <vector>
 
class vtkMRMLInteractionEventData;
class vtkMRMLDisplayNode;
class vtkMRMLDisplayableNode;
struct SharedHandleRenderer;
 
class VTK_MRML_DISPLAYABLEMANAGER_EXPORT vtkMRMLInteractionWidgetRepresentation : public vtkMRMLAbstractWidgetRepresentation
{
public:
  vtkTypeMacro(vtkMRMLInteractionWidgetRepresentation, vtkMRMLAbstractWidgetRepresentation);
  void PrintSelf(ostream& os, vtkIndent indent) override;

  void UpdateFromMRML(vtkMRMLNode* caller, unsigned long event, void* callData = nullptr) override;

  void SetRenderer(vtkRenderer* renderer) override;

  void GetActors(vtkPropCollection*) override;
  void ReleaseGraphicsResources(vtkWindow*) override;
  int RenderOverlay(vtkViewport* viewport) override;
  int RenderOpaqueGeometry(vtkViewport* viewport) override;
  int RenderTranslucentPolygonalGeometry(vtkViewport* viewport) override;
  vtkTypeBool HasTranslucentPolygonalGeometry() override;

  virtual bool GetTransformationReferencePoint(double referencePointWorld[3]);

  virtual void CanInteract(vtkMRMLInteractionEventData* interactionEventData, int& foundComponentType, int& foundComponentIndex, double& closestDistance2);
 
  virtual vtkPointPlacer* GetPointPlacer();

  vtkProp* GetInteractionActor();

  virtual bool IsDisplayable() = 0;
 
  virtual vtkMRMLSliceNode* GetSliceNode();
  virtual void GetSliceToWorldCoordinates(const double slicePos[2], double worldPos[3]);
 
  virtual void UpdateSlicePlaneFromSliceNode();

  virtual void UpdateInteractionPipeline();

  virtual void GetInteractionHandleAxisLocal(int type, int index, double axis[3]);

  virtual void GetInteractionHandleAxisWorld(int type, int index, double axis[3]);
  virtual void GetInteractionHandleOriginWorld(double origin[3]);
 
  enum
  {
    InteractionNone,
    InteractionTranslationHandle,
    InteractionRotationHandle,
    InteractionScaleHandle,
    Interaction_Last
  };
 
  enum
  {
    GlyphArrow,
    GlyphCircle,
    GlyphRing,
    GlyphCrosshair,
    GlyphArrowOutline,
    GlyphCircleOutline,
    GlyphRingOutline,
    GlyphCrosshairOutline
  };
 
  virtual int GetActiveComponentType() = 0;
  virtual void SetActiveComponentType(int type) = 0;
 
  virtual int GetActiveComponentIndex() = 0;
  virtual void SetActiveComponentIndex(int index) = 0;
 
  virtual double GetMaximumHandlePickingDistance2();
 
  virtual vtkTransform* GetHandleToWorldTransform();
 
  virtual int GetNumberOfHandles(int type);
  virtual int GetNumberOfHandles();
 
  vtkSetMacro(Interacting, bool);
  vtkGetMacro(Interacting, bool);
  vtkBooleanMacro(Interacting, bool);

  virtual void GetHandleColor(int type, int index, double color[4]);
  virtual double GetHandleOpacity(int type, int index);
  virtual double GetInteractionHandleOpacity();
  virtual double GetTranslationScaleFactor();
  virtual bool GetHandleVisibility(int type, int index);
  virtual int GetHandleGlyphType(int type, int index);
  virtual bool GetApplyScaleToPosition(int type, int index);
  virtual void GetInteractionHandlePositionLocal(int type, int index, double position[3]);
  virtual void GetInteractionHandlePositionWorld(int type, int index, double position[3]);

  virtual void UpdateHandleToWorldTransform();
  virtual void UpdateHandleToWorldTransform(vtkTransform* handleToWorldTransform) = 0;
 
protected:
  vtkMRMLInteractionWidgetRepresentation();
  ~vtkMRMLInteractionWidgetRepresentation() override;
 
  class VTK_MRML_DISPLAYABLEMANAGER_EXPORT InteractionPipeline
  {
  public:
    InteractionPipeline();
    virtual ~InteractionPipeline();
 
    vtkSmartPointer<vtkPolyData> ArrowPolyData;
    vtkSmartPointer<vtkPolyData> CirclePolyData;
    vtkSmartPointer<vtkPolyData> RingPolyData;
    vtkSmartPointer<vtkPolyData> CrosshairPolyData;
    vtkSmartPointer<vtkPolyData> ArrowOutlinePolyData;
    vtkSmartPointer<vtkPolyData> CircleOutlinePolyData;
    vtkSmartPointer<vtkPolyData> RingOutlinePolyData;
    vtkSmartPointer<vtkPolyData> CrosshairOutlinePolyData;
 
    vtkSmartPointer<vtkPolyData> RotationHandlePoints;
    vtkSmartPointer<vtkPolyData> TranslationHandlePoints;
    vtkSmartPointer<vtkPolyData> ScaleHandlePoints;
 
    vtkSmartPointer<vtkTransform> HandleToWorldTransform;
 
    vtkSmartPointer<vtkPolyData> InstancePolyData;
    vtkSmartPointer<vtkFloatArray> GlyphOrientationArray;
    vtkSmartPointer<vtkFloatArray> GlyphScaleArray;
    vtkSmartPointer<vtkIntArray> GlyphSourceIndexArray;
    vtkSmartPointer<vtkUnsignedCharArray> ColorArray;
 
    vtkSmartPointer<vtkGlyph3DMapper> Mapper;
    vtkSmartPointer<vtkProperty> Property;
    vtkSmartPointer<vtkActor> Actor;
 
    vtkSmartPointer<vtkTransform> WorldToSliceTransform;
    vtkSmartPointer<vtkTransform> ActorTransform;
  };
 
  struct HandleInfo
  {
    HandleInfo(int index, int componentType, double positionWorld[3], double positionLocal[3], double color[4], int glyphType, bool applyScaleToPosition)
      : Index(index)
      , ComponentType(componentType)
      , GlyphType(glyphType)
      , ApplyScaleToPosition(applyScaleToPosition)
    {
      for (int i = 0; i < 3; ++i)
      {
        this->PositionWorld[i] = positionWorld[i];
      }
      this->PositionWorld[3] = 1.0;
      for (int i = 0; i < 3; ++i)
      {
        this->PositionLocal[i] = positionLocal[i];
      }
      this->PositionLocal[3] = 1.0;
      for (int i = 0; i < 4; ++i)
      {
        this->Color[i] = color[i];
      }
    }
    int Index;
    int ComponentType;
    int GlyphType;
    double PositionLocal[4];
    double PositionWorld[4];
    double Color[4];
    bool ApplyScaleToPosition{ true };
    bool IsVisible()
    {
      double epsilon = 0.001;
      return this->Color[3] > epsilon;
    }
  };

  typedef std::vector<HandleInfo> HandleInfoList;
  virtual HandleInfoList GetHandleInfoList();
  virtual HandleInfo GetHandleInfo(int type, int index);
 
  virtual void InitializePipeline();
  virtual void CreateRotationHandles();
  virtual void CreateTranslationHandles();
  virtual void CreateScaleHandles();
  virtual void UpdateInstanceArrays();
  virtual void UpdateActorTransform();
  virtual vtkPolyData* GetHandlePolydata(int type);

  virtual void UpdateCameraState();

  virtual void SetWidgetScale(double scale);

  virtual void GetHandleToCameraVectorWorld(double handlePosition_World[3], double normal_World[3]);

  virtual void OrthoganalizeTransform(vtkTransform* transform);

  virtual void UpdateViewScaleFactor();
 
  virtual void UpdateHandleSize();
  virtual double GetInteractionScalePercent();
  virtual double GetInteractionSizeMm();
  virtual bool GetInteractionSizeAbsolute();
 
  virtual void CanInteractWithCircleHandle(vtkMRMLInteractionEventData* interactionEventData,
                                           int& foundComponentType,
                                           int& foundComponentIndex,
                                           double& closestDistance2,
                                           HandleInfo& handleInfo);
  virtual void CanInteractWithArrowHandle(vtkMRMLInteractionEventData* interactionEventData,
                                          int& foundComponentType,
                                          int& foundComponentIndex,
                                          double& closestDistance2,
                                          HandleInfo& handleInfo);
  virtual void CanInteractWithRingHandle(vtkMRMLInteractionEventData* interactionEventData,
                                         int& foundComponentType,
                                         int& foundComponentIndex,
                                         double& closestDistance2,
                                         HandleInfo& handleInfo);

  double StartFadeAngleDegrees{ 10.0 };
  double EndFadeAngleDegrees{ 8.0 };
 
  double ViewScaleFactorMmPerPixel;
  double ScreenSizePixel; // diagonal size of the screen
 
  vtkSmartPointer<vtkPlane> SlicePlane;

  double InteractionSize{ 1.0 };
 
  double WidgetScale{ 1.0 };
 
  bool CachedParallelProjection{ true };
  double CachedCameraPosition[3]{ 0.0, 0.0, 0.0 };
  double CachedCameraDirection[3]{ 0.0, 0.0, 1.0 };
  double CachedViewUp_World[3]{ 0.0, 1.0, 0.0 };

  struct RenderState
  {
    vtkMTimeType RepresentationMTime{ 0 };
    vtkMTimeType SliceXYToRASMTime{ 0 };
    double CameraPosition[3]{ 0.0, 0.0, 0.0 };
    double CameraDirectionOfProjection[3]{ 0.0, 0.0, 0.0 };
    double CameraViewUp[3]{ 0.0, 0.0, 0.0 };
    double CameraParallelScale{ 0.0 };
    double CameraViewAngle{ 0.0 };
    bool CameraParallelProjection{ false };
    int RendererSize[2]{ 0, 0 };
    int ScreenSize[2]{ 0, 0 };
    int ActiveComponentType{ -1 };
    int ActiveComponentIndex{ -1 };
 
    bool operator==(const RenderState& other) const;
    bool operator!=(const RenderState& other) const { return !(*this == other); }
  };

  RenderState GetCurrentRenderState();

  bool UpdatePipelineIfNeeded();
 
  RenderState LastRenderState;
  bool HasVisibleHandles{ false };
 
  bool Interacting{ false };
 
  vtkSmartPointer<vtkPointPlacer> PointPlacer;
 
  virtual void SetupInteractionPipeline();
  InteractionPipeline* Pipeline;

  static std::map<vtkRenderer*, std::unique_ptr<SharedHandleRenderer>> SharedHandleRenderers;
  static SharedHandleRenderer* GetSharedHandleRenderer(vtkRenderer* renderer, bool create = false);
  static void OnSharedRendererStartEvent(vtkObject* caller, unsigned long eid, void* clientData, void* callData);
  static void OnSharedRendererDelete(vtkObject* caller, unsigned long eid, void* clientData, void* callData);
  void RegisterWithSharedHandleRenderer();
  void UnregisterFromSharedHandleRenderer();
  bool IsSharedRenderingRepresentation(SharedHandleRenderer* shared) const;
  static void ConfigureHandleInstancePipeline(vtkSmartPointer<vtkPolyData>& instancePolyData,
                                              vtkSmartPointer<vtkFloatArray>& orientationArray,
                                              vtkSmartPointer<vtkFloatArray>& scaleArray,
                                              vtkSmartPointer<vtkIntArray>& sourceIndexArray,
                                              vtkSmartPointer<vtkUnsignedCharArray>& colorArray,
                                              vtkSmartPointer<vtkGlyph3DMapper>& mapper,
                                              vtkSmartPointer<vtkProperty>& property,
                                              vtkSmartPointer<vtkActor>& actor);
  static unsigned char ColorComponentToUChar(double c);
 
private:
  vtkMRMLInteractionWidgetRepresentation(const vtkMRMLInteractionWidgetRepresentation&) = delete;
  void operator=(const vtkMRMLInteractionWidgetRepresentation&) = delete;
};
 
#endif