vtkFinitePlaneRepresentation.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 vtkFinitePlaneRepresentation_h
#define vtkFinitePlaneRepresentation_h
 
#include "vtkDeprecation.h"              // For VTK_DEPRECATED_IN_9_2_0
#include "vtkInteractionWidgetsModule.h" // For export macro
#include "vtkLegacy.h"                   // for VTK_LEGACY_REMOVE
#include "vtkWidgetRepresentation.h"
 
VTK_ABI_NAMESPACE_BEGIN
class vtkActor;
class vtkBox;
class vtkCellPicker;
class vtkConeSource;
class vtkFeatureEdges;
class vtkLineSource;
class vtkPolyData;
class vtkPolyDataMapper;
class vtkProperty;
class vtkSphereSource;
class vtkTransform;
class vtkTubeFilter;
 
class VTKINTERACTIONWIDGETS_EXPORT vtkFinitePlaneRepresentation : public vtkWidgetRepresentation
{
public:
  static vtkFinitePlaneRepresentation* New();
 
 
  vtkTypeMacro(vtkFinitePlaneRepresentation, vtkWidgetRepresentation);
  void PrintSelf(ostream& os, vtkIndent indent) override;
 
  void GetPolyData(vtkPolyData* pd);
 
 
  vtkGetObjectMacro(V1HandleProperty, vtkProperty);
  vtkGetObjectMacro(V2HandleProperty, vtkProperty);
  vtkGetObjectMacro(SelectedHandleProperty, vtkProperty);
 
 
  vtkGetObjectMacro(PlaneProperty, vtkProperty);
  vtkGetObjectMacro(SelectedPlaneProperty, vtkProperty);
 
 
  vtkSetMacro(Tubing, bool);
  vtkGetMacro(Tubing, bool);
  vtkBooleanMacro(Tubing, bool);
 
 
  void SetDrawPlane(bool plane);
  vtkGetMacro(DrawPlane, bool);
  vtkBooleanMacro(DrawPlane, bool);
 
 
  void SetHandles(bool handles);
  virtual void HandlesOn();
  virtual void HandlesOff();
 
 
  void PlaceWidget(double bounds[6]) override;
  void BuildRepresentation() override;
  int ComputeInteractionState(int X, int Y, int modify = 0) override;
  void StartWidgetInteraction(double e[2]) override;
  void WidgetInteraction(double e[2]) override;
  double* GetBounds() override;
 
 
  void ReleaseGraphicsResources(vtkWindow*) override;
  int RenderOpaqueGeometry(vtkViewport*) override;
  int RenderTranslucentPolygonalGeometry(vtkViewport*) override;
  vtkTypeBool HasTranslucentPolygonalGeometry() override;
 
  vtkSetClampMacro(InteractionState, int, Outside, Pushing);
 
 
  void SetOrigin(double x, double y, double z);
  void SetOrigin(double x[3]);
  vtkGetVector3Macro(Origin, double);
 
 
  void SetNormal(double x, double y, double z);
  void SetNormal(double n[3]);
  vtkGetVector3Macro(Normal, double);
 
 
  void SetV1(double x, double y);
  void SetV1(double x[2]);
  vtkGetVector2Macro(V1, double);
 
 
  void SetV2(double x, double y);
  void SetV2(double x[2]);
  vtkGetVector2Macro(V2, double);
 
 
  virtual void SetRepresentationState(int);
  vtkGetMacro(RepresentationState, int);
 
 
  vtkGetObjectMacro(NormalProperty, vtkProperty);
  vtkGetObjectMacro(SelectedNormalProperty, vtkProperty);
 
  // Methods to manipulate the plane
  void TranslateOrigin(double* p1, double* p2);
  void MovePoint1(double* p1, double* p2);
  void MovePoint2(double* p1, double* p2);
  void Push(double* p1, double* p2);
  void Rotate(int X, int Y, double* p1, double* p2, double* vpn);
 
  enum InteractionStateType
  {
    Outside = 0,
    MoveOrigin,
    ModifyV1,
    ModifyV2,
    Moving,
    Rotating,
    Pushing
  };
#if !defined(VTK_LEGACY_REMOVE)
  VTK_DEPRECATED_IN_9_2_0("because leading underscore is reserved")
  typedef InteractionStateType _InteractionState;
#endif
 
  /*
   * Register internal Pickers within PickingManager
   */
  void RegisterPickers() override;
 
protected:
  vtkFinitePlaneRepresentation();
  ~vtkFinitePlaneRepresentation() override;
 
  virtual void CreateDefaultProperties();
 
  // Size the glyphs representing hot spots (e.g., handles)
  virtual void SizeHandles();
 
  void SetHighlightNormal(int highlight);
  void SetHighlightPlane(int highlight);
  void SetHighlightHandle(vtkProp* prop);
 
  double LastEventPosition[3];
 
  // the representation state
  int RepresentationState;
 
  // the origin
  vtkSphereSource* OriginGeometry;
  vtkPolyDataMapper* OriginMapper;
  vtkActor* OriginActor;
  double Origin[3];
 
  // the normal
  double Normal[3];
 
  // the previous normal
  double PreviousNormal[3];
 
  // the rotation transform
  vtkTransform* Transform;
 
  // the X Vector
  vtkSphereSource* V1Geometry;
  vtkPolyDataMapper* V1Mapper;
  vtkActor* V1Actor;
  double V1[3];
 
  // the Y Vector
  vtkSphereSource* V2Geometry;
  vtkPolyDataMapper* V2Mapper;
  vtkActor* V2Actor;
  double V2[3];
 
  // The + normal cone
  vtkConeSource* ConeSource;
  vtkPolyDataMapper* ConeMapper;
  vtkActor* ConeActor;
 
  // The + normal line
  vtkLineSource* LineSource;
  vtkPolyDataMapper* LineMapper;
  vtkActor* LineActor;
 
  // The - normal cone
  vtkConeSource* ConeSource2;
  vtkPolyDataMapper* ConeMapper2;
  vtkActor* ConeActor2;
 
  // The - normal line
  vtkLineSource* LineSource2;
  vtkPolyDataMapper* LineMapper2;
  vtkActor* LineActor2;
 
  // The finite plane
  vtkPolyData* PlanePolyData;
  vtkPolyDataMapper* PlaneMapper;
  vtkActor* PlaneActor;
 
  // Optional tubes are represented by extracting boundary edges
  vtkFeatureEdges* Edges;
  vtkTubeFilter* EdgesTuber;
  vtkPolyDataMapper* EdgesMapper;
  vtkActor* EdgesActor;
  bool Tubing;    // control whether tubing is on
  bool DrawPlane; // control whether plane is on
 
  // Picking objects
  vtkCellPicker* HandlePicker;
  vtkActor* CurrentHandle;
 
  // Transform the planes (used for rotations)
  vtkTransform* TransformRotation;
 
  // Support GetBounds() method
  vtkBox* BoundingBox;
 
  // Properties used to control the appearance of selected objects and
  // the manipulator in general.
  vtkProperty* OriginHandleProperty;
  vtkProperty* V1HandleProperty;
  vtkProperty* V2HandleProperty;
  vtkProperty* SelectedHandleProperty;
  vtkProperty* PlaneProperty;
  vtkProperty* SelectedPlaneProperty;
  vtkProperty* NormalProperty;
  vtkProperty* SelectedNormalProperty;
 
private:
  vtkFinitePlaneRepresentation(const vtkFinitePlaneRepresentation&) = delete;
  void operator=(const vtkFinitePlaneRepresentation&) = delete;
};
 
VTK_ABI_NAMESPACE_END
#endif