VTK  9.0.1
vtkAffineRepresentation2D.h
Go to the documentation of this file.
1 /*=========================================================================
2 
3  Program: Visualization Toolkit
4  Module: vtkAffineRepresentation2D.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 =========================================================================*/
41 #ifndef vtkAffineRepresentation2D_h
42 #define vtkAffineRepresentation2D_h
43 
45 #include "vtkInteractionWidgetsModule.h" // For export macro
46 
47 class vtkProperty2D;
48 class vtkActor2D;
50 class vtkPolyData;
51 class vtkPoints;
52 class vtkCellArray;
53 class vtkTextProperty;
54 class vtkLeaderActor2D;
55 class vtkTextMapper;
56 class vtkActor2D;
57 
58 class VTKINTERACTIONWIDGETS_EXPORT vtkAffineRepresentation2D : public vtkAffineRepresentation
59 {
60 public:
65 
67 
71  void PrintSelf(ostream& os, vtkIndent indent) override;
73 
75 
82  vtkSetClampMacro(BoxWidth, int, 10, VTK_INT_MAX);
83  vtkGetMacro(BoxWidth, int);
84  vtkSetClampMacro(CircleWidth, int, 10, VTK_INT_MAX);
85  vtkGetMacro(CircleWidth, int);
86  vtkSetClampMacro(AxesWidth, int, 10, VTK_INT_MAX);
87  vtkGetMacro(AxesWidth, int);
89 
91 
96  void SetOrigin(const double o[3]) { this->SetOrigin(o[0], o[1], o[2]); }
97  void SetOrigin(double ox, double oy, double oz);
98  vtkGetVector3Macro(Origin, double);
100 
109  void GetTransform(vtkTransform* t) override;
110 
112 
115  void SetProperty(vtkProperty2D*);
116  void SetSelectedProperty(vtkProperty2D*);
117  void SetTextProperty(vtkTextProperty*);
118  vtkGetObjectMacro(Property, vtkProperty2D);
119  vtkGetObjectMacro(SelectedProperty, vtkProperty2D);
120  vtkGetObjectMacro(TextProperty, vtkTextProperty);
122 
124 
129  vtkSetMacro(DisplayText, vtkTypeBool);
130  vtkGetMacro(DisplayText, vtkTypeBool);
131  vtkBooleanMacro(DisplayText, vtkTypeBool);
133 
135 
142  void PlaceWidget(double bounds[6]) override;
143  void StartWidgetInteraction(double eventPos[2]) override;
144  void WidgetInteraction(double eventPos[2]) override;
145  void EndWidgetInteraction(double eventPos[2]) override;
146  int ComputeInteractionState(int X, int Y, int modify = 0) override;
147  void BuildRepresentation() override;
149 
151 
154  void ShallowCopy(vtkProp* prop) override;
155  void GetActors2D(vtkPropCollection*) override;
156  void ReleaseGraphicsResources(vtkWindow*) override;
157  int RenderOverlay(vtkViewport* viewport) override;
159 
160 protected:
162  ~vtkAffineRepresentation2D() override;
163 
164  // Methods to manipulate the cursor
165  void Translate(double eventPos[2]);
166  void Scale(double eventPos[2]);
167  void Rotate(double eventPos[2]);
168  void Shear(double eventPos[2]);
169  void Highlight(int highlight) override;
170  void UpdateText(const char* text, double eventPos[2]);
171 
172  // The width of the widget in normalized viewport coordinates.
173  int BoxWidth;
176 
177  // Display text
179 
180  // Internal variables for bookkeeping (in display coordinates unless noted)
181  double CurrentWidth;
184 
185  // The internal transformation matrix
188  double Origin[4]; // the current origin in world coordinates
189  double DisplayOrigin[3]; // the current origin in display coordinates
190  double CurrentTranslation[3]; // translation this movement
191  double StartWorldPosition[4]; // Start event position converted to world
192  double StartAngle; // The starting angle (always positive)
193  double CurrentAngle;
194  double CurrentScale[2];
195  double CurrentShear[2];
196  void ApplyShear(); // helper method to apply shear to matrix
197 
198  // Properties used to control the appearance of selected objects and
199  // the manipulator in general.
203  void CreateDefaultProperties();
204  double Opacity;
206 
207  // Support picking
208  double LastEventPosition[2];
209 
210  // These are the classes that form the geometric representation -----------
211  // The label
214 
215  // The outer box
221 
227 
228  // The circle
234 
240 
241  // The translation axes
246 
247 private:
249  void operator=(const vtkAffineRepresentation2D&) = delete;
250 };
251 
252 #endif
abstract superclass for all actors, volumes and annotations
Definition: vtkProp.h:53
virtual void EndWidgetInteraction(double newEventPos[2])
virtual int ComputeInteractionState(int X, int Y, int modify=0)
abstract class for representing affine transformation widgets
abstract specification for Viewports
Definition: vtkViewport.h:44
void GetActors2D(vtkPropCollection *) override
virtual void StartWidgetInteraction(double eventPos[2])
#define VTK_INT_MAX
Definition: vtkType.h:155
a actor that draws 2D data
Definition: vtkActor2D.h:39
virtual void GetTransform(vtkTransform *t)=0
Retrieve a linear transform characterizing the affine transformation generated by this widget...
describes linear transformations via a 4x4 matrix
Definition: vtkTransform.h:54
concrete dataset represents vertices, lines, polygons, and triangle strips
Definition: vtkPolyData.h:84
void SetOrigin(const double o[3])
Specify the origin of the widget (in world coordinates).
virtual void BuildRepresentation()=0
Subclasses of vtkWidgetRepresentation must implement these methods.
2D text annotation
Definition: vtkTextMapper.h:47
an ordered list of Props
int vtkTypeBool
Definition: vtkABI.h:69
window superclass for vtkRenderWindow
Definition: vtkWindow.h:37
void ShallowCopy(vtkProp *prop) override
Methods to make this class properly act like a vtkWidgetRepresentation.
a simple class to control print indentation
Definition: vtkIndent.h:33
create a leader with optional label and arrows
void ReleaseGraphicsResources(vtkWindow *) override
WARNING: INTERNAL METHOD - NOT INTENDED FOR GENERAL USE Release any graphics resources that are being...
virtual void WidgetInteraction(double newEventPos[2])
represent 2D affine transformations
represent text properties.
int RenderOverlay(vtkViewport *vtkNotUsed(viewport)) override
object to represent cell connectivity
Definition: vtkCellArray.h:179
virtual void PlaceWidget(double *vtkNotUsed(bounds[6]))
The following is a suggested API for widget representations.
virtual void Highlight(int vtkNotUsed(highlightOn))
void PrintSelf(ostream &os, vtkIndent indent) override
Standard methods for instances of this class.
represent surface properties of a 2D image
Definition: vtkProperty2D.h:37
static vtkObject * New()
Create an object with Debug turned off, modified time initialized to zero, and reference counting on...
draw vtkPolyData onto the image plane
represent and manipulate 3D points
Definition: vtkPoints.h:33