vtkBiDimensionalRepresentation.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 vtkBiDimensionalRepresentation_h
#define vtkBiDimensionalRepresentation_h
 
#include "vtkInteractionWidgetsModule.h" // For export macro
#include "vtkWidgetRepresentation.h"
#include "vtkWrappingHints.h" // For VTK_MARSHALAUTO
 
VTK_ABI_NAMESPACE_BEGIN
class vtkHandleRepresentation;
 
class VTKINTERACTIONWIDGETS_EXPORT VTK_MARSHALAUTO vtkBiDimensionalRepresentation
  : public vtkWidgetRepresentation
{
public:
 
  vtkTypeMacro(vtkBiDimensionalRepresentation, vtkWidgetRepresentation);
  void PrintSelf(ostream& os, vtkIndent indent) override;
 
 
  virtual void SetPoint1WorldPosition(double pos[3]);
  virtual void SetPoint2WorldPosition(double pos[3]);
  virtual void SetPoint3WorldPosition(double pos[3]);
  virtual void SetPoint4WorldPosition(double pos[3]);
  virtual void GetPoint1WorldPosition(double pos[3]);
  virtual void GetPoint2WorldPosition(double pos[3]);
  virtual void GetPoint3WorldPosition(double pos[3]);
  virtual void GetPoint4WorldPosition(double pos[3]);
  virtual void SetPoint1DisplayPosition(double pos[3]);
  virtual void SetPoint2DisplayPosition(double pos[3]);
  virtual void SetPoint3DisplayPosition(double pos[3]);
  virtual void SetPoint4DisplayPosition(double pos[3]);
  virtual void GetPoint1DisplayPosition(double pos[3]);
  virtual void GetPoint2DisplayPosition(double pos[3]);
  virtual void GetPoint3DisplayPosition(double pos[3]);
  virtual void GetPoint4DisplayPosition(double pos[3]);
 
 
  vtkGetObjectMacro(Point1Representation, vtkHandleRepresentation);
  vtkGetObjectMacro(Point2Representation, vtkHandleRepresentation);
  vtkGetObjectMacro(Point3Representation, vtkHandleRepresentation);
  vtkGetObjectMacro(Point4Representation, vtkHandleRepresentation);
 
 
  vtkSetMacro(Line1Visibility, vtkTypeBool);
  vtkGetMacro(Line1Visibility, vtkTypeBool);
  vtkBooleanMacro(Line1Visibility, vtkTypeBool);
  vtkSetMacro(Line2Visibility, vtkTypeBool);
  vtkGetMacro(Line2Visibility, vtkTypeBool);
  vtkBooleanMacro(Line2Visibility, vtkTypeBool);
 
 
  void SetHandleRepresentation(vtkHandleRepresentation* handle);
  virtual void InstantiateHandleRepresentation();
 
 
  vtkSetClampMacro(Tolerance, int, 1, 100);
  vtkGetMacro(Tolerance, int);
 
  virtual double GetLength1();
 
  virtual double GetLength2();
 
 
  vtkSetStringMacro(LabelFormat);
  vtkGetStringMacro(LabelFormat);
 
  // Used to communicate about the state of the representation
  enum
  {
    Outside = 0,
    NearP1,
    NearP2,
    NearP3,
    NearP4,
    OnL1Inner,
    OnL1Outer,
    OnL2Inner,
    OnL2Outer,
    OnCenter
  };
 
 
  vtkSetMacro(ShowLabelAboveWidget, vtkTypeBool);
  vtkGetMacro(ShowLabelAboveWidget, vtkTypeBool);
  vtkBooleanMacro(ShowLabelAboveWidget, vtkTypeBool);
 
 
  void SetID(vtkIdType id);
  vtkGetMacro(ID, vtkIdType);
 
  virtual char* GetLabelText() = 0;
 
 
  virtual double* GetLabelPosition() = 0;
  virtual void GetLabelPosition(double pos[3]) = 0;
  virtual void GetWorldLabelPosition(double pos[3]) = 0;
 
 
  virtual void StartWidgetDefinition(double e[2]) = 0;
  virtual void Point2WidgetInteraction(double e[2]) = 0;
  virtual void Point3WidgetInteraction(double e[2]) = 0;
  virtual void StartWidgetManipulation(double e[2]) = 0;
 
protected:
  vtkBiDimensionalRepresentation();
  ~vtkBiDimensionalRepresentation() override;
 
  // Keep track if modifier is set
  int Modifier;
 
  // The handle and the rep used to close the handles
  vtkHandleRepresentation* HandleRepresentation;
  vtkHandleRepresentation* Point1Representation;
  vtkHandleRepresentation* Point2Representation;
  vtkHandleRepresentation* Point3Representation;
  vtkHandleRepresentation* Point4Representation;
 
  // Selection tolerance for the handles
  int Tolerance;
 
  // Visibility of the lines
  vtkTypeBool Line1Visibility;
  vtkTypeBool Line2Visibility;
 
  vtkIdType ID;
  int IDInitialized;
 
  // Internal variables
  double P1World[3];
  double P2World[3];
  double P3World[3];
  double P4World[3];
  double P21World[3];
  double P43World[3];
  double T21;
  double T43;
  double CenterWorld[3];
  double StartEventPositionWorld[4];
 
  // Format for printing the distance
  char* LabelFormat;
 
  // toggle to determine whether to place text above or below widget
  vtkTypeBool ShowLabelAboveWidget;
 
private:
  vtkBiDimensionalRepresentation(const vtkBiDimensionalRepresentation&) = delete;
  void operator=(const vtkBiDimensionalRepresentation&) = delete;
};
 
VTK_ABI_NAMESPACE_END
#endif