VTK
vtkBiDimensionalRepresentation.h
Go to the documentation of this file.
1 /*=========================================================================
2 
3  Program: Visualization Toolkit
4  Module: vtkBiDimensionalRepresentation.h
5 
6  Copyright (c) Ken Martin, Will Schroeder, Bill Lorensen
7  All rights reserved.
8  See Copyright.txt or http://www.kitware.com/Copyright.htm for details.
9 
10  This software is distributed WITHOUT ANY WARRANTY; without even
11  the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR
12  PURPOSE. See the above copyright notice for more information.
13 
14 =========================================================================*/
43 #ifndef vtkBiDimensionalRepresentation_h
44 #define vtkBiDimensionalRepresentation_h
45 
46 #include "vtkInteractionWidgetsModule.h" // For export macro
48 
50 
51 
52 class VTKINTERACTIONWIDGETS_EXPORT vtkBiDimensionalRepresentation : public vtkWidgetRepresentation
53 {
54 public:
56 
60  void PrintSelf(ostream& os, vtkIndent indent) override;
62 
64 
69  virtual void SetPoint1WorldPosition(double pos[3]);
70  virtual void SetPoint2WorldPosition(double pos[3]);
71  virtual void SetPoint3WorldPosition(double pos[3]);
72  virtual void SetPoint4WorldPosition(double pos[3]);
73  virtual void GetPoint1WorldPosition(double pos[3]);
74  virtual void GetPoint2WorldPosition(double pos[3]);
75  virtual void GetPoint3WorldPosition(double pos[3]);
76  virtual void GetPoint4WorldPosition(double pos[3]);
77  virtual void SetPoint1DisplayPosition(double pos[3]);
78  virtual void SetPoint2DisplayPosition(double pos[3]);
79  virtual void SetPoint3DisplayPosition(double pos[3]);
80  virtual void SetPoint4DisplayPosition(double pos[3]);
81  virtual void GetPoint1DisplayPosition(double pos[3]);
82  virtual void GetPoint2DisplayPosition(double pos[3]);
83  virtual void GetPoint3DisplayPosition(double pos[3]);
84  virtual void GetPoint4DisplayPosition(double pos[3]);
86 
88 
94  vtkGetObjectMacro(Point1Representation,vtkHandleRepresentation);
95  vtkGetObjectMacro(Point2Representation,vtkHandleRepresentation);
96  vtkGetObjectMacro(Point3Representation,vtkHandleRepresentation);
97  vtkGetObjectMacro(Point4Representation,vtkHandleRepresentation);
99 
101 
107  vtkSetMacro(Line1Visibility,vtkTypeBool);
108  vtkGetMacro(Line1Visibility,vtkTypeBool);
109  vtkBooleanMacro(Line1Visibility,vtkTypeBool);
110  vtkSetMacro(Line2Visibility,vtkTypeBool);
111  vtkGetMacro(Line2Visibility,vtkTypeBool);
112  vtkBooleanMacro(Line2Visibility,vtkTypeBool);
114 
116 
130 
132 
137  vtkSetClampMacro(Tolerance,int,1,100);
138  vtkGetMacro(Tolerance,int);
140 
145  virtual double GetLength1();
146 
151  virtual double GetLength2();
152 
154 
159  vtkSetStringMacro(LabelFormat);
160  vtkGetStringMacro(LabelFormat);
162 
163  // Used to communicate about the state of the representation
164  enum {Outside=0,NearP1,NearP2,NearP3,NearP4,OnL1Inner,OnL1Outer,OnL2Inner,OnL2Outer,OnCenter};
165 
167 
171  vtkSetMacro(ShowLabelAboveWidget, vtkTypeBool);
172  vtkGetMacro(ShowLabelAboveWidget, vtkTypeBool);
173  vtkBooleanMacro(ShowLabelAboveWidget, vtkTypeBool);
175 
177 
180  void SetID(vtkIdType id);
181  vtkGetMacro(ID, vtkIdType);
183 
187  virtual char* GetLabelText() = 0;
188 
190 
193  virtual double* GetLabelPosition() = 0;
194  virtual void GetLabelPosition(double pos[3]) = 0;
195  virtual void GetWorldLabelPosition(double pos[3]) = 0;
197 
199 
202  virtual void StartWidgetDefinition(double e[2]) = 0;
203  virtual void Point2WidgetInteraction(double e[2]) = 0;
204  virtual void Point3WidgetInteraction(double e[2]) = 0;
205  virtual void StartWidgetManipulation(double e[2]) = 0;
207 
208 protected:
211 
212  // Keep track if modifier is set
213  int Modifier;
214 
215  // The handle and the rep used to close the handles
221 
222  // Selection tolerance for the handles
224 
225  // Visibility of the lines
228 
231 
232  // Internal variables
233  double P1World[3];
234  double P2World[3];
235  double P3World[3];
236  double P4World[3];
237  double P21World[3];
238  double P43World[3];
239  double T21;
240  double T43;
241  double CenterWorld[3];
242  double StartEventPositionWorld[4];
243 
244  // Format for printing the distance
245  char *LabelFormat;
246 
247  // toggle to determine whether to place text above or below widget
249 
250 private:
252  void operator=(const vtkBiDimensionalRepresentation&) = delete;
253 };
254 
255 #endif
vtkBiDimensionalRepresentation::GetPoint3DisplayPosition
virtual void GetPoint3DisplayPosition(double pos[3])
vtkWidgetRepresentation.h
vtkBiDimensionalRepresentation::SetPoint1DisplayPosition
virtual void SetPoint1DisplayPosition(double pos[3])
vtkBiDimensionalRepresentation::SetPoint4WorldPosition
virtual void SetPoint4WorldPosition(double pos[3])
vtkIdType
int vtkIdType
Definition: vtkType.h:347
vtkBiDimensionalRepresentation::GetLength2
virtual double GetLength2()
Return the length of the line defined by (Point3,Point4).
vtkBiDimensionalRepresentation::ShowLabelAboveWidget
vtkTypeBool ShowLabelAboveWidget
Definition: vtkBiDimensionalRepresentation.h:248
vtkBiDimensionalRepresentation::GetWorldLabelPosition
virtual void GetWorldLabelPosition(double pos[3])=0
vtkBiDimensionalRepresentation::GetPoint4WorldPosition
virtual void GetPoint4WorldPosition(double pos[3])
vtkBiDimensionalRepresentation::InstantiateHandleRepresentation
virtual void InstantiateHandleRepresentation()
vtkBiDimensionalRepresentation::IDInitialized
int IDInitialized
Definition: vtkBiDimensionalRepresentation.h:230
vtkWidgetRepresentation
abstract class defines interface between the widget and widget representation classes
Definition: vtkWidgetRepresentation.h:61
vtkHandleRepresentation
abstract class for representing widget handles
Definition: vtkHandleRepresentation.h:59
vtkBiDimensionalRepresentation::HandleRepresentation
vtkHandleRepresentation * HandleRepresentation
Definition: vtkBiDimensionalRepresentation.h:216
vtkBiDimensionalRepresentation::Line2Visibility
vtkTypeBool Line2Visibility
Definition: vtkBiDimensionalRepresentation.h:227
vtkBiDimensionalRepresentation::GetPoint1WorldPosition
virtual void GetPoint1WorldPosition(double pos[3])
vtkBiDimensionalRepresentation::GetPoint3WorldPosition
virtual void GetPoint3WorldPosition(double pos[3])
vtkBiDimensionalRepresentation::GetPoint2WorldPosition
virtual void GetPoint2WorldPosition(double pos[3])
vtkBiDimensionalRepresentation::GetLabelPosition
virtual double * GetLabelPosition()=0
Get the position of the widget's label in display coordinates.
vtkBiDimensionalRepresentation::Point2WidgetInteraction
virtual void Point2WidgetInteraction(double e[2])=0
vtkBiDimensionalRepresentation::SetID
void SetID(vtkIdType id)
Set/get the id to display in the label.
vtkBiDimensionalRepresentation::SetHandleRepresentation
void SetHandleRepresentation(vtkHandleRepresentation *handle)
This method is used to specify the type of handle representation to use for the four internal vtkHand...
vtkBiDimensionalRepresentation::SetPoint2DisplayPosition
virtual void SetPoint2DisplayPosition(double pos[3])
vtkBiDimensionalRepresentation::StartWidgetDefinition
virtual void StartWidgetDefinition(double e[2])=0
These are methods that satisfy vtkWidgetRepresentation's API.
vtkBiDimensionalRepresentation::PrintSelf
void PrintSelf(ostream &os, vtkIndent indent) override
Methods invoked by print to print information about the object including superclasses.
vtkBiDimensionalRepresentation::Tolerance
int Tolerance
Definition: vtkBiDimensionalRepresentation.h:223
vtkBiDimensionalRepresentation::Point2Representation
vtkHandleRepresentation * Point2Representation
Definition: vtkBiDimensionalRepresentation.h:218
vtkBiDimensionalRepresentation::T21
double T21
Definition: vtkBiDimensionalRepresentation.h:239
vtkBiDimensionalRepresentation::SetPoint4DisplayPosition
virtual void SetPoint4DisplayPosition(double pos[3])
vtkIndent
a simple class to control print indentation
Definition: vtkIndent.h:40
vtkBiDimensionalRepresentation::Point4Representation
vtkHandleRepresentation * Point4Representation
Definition: vtkBiDimensionalRepresentation.h:220
vtkBiDimensionalRepresentation
represent the vtkBiDimensionalWidget
Definition: vtkBiDimensionalRepresentation.h:53
vtkBiDimensionalRepresentation::Line1Visibility
vtkTypeBool Line1Visibility
Definition: vtkBiDimensionalRepresentation.h:226
vtkBiDimensionalRepresentation::ID
vtkIdType ID
Definition: vtkBiDimensionalRepresentation.h:229
vtkBiDimensionalRepresentation::GetLabelText
virtual char * GetLabelText()=0
Get the text shown in the widget's label.
vtkBiDimensionalRepresentation::SetPoint1WorldPosition
virtual void SetPoint1WorldPosition(double pos[3])
Methods to Set/Get the coordinates of the four points defining this representation.
vtkBiDimensionalRepresentation::GetLength1
virtual double GetLength1()
Return the length of the line defined by (Point1,Point2).
vtkBiDimensionalRepresentation::StartWidgetManipulation
virtual void StartWidgetManipulation(double e[2])=0
vtkBiDimensionalRepresentation::SetPoint2WorldPosition
virtual void SetPoint2WorldPosition(double pos[3])
vtkBiDimensionalRepresentation::SetPoint3WorldPosition
virtual void SetPoint3WorldPosition(double pos[3])
vtkBiDimensionalRepresentation::GetPoint2DisplayPosition
virtual void GetPoint2DisplayPosition(double pos[3])
vtkBiDimensionalRepresentation::vtkBiDimensionalRepresentation
vtkBiDimensionalRepresentation()
vtkBiDimensionalRepresentation::GetPoint4DisplayPosition
virtual void GetPoint4DisplayPosition(double pos[3])
vtkBiDimensionalRepresentation::Modifier
int Modifier
Definition: vtkBiDimensionalRepresentation.h:213
vtkBiDimensionalRepresentation::LabelFormat
char * LabelFormat
Definition: vtkBiDimensionalRepresentation.h:245
vtkBiDimensionalRepresentation::Point3WidgetInteraction
virtual void Point3WidgetInteraction(double e[2])=0
vtkBiDimensionalRepresentation::Point1Representation
vtkHandleRepresentation * Point1Representation
Definition: vtkBiDimensionalRepresentation.h:217
vtkBiDimensionalRepresentation::SetPoint3DisplayPosition
virtual void SetPoint3DisplayPosition(double pos[3])
vtkBiDimensionalRepresentation::~vtkBiDimensionalRepresentation
~vtkBiDimensionalRepresentation() override
vtkBiDimensionalRepresentation::T43
double T43
Definition: vtkBiDimensionalRepresentation.h:240
vtkBiDimensionalRepresentation::GetLabelPosition
virtual void GetLabelPosition(double pos[3])=0
vtkTypeBool
int vtkTypeBool
Definition: vtkABI.h:69
vtkBiDimensionalRepresentation::Point3Representation
vtkHandleRepresentation * Point3Representation
Definition: vtkBiDimensionalRepresentation.h:219
vtkBiDimensionalRepresentation::GetPoint1DisplayPosition
virtual void GetPoint1DisplayPosition(double pos[3])