VTK
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 =========================================================================*/
44 #ifndef vtkAffineRepresentation2D_h
45 #define vtkAffineRepresentation2D_h
46 
47 #include "vtkInteractionWidgetsModule.h" // For export macro
49 
50 class vtkProperty2D;
51 class vtkActor2D;
53 class vtkPolyData;
54 class vtkPoints;
55 class vtkCellArray;
56 class vtkTextProperty;
57 class vtkLeaderActor2D;
58 class vtkTextMapper;
59 class vtkActor2D;
60 
61 
62 class VTKINTERACTIONWIDGETS_EXPORT vtkAffineRepresentation2D : public vtkAffineRepresentation
63 {
64 public:
69 
71 
75  void PrintSelf(ostream& os, vtkIndent indent) override;
77 
79 
86  vtkSetClampMacro(BoxWidth,int,10,VTK_INT_MAX);
87  vtkGetMacro(BoxWidth,int);
88  vtkSetClampMacro(CircleWidth,int,10,VTK_INT_MAX);
89  vtkGetMacro(CircleWidth,int);
90  vtkSetClampMacro(AxesWidth,int,10,VTK_INT_MAX);
91  vtkGetMacro(AxesWidth,int);
93 
95 
100  void SetOrigin(const double o[3]) {this->SetOrigin(o[0],o[1],o[2]);}
101  void SetOrigin(double ox, double oy, double oz);
102  vtkGetVector3Macro(Origin,double);
104 
113  void GetTransform(vtkTransform *t) override;
114 
116 
119  void SetProperty(vtkProperty2D*);
120  void SetSelectedProperty(vtkProperty2D*);
121  void SetTextProperty(vtkTextProperty*);
122  vtkGetObjectMacro(Property,vtkProperty2D);
123  vtkGetObjectMacro(SelectedProperty,vtkProperty2D);
124  vtkGetObjectMacro(TextProperty,vtkTextProperty);
126 
128 
133  vtkSetMacro(DisplayText,vtkTypeBool);
134  vtkGetMacro(DisplayText,vtkTypeBool);
135  vtkBooleanMacro(DisplayText,vtkTypeBool);
137 
139 
146  void PlaceWidget(double bounds[6]) override;
147  void StartWidgetInteraction(double eventPos[2]) override;
148  void WidgetInteraction(double eventPos[2]) override;
149  void EndWidgetInteraction(double eventPos[2]) override;
150  int ComputeInteractionState(int X, int Y, int modify=0) override;
151  void BuildRepresentation() override;
153 
155 
158  void ShallowCopy(vtkProp *prop) override;
159  void GetActors2D(vtkPropCollection *) override;
160  void ReleaseGraphicsResources(vtkWindow *) override;
161  int RenderOverlay(vtkViewport *viewport) override;
163 
164 protected:
166  ~vtkAffineRepresentation2D() override;
167 
168  // Methods to manipulate the cursor
169  void Translate(double eventPos[2]);
170  void Scale(double eventPos[2]);
171  void Rotate(double eventPos[2]);
172  void Shear(double eventPos[2]);
173  void Highlight(int highlight) override;
174  void UpdateText(const char *text, double eventPos[2]);
175 
176  // The width of the widget in normalized viewport coordinates.
177  int BoxWidth;
180 
181  // Display text
183 
184  // Internal variables for bookkeeping (in display coordinates unless noted)
185  double CurrentWidth;
188 
189  // The internal transformation matrix
192  double Origin[4]; //the current origin in world coordinates
193  double DisplayOrigin[3]; //the current origin in display coordinates
194  double CurrentTranslation[3]; //translation this movement
195  double StartWorldPosition[4]; //Start event position converted to world
196  double StartAngle; //The starting angle (always positive)
197  double CurrentAngle;
198  double CurrentScale[2];
199  double CurrentShear[2];
200  void ApplyShear(); //helper method to apply shear to matrix
201 
202  // Properties used to control the appearance of selected objects and
203  // the manipulator in general.
207  void CreateDefaultProperties();
208  double Opacity;
210 
211  // Support picking
212  double LastEventPosition[2];
213 
214  // These are the classes that form the geometric representation -----------
215  // The label
218 
219  // The outer box
225 
231 
232  // The circle
238 
244 
245  // The translation axes
250 
251 private:
253  void operator=(const vtkAffineRepresentation2D&) = delete;
254 };
255 
256 #endif
vtkPoints
represent and manipulate 3D points
Definition: vtkPoints.h:39
vtkAffineRepresentation2D::CircleMapper
vtkPolyDataMapper2D * CircleMapper
Definition: vtkAffineRepresentation2D.h:236
vtkAffineRepresentation2D::Box
vtkPolyData * Box
Definition: vtkAffineRepresentation2D.h:222
vtkWidgetRepresentation::StartWidgetInteraction
virtual void StartWidgetInteraction(double eventPos[2])
Definition: vtkWidgetRepresentation.h:136
vtkAffineRepresentation2D::Property
vtkProperty2D * Property
Definition: vtkAffineRepresentation2D.h:204
VTK_INT_MAX
#define VTK_INT_MAX
Definition: vtkType.h:159
vtkPolyDataMapper2D
draw vtkPolyData onto the image plane
Definition: vtkPolyDataMapper2D.h:51
vtkAffineRepresentation2D::BoxActor
vtkActor2D * BoxActor
Definition: vtkAffineRepresentation2D.h:224
vtkAffineRepresentation2D::HXAxis
vtkLeaderActor2D * HXAxis
Definition: vtkAffineRepresentation2D.h:248
vtkWidgetRepresentation::EndWidgetInteraction
virtual void EndWidgetInteraction(double newEventPos[2])
Definition: vtkWidgetRepresentation.h:138
vtkAffineRepresentation2D::AxesWidth
int AxesWidth
Definition: vtkAffineRepresentation2D.h:179
vtkAffineRepresentation2D::CircleActor
vtkActor2D * CircleActor
Definition: vtkAffineRepresentation2D.h:237
vtkObject::New
static vtkObject * New()
Create an object with Debug turned off, modified time initialized to zero, and reference counting on.
vtkAffineRepresentation::GetTransform
virtual void GetTransform(vtkTransform *t)=0
Retrieve a linear transform characterizing the affine transformation generated by this widget.
vtkAffineRepresentation2D::BoxMapper
vtkPolyDataMapper2D * BoxMapper
Definition: vtkAffineRepresentation2D.h:223
vtkAffineRepresentation2D::HBoxMapper
vtkPolyDataMapper2D * HBoxMapper
Definition: vtkAffineRepresentation2D.h:229
vtkAffineRepresentation2D::CircleCellArray
vtkCellArray * CircleCellArray
Definition: vtkAffineRepresentation2D.h:234
vtkAffineRepresentation2D::DisplayText
vtkTypeBool DisplayText
Definition: vtkAffineRepresentation2D.h:182
vtkAffineRepresentation2D::CurrentWidth
double CurrentWidth
Definition: vtkAffineRepresentation2D.h:185
vtkAffineRepresentation2D::SetOrigin
void SetOrigin(const double o[3])
Specify the origin of the widget (in world coordinates).
Definition: vtkAffineRepresentation2D.h:100
vtkAffineRepresentation2D::TextProperty
vtkTextProperty * TextProperty
Definition: vtkAffineRepresentation2D.h:206
vtkWidgetRepresentation::BuildRepresentation
virtual void BuildRepresentation()=0
vtkWidgetRepresentation::GetActors2D
void GetActors2D(vtkPropCollection *) override
Definition: vtkWidgetRepresentation.h:218
vtkTransform
describes linear transformations via a 4x4 matrix
Definition: vtkTransform.h:60
vtkAffineRepresentation::Rotate
Definition: vtkAffineRepresentation.h:81
vtkAffineRepresentation2D::HCircleCellArray
vtkCellArray * HCircleCellArray
Definition: vtkAffineRepresentation2D.h:240
vtkAffineRepresentation2D::TextMapper
vtkTextMapper * TextMapper
Definition: vtkAffineRepresentation2D.h:216
vtkAffineRepresentation2D::HCirclePoints
vtkPoints * HCirclePoints
Definition: vtkAffineRepresentation2D.h:239
vtkWindow
window superclass for vtkRenderWindow
Definition: vtkWindow.h:37
vtkAffineRepresentation2D::TotalTransform
vtkTransform * TotalTransform
Definition: vtkAffineRepresentation2D.h:191
vtkWidgetRepresentation::ReleaseGraphicsResources
void ReleaseGraphicsResources(vtkWindow *) override
WARNING: INTERNAL METHOD - NOT INTENDED FOR GENERAL USE Release any graphics resources that are being...
Definition: vtkWidgetRepresentation.h:220
vtkAffineRepresentation2D::SelectedProperty
vtkProperty2D * SelectedProperty
Definition: vtkAffineRepresentation2D.h:205
vtkAffineRepresentation2D::HBoxActor
vtkActor2D * HBoxActor
Definition: vtkAffineRepresentation2D.h:230
vtkAffineRepresentation2D::HBoxPoints
vtkPoints * HBoxPoints
Definition: vtkAffineRepresentation2D.h:226
vtkAffineRepresentation.h
vtkWidgetRepresentation::WidgetInteraction
virtual void WidgetInteraction(double newEventPos[2])
Definition: vtkWidgetRepresentation.h:137
vtkAffineRepresentation
abstract class for representing affine transformation widgets
Definition: vtkAffineRepresentation.h:47
vtkAffineRepresentation2D::XAxis
vtkLeaderActor2D * XAxis
Definition: vtkAffineRepresentation2D.h:246
vtkTextMapper
2D text annotation
Definition: vtkTextMapper.h:53
vtkAffineRepresentation2D::CircleWidth
int CircleWidth
Definition: vtkAffineRepresentation2D.h:178
vtkAffineRepresentation::ShallowCopy
void ShallowCopy(vtkProp *prop) override
Methods to make this class properly act like a vtkWidgetRepresentation.
vtkAffineRepresentation::Translate
Definition: vtkAffineRepresentation.h:81
vtkAffineRepresentation2D::Circle
vtkPolyData * Circle
Definition: vtkAffineRepresentation2D.h:235
vtkAffineRepresentation2D::HCircleActor
vtkActor2D * HCircleActor
Definition: vtkAffineRepresentation2D.h:243
vtkIndent
a simple class to control print indentation
Definition: vtkIndent.h:39
vtkAffineRepresentation2D::BoxCellArray
vtkCellArray * BoxCellArray
Definition: vtkAffineRepresentation2D.h:221
vtkCellArray
object to represent cell connectivity
Definition: vtkCellArray.h:50
vtkAffineRepresentation2D::SelectedOpacity
double SelectedOpacity
Definition: vtkAffineRepresentation2D.h:209
vtkAffineRepresentation2D::HCircle
vtkPolyData * HCircle
Definition: vtkAffineRepresentation2D.h:241
vtkAffineRepresentation2D::BoxWidth
int BoxWidth
Definition: vtkAffineRepresentation2D.h:177
vtkAffineRepresentation2D::BoxPoints
vtkPoints * BoxPoints
Definition: vtkAffineRepresentation2D.h:220
vtkViewport
abstract specification for Viewports
Definition: vtkViewport.h:47
vtkTextProperty
represent text properties.
Definition: vtkTextProperty.h:39
vtkProp
abstract superclass for all actors, volumes and annotations
Definition: vtkProp.h:52
vtkAffineRepresentation2D::TextActor
vtkActor2D * TextActor
Definition: vtkAffineRepresentation2D.h:217
vtkWidgetRepresentation::PlaceWidget
virtual void PlaceWidget(double *vtkNotUsed(bounds[6]))
The following is a suggested API for widget representations.
Definition: vtkWidgetRepresentation.h:135
vtkProperty2D
represent surface properties of a 2D image
Definition: vtkProperty2D.h:40
vtkAffineRepresentation2D::CirclePoints
vtkPoints * CirclePoints
Definition: vtkAffineRepresentation2D.h:233
vtkActor2D
a actor that draws 2D data
Definition: vtkActor2D.h:45
vtkWidgetRepresentation::RenderOverlay
int RenderOverlay(vtkViewport *vtkNotUsed(viewport)) override
Definition: vtkWidgetRepresentation.h:221
vtkAffineRepresentation2D::CurrentAngle
double CurrentAngle
Definition: vtkAffineRepresentation2D.h:197
vtkAffineRepresentation2D::HYAxis
vtkLeaderActor2D * HYAxis
Definition: vtkAffineRepresentation2D.h:249
vtkAffineRepresentation2D::Opacity
double Opacity
Definition: vtkAffineRepresentation2D.h:208
vtkAffineRepresentation2D::HCircleMapper
vtkPolyDataMapper2D * HCircleMapper
Definition: vtkAffineRepresentation2D.h:242
vtkAffineRepresentation2D::CurrentTransform
vtkTransform * CurrentTransform
Definition: vtkAffineRepresentation2D.h:190
vtkPolyData
concrete dataset represents vertices, lines, polygons, and triangle strips
Definition: vtkPolyData.h:85
vtkAffineRepresentation2D::YAxis
vtkLeaderActor2D * YAxis
Definition: vtkAffineRepresentation2D.h:247
vtkAffineRepresentation2D::HBoxCellArray
vtkCellArray * HBoxCellArray
Definition: vtkAffineRepresentation2D.h:227
vtkAffineRepresentation2D::HBox
vtkPolyData * HBox
Definition: vtkAffineRepresentation2D.h:228
vtkAffineRepresentation2D::StartAngle
double StartAngle
Definition: vtkAffineRepresentation2D.h:196
vtkAffineRepresentation2D
represent 2D affine transformations
Definition: vtkAffineRepresentation2D.h:62
vtkAffineRepresentation::PrintSelf
void PrintSelf(ostream &os, vtkIndent indent) override
Methods invoked by print to print information about the object including superclasses.
vtkAffineRepresentation2D::CurrentRadius
double CurrentRadius
Definition: vtkAffineRepresentation2D.h:186
vtkPropCollection
an ordered list of Props
Definition: vtkPropCollection.h:41
vtkLeaderActor2D
create a leader with optional label and arrows
Definition: vtkLeaderActor2D.h:59
vtkTypeBool
int vtkTypeBool
Definition: vtkABI.h:69
vtkWidgetRepresentation::ComputeInteractionState
virtual int ComputeInteractionState(int X, int Y, int modify=0)
vtkWidgetRepresentation::Highlight
virtual void Highlight(int vtkNotUsed(highlightOn))
Definition: vtkWidgetRepresentation.h:142
vtkAffineRepresentation2D::CurrentAxesWidth
double CurrentAxesWidth
Definition: vtkAffineRepresentation2D.h:187