vtkDisplaySizedImplicitPlaneRepresentation.h

Go to the documentation of this file.

// SPDX-FileCopyrightText: Copyright (c) Ken Martin, Will Schroeder, Bill Lorensen
// SPDX-License-Identifier: BSD-3-Clause
 
#ifndef vtkDisplaySizedImplicitPlaneRepresentation_h
#define vtkDisplaySizedImplicitPlaneRepresentation_h
 
#include "vtkInteractionWidgetsModule.h" // For export macro
#include "vtkNew.h"                      // For vtkNew command
#include "vtkWidgetRepresentation.h"
#include "vtkWrappingHints.h" // For VTK_MARSHALAUTO
 
VTK_ABI_NAMESPACE_BEGIN
class vtkActor;
class vtkBox;
class vtkCellPicker;
class vtkConeSource;
class vtkCutter;
class vtkDiskSource;
class vtkFeatureEdges;
class vtkHardwarePicker;
class vtkImageData;
class vtkLineSource;
class vtkLookupTable;
class vtkOutlineFilter;
class vtkPlane;
class vtkPolyData;
class vtkPolyDataAlgorithm;
class vtkPolyDataMapper;
class vtkProperty;
class vtkSphereSource;
class vtkTransform;
class vtkTubeFilter;
 
class VTKINTERACTIONWIDGETS_EXPORT VTK_MARSHALAUTO vtkDisplaySizedImplicitPlaneRepresentation
  : public vtkWidgetRepresentation
{
public:
  static vtkDisplaySizedImplicitPlaneRepresentation* New();


  vtkTypeMacro(vtkDisplaySizedImplicitPlaneRepresentation, vtkWidgetRepresentation);
  void PrintSelf(ostream& os, vtkIndent indent) override;


  void SetOrigin(double x, double y, double z);
  void SetOrigin(double x[3]);
  double* GetOrigin() VTK_SIZEHINT(3);
  void GetOrigin(double xyz[3]);


  void SetNormal(double x, double y, double z);
  void SetNormal(double n[3]);
  void SetNormalToCamera();
  double* GetNormal() VTK_SIZEHINT(3);
  void GetNormal(double xyz[3]);


  void SetNormalToXAxis(vtkTypeBool);
  vtkGetMacro(NormalToXAxis, vtkTypeBool);
  vtkBooleanMacro(NormalToXAxis, vtkTypeBool);
  void SetNormalToYAxis(vtkTypeBool);
  vtkGetMacro(NormalToYAxis, vtkTypeBool);
  vtkBooleanMacro(NormalToYAxis, vtkTypeBool);
  void SetNormalToZAxis(vtkTypeBool);
  vtkGetMacro(NormalToZAxis, vtkTypeBool);
  vtkBooleanMacro(NormalToZAxis, vtkTypeBool);


  virtual void SetLockNormalToCamera(vtkTypeBool);
  vtkGetMacro(LockNormalToCamera, vtkTypeBool);
  vtkBooleanMacro(LockNormalToCamera, vtkTypeBool);


  virtual void SetRadiusMultiplier(double radiusMultiplier);
  virtual double GetRadiusMultiplierMinValue() { return 0.000001; }
  virtual double GetRadiusMultiplierMaxValue() { return VTK_DOUBLE_MAX; }
  vtkGetMacro(RadiusMultiplier, double);


  void SetDrawPlane(vtkTypeBool plane);
  vtkGetMacro(DrawPlane, vtkTypeBool);
  vtkBooleanMacro(DrawPlane, vtkTypeBool);


  void SetDrawOutline(vtkTypeBool outline);
  vtkGetMacro(DrawOutline, vtkTypeBool);
  vtkBooleanMacro(DrawOutline, vtkTypeBool);


  void SetDrawIntersectionEdges(vtkTypeBool intersectionEdges);
  vtkGetMacro(DrawIntersectionEdges, vtkTypeBool);
  vtkBooleanMacro(DrawIntersectionEdges, vtkTypeBool);


  vtkSetMacro(OutlineTranslation, vtkTypeBool);
  vtkGetMacro(OutlineTranslation, vtkTypeBool);
  vtkBooleanMacro(OutlineTranslation, vtkTypeBool);


  vtkSetMacro(OutsideBounds, vtkTypeBool);
  vtkGetMacro(OutsideBounds, vtkTypeBool);
  vtkBooleanMacro(OutsideBounds, vtkTypeBool);


  void SetXTranslationAxisOn() { this->TranslationAxis = Axis::XAxis; }
  void SetYTranslationAxisOn() { this->TranslationAxis = Axis::YAxis; }
  void SetZTranslationAxisOn() { this->TranslationAxis = Axis::ZAxis; }
  void SetTranslationAxisOff() { this->TranslationAxis = Axis::NONE; }


  bool IsTranslationConstrained() { return this->TranslationAxis != Axis::NONE; }


  vtkSetVector6Macro(WidgetBounds, double);
  vtkGetVector6Macro(WidgetBounds, double);


  vtkSetMacro(ConstrainToWidgetBounds, vtkTypeBool);
  vtkGetMacro(ConstrainToWidgetBounds, vtkTypeBool);
  vtkBooleanMacro(ConstrainToWidgetBounds, vtkTypeBool);


  vtkSetMacro(ConstrainMaximumSizeToWidgetBounds, vtkTypeBool);
  vtkGetMacro(ConstrainMaximumSizeToWidgetBounds, vtkTypeBool);
  vtkBooleanMacro(ConstrainMaximumSizeToWidgetBounds, vtkTypeBool);


  vtkSetMacro(ScaleEnabled, vtkTypeBool);
  vtkGetMacro(ScaleEnabled, vtkTypeBool);
  vtkBooleanMacro(ScaleEnabled, vtkTypeBool);

  void GetPolyData(vtkPolyData* pd);

  vtkPolyDataAlgorithm* GetPolyDataAlgorithm();

  VTK_MARSHALEXCLUDE(VTK_MARSHAL_EXCLUDE_REASON_IS_INTERNAL)
  void GetPlane(vtkPlane* plane);

  VTK_MARSHALEXCLUDE(VTK_MARSHAL_EXCLUDE_REASON_IS_INTERNAL)
  void SetPlane(vtkPlane* plane);

  void UpdatePlacement();


  vtkGetObjectMacro(NormalProperty, vtkProperty);
  vtkGetObjectMacro(SelectedNormalProperty, vtkProperty);


  vtkGetObjectMacro(SphereProperty, vtkProperty);
  vtkGetObjectMacro(SelectedSphereProperty, vtkProperty);


  vtkGetObjectMacro(PlaneProperty, vtkProperty);
  vtkGetObjectMacro(SelectedPlaneProperty, vtkProperty);


  vtkGetObjectMacro(OutlineProperty, vtkProperty);
  vtkGetObjectMacro(SelectedOutlineProperty, vtkProperty);


  vtkGetObjectMacro(EdgesProperty, vtkProperty);
  vtkGetObjectMacro(SelectedEdgesProperty, vtkProperty);


  vtkGetObjectMacro(IntersectionEdgesProperty, vtkProperty);


  void SetInteractionColor(double, double, double);
  void SetInteractionColor(double c[3]) { this->SetInteractionColor(c[0], c[1], c[2]); }
  void SetHandleColor(double, double, double);
  void SetHandleColor(double c[3]) { this->SetHandleColor(c[0], c[1], c[2]); }
  void SetForegroundColor(double, double, double);
  void SetForegroundColor(double c[3]) { this->SetForegroundColor(c[0], c[1], c[2]); }
 
  VTK_DEPRECATED_IN_9_3_0("Please use SetInteractionColor instead.")
  void SetSelectedWidgetColor(double a, double b, double c) { this->SetInteractionColor(a, b, c); }
  VTK_DEPRECATED_IN_9_3_0("Please use SetInteractionColor instead.")
  void SetSelectedWidgetColor(double c[3]) { this->SetInteractionColor(c); }
  VTK_DEPRECATED_IN_9_3_0("Please use SetHandleColor instead.")
  void SetUnselectedWidgetColor(double a, double b, double c) { this->SetHandleColor(a, b, c); }
  VTK_DEPRECATED_IN_9_3_0("Please use SetHandleColor instead.")
  void SetUnselectedWidgetColor(double c[3]) { this->SetHandleColor(c); }


  vtkSetClampMacro(BumpDistance, double, 0.000001, 1);
  vtkGetMacro(BumpDistance, double);

  void BumpPlane(int dir, double factor);

  void PushPlane(double distance);


  vtkGetMacro(PickCameraFocalInfo, bool);
  vtkSetMacro(PickCameraFocalInfo, bool);
  vtkBooleanMacro(PickCameraFocalInfo, bool);

  bool PickOrigin(int X, int Y, bool snapToMeshPoint = false);

  bool PickNormal(int X, int Y, bool snapToMeshPoint = false);


  int ComputeInteractionState(int X, int Y, int modify = 0) override;
  void PlaceWidget(double bounds[6]) override;
  void BuildRepresentation() override;
  void StartWidgetInteraction(double eventPos[2]) override;
  void WidgetInteraction(double newEventPos[2]) override;
  void EndWidgetInteraction(double newEventPos[2]) override;
  void StartComplexInteraction(vtkRenderWindowInteractor* iren, vtkAbstractWidget* widget,
    unsigned long event, void* calldata) override;
  void ComplexInteraction(vtkRenderWindowInteractor* iren, vtkAbstractWidget* widget,
    unsigned long event, void* calldata) override;
  int ComputeComplexInteractionState(vtkRenderWindowInteractor* iren, vtkAbstractWidget* widget,
    unsigned long event, void* calldata, int modify = 0) override;
  void EndComplexInteraction(vtkRenderWindowInteractor* iren, vtkAbstractWidget* widget,
    unsigned long event, void* calldata) override;


  double* GetBounds() VTK_SIZEHINT(6) override;
  void GetActors(vtkPropCollection* pc) override;
  void ReleaseGraphicsResources(vtkWindow*) override;
  int RenderOpaqueGeometry(vtkViewport*) override;
  int RenderTranslucentPolygonalGeometry(vtkViewport*) override;
  vtkTypeBool HasTranslucentPolygonalGeometry() override;
 
  // Manage the state of the widget
  enum InteractionStateType
  {
    Outside = 0,
    Moving,
    MovingOutline,
    MovingOrigin,
    Rotating,
    Pushing,
    ResizeDiskRadius,
    Scaling
  };


  vtkSetClampMacro(InteractionState, int, Outside, Scaling);


  virtual void SetRepresentationState(int);
  vtkGetMacro(RepresentationState, int);
 
  // Get the underlying implicit plane object used by this rep
  // that can be used as a cropping plane in vtkMapper.
  vtkPlane* GetUnderlyingPlane() { return this->Plane; }


  vtkGetMacro(SnapToAxes, bool);
  vtkSetMacro(SnapToAxes, bool);
  vtkBooleanMacro(SnapToAxes, bool);


  vtkGetMacro(AlwaysSnapToNearestAxis, bool);
  virtual void SetAlwaysSnapToNearestAxis(bool snap)
  {
    this->AlwaysSnapToNearestAxis = snap;
    this->SetNormal(this->GetNormal());
  }

 
protected:
  vtkDisplaySizedImplicitPlaneRepresentation();
  ~vtkDisplaySizedImplicitPlaneRepresentation() override;
 
  int RepresentationState;
 
  // Keep track of event positions
  double LastEventPosition[3];
  double LastEventOrientation[4];
  double StartEventOrientation[4];
 
  // Controlling ivars
  vtkTypeBool NormalToXAxis;
  vtkTypeBool NormalToYAxis;
  vtkTypeBool NormalToZAxis;
 
  double SnappedEventOrientation[4];
  bool SnappedOrientation;
  bool SnapToAxes;
 
  bool AlwaysSnapToNearestAxis;
 
  bool PickCameraFocalInfo;
 
  // Locking normal to camera
  vtkTypeBool LockNormalToCamera;
 
  // Controlling the push operation
  double BumpDistance;
 
  int TranslationAxis;
 
  // The bounding box is represented by a single voxel image data
  vtkNew<vtkImageData> Box;
  vtkNew<vtkOutlineFilter> Outline;
  vtkNew<vtkPolyDataMapper> OutlineMapper;
  vtkNew<vtkActor> OutlineActor;
  vtkTypeBool OutlineTranslation; // whether the outline can be moved
  vtkTypeBool ScaleEnabled;       // whether the widget can be scaled
  vtkTypeBool OutsideBounds;      // whether the widget can be moved outside input's bounds
  double WidgetBounds[6];
  vtkTypeBool ConstrainToWidgetBounds; // whether the widget can be moved outside input's bounds
  vtkTypeBool ConstrainMaximumSizeToWidgetBounds; // whether the maximum widget size is constrained
  vtkTypeBool DrawOutline;                        // whether to draw the outline
  void HighlightOutline(int highlight);
 
  // The plane
  double RadiusMultiplier;
  vtkNew<vtkPlane> Plane;
  vtkNew<vtkDiskSource> DiskPlaneSource;
  vtkNew<vtkPolyDataMapper> PlaneMapper;
  vtkNew<vtkActor> PlaneActor;
  vtkTypeBool DrawPlane;
  void HighlightPlane(int highlight);
 
  // plane boundary edges are represented as tubes
  vtkNew<vtkFeatureEdges> Edges;
  vtkNew<vtkTubeFilter> EdgesTuber;
  vtkNew<vtkPolyDataMapper> EdgesMapper;
  vtkNew<vtkActor> EdgesActor;
  void HighlightEdges(int highlight);


  void SetEdgesColor(vtkLookupTable*);
  void SetEdgesColor(double, double, double);
  void SetEdgesColor(double c[3]);
 
  // The intersection edges with the outline
  vtkNew<vtkCutter> Cutter;
  vtkNew<vtkFeatureEdges> IntersectionEdges;
  vtkNew<vtkTubeFilter> IntersectionEdgesTuber;
  vtkNew<vtkPolyDataMapper> IntersectionEdgesMapper;
  vtkNew<vtkActor> IntersectionEdgesActor;
  vtkTypeBool DrawIntersectionEdges;


  void SetIntersectionEdgesColor(vtkLookupTable*);
  void SetIntersectionEdgesColor(double, double, double);
  void SetIntersectionEdgesColor(double c[3]);
 
  // The + normal cone
  vtkNew<vtkConeSource> ConeSource;
  vtkNew<vtkPolyDataMapper> ConeMapper;
  vtkNew<vtkActor> ConeActor;
  void HighlightNormal(int highlight);
 
  // The normal line
  vtkNew<vtkLineSource> LineSource;
  vtkNew<vtkPolyDataMapper> LineMapper;
  vtkNew<vtkActor> LineActor;
 
  // The - normal cone
  vtkNew<vtkConeSource> ConeSource2;
  vtkNew<vtkPolyDataMapper> ConeMapper2;
  vtkNew<vtkActor> ConeActor2;
 
  // The origin positioning handle
  vtkNew<vtkSphereSource> Sphere;
  vtkNew<vtkPolyDataMapper> SphereMapper;
  vtkNew<vtkActor> SphereActor;
  void HighlightSphere(int highlight);
 
  // Do the picking
  vtkNew<vtkHardwarePicker> HardwarePicker; // Used for picking rendered props (screen)
  vtkNew<vtkCellPicker> CellPicker;         // Used for picking widget props (screen and VR)
  // Compute Cell Picker tolerance
  void ComputeAdaptivePickerTolerance();
 
  // Register internal Pickers within PickingManager
  void RegisterPickers() override;
 
  // Transform the normal (used for rotation)
  vtkNew<vtkTransform> Transform;
 
  // Methods to manipulate the plane
  void Rotate(double X, double Y, double* p1, double* p2, double* vpn);
  void Rotate3D(double* p1, double* p2);
  void TranslateOutline(double* p1, double* p2);
  void TranslateOrigin(double* p1, double* p2);
  void UpdatePose(double* p1, double* d1, double* p2, double* d2);
  void Push(double* p1, double* p2);
  void ResizeRadius(double* p1, double* p2, double* vpn);
  void ResizeRadius3D(double* p1, double* p2);
  void Scale(double* p1, double* p2, double X, double Y);
  void SizeHandles();
 
  // Properties used to control the appearance of selected objects and
  // the manipulator in general.
  vtkNew<vtkProperty> NormalProperty;
  vtkNew<vtkProperty> SelectedNormalProperty;
  vtkNew<vtkProperty> SphereProperty;
  vtkNew<vtkProperty> SelectedSphereProperty;
  vtkNew<vtkProperty> PlaneProperty;
  vtkNew<vtkProperty> SelectedPlaneProperty;
  vtkNew<vtkProperty> OutlineProperty;
  vtkNew<vtkProperty> SelectedOutlineProperty;
  vtkNew<vtkProperty> EdgesProperty;
  vtkNew<vtkProperty> SelectedEdgesProperty;
  vtkNew<vtkProperty> IntersectionEdgesProperty;
  virtual void CreateDefaultProperties();
 
  // Support GetBounds() method
  vtkNew<vtkBox> BoundingBox;
 
private:
  vtkDisplaySizedImplicitPlaneRepresentation(
    const vtkDisplaySizedImplicitPlaneRepresentation&) = delete;
  void operator=(const vtkDisplaySizedImplicitPlaneRepresentation&) = delete;
};
 
VTK_ABI_NAMESPACE_END
#endif