forked from Kitware/VTK
-
Notifications
You must be signed in to change notification settings - Fork 0
/
vtkBorderRepresentation.h
436 lines (386 loc) · 13.1 KB
/
vtkBorderRepresentation.h
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
/*=========================================================================
Program: Visualization Toolkit
Module: vtkBorderRepresentation.h
Copyright (c) Ken Martin, Will Schroeder, Bill Lorensen
All rights reserved.
See Copyright.txt or http://www.kitware.com/Copyright.htm for details.
This software is distributed WITHOUT ANY WARRANTY; without even
the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR
PURPOSE. See the above copyright notice for more information.
=========================================================================*/
/**
* @class vtkBorderRepresentation
* @brief represent a vtkBorderWidget
*
* This class is used to represent and render a vtBorderWidget. To
* use this class, you need to specify the two corners of a rectangular
* region.
*
* The class is typically subclassed so that specialized representations can
* be created. The class defines an API and a default implementation that
* the vtkBorderRepresentation interacts with to render itself in the scene.
*
* @warning
* The separation of the widget event handling (e.g., vtkBorderWidget) from
* the representation (vtkBorderRepresentation) enables users and developers
* to create new appearances for the widget. It also facilitates parallel
* processing, where the client application handles events, and remote
* representations of the widget are slaves to the client (and do not handle
* events).
*
* @sa
* vtkBorderWidget vtkTextWidget
*/
#ifndef vtkBorderRepresentation_h
#define vtkBorderRepresentation_h
#include "vtkCoordinate.h" //Because of the viewport coordinate macro
#include "vtkInteractionWidgetsModule.h" // For export macro
#include "vtkWidgetRepresentation.h"
#include "vtkNew.h" // for ivars
class vtkPoints;
class vtkPolyData;
class vtkTransform;
class vtkTransformPolyDataFilter;
class vtkPolyDataMapper2D;
class vtkActor2D;
class vtkProperty2D;
class vtkCellArray;
class VTKINTERACTIONWIDGETS_EXPORT vtkBorderRepresentation : public vtkWidgetRepresentation
{
public:
/**
* Instantiate this class.
*/
static vtkBorderRepresentation* New();
///@{
/**
* Define standard methods.
*/
vtkTypeMacro(vtkBorderRepresentation, vtkWidgetRepresentation);
void PrintSelf(ostream& os, vtkIndent indent) override;
///@}
///@{
/**
* Specify opposite corners of the box defining the boundary of the
* widget. By default, these coordinates are in the normalized viewport
* coordinate system, with Position the lower left of the outline, and
* Position2 relative to Position. Note that using these methods are
* affected by the ProportionalResize flag. That is, if the aspect ratio of
* the representation is to be preserved (e.g., ProportionalResize is on),
* then the rectangle (Position,Position2) is a bounding rectangle.
*/
vtkViewportCoordinateMacro(Position);
vtkViewportCoordinateMacro(Position2);
///@}
enum
{
BORDER_OFF = 0,
BORDER_ON,
BORDER_ACTIVE
};
///@{
/**
* Specify when and if the border should appear. If ShowBorder is "on",
* then the border will always appear. If ShowBorder is "off" then the
* border will never appear. If ShowBorder is "active" then the border
* will appear when the mouse pointer enters the region bounded by the
* border widget.
* This method is provided as conveniency to set both horizontal and
* vertical borders.
* BORDER_ON by default.
* See Also: SetShowHorizontalBorder(), SetShowVerticalBorder()
*/
virtual void SetShowBorder(int border);
virtual int GetShowBorderMinValue();
virtual int GetShowBorderMaxValue();
virtual int GetShowBorder();
void SetShowBorderToOff() { this->SetShowBorder(BORDER_OFF); }
void SetShowBorderToOn() { this->SetShowBorder(BORDER_ON); }
void SetShowBorderToActive() { this->SetShowBorder(BORDER_ACTIVE); }
///@}
///@{
/**
* Specify when and if the vertical border should appear.
* See Also: SetShowBorder(), SetShowHorizontalBorder()
*/
vtkSetClampMacro(ShowVerticalBorder, int, BORDER_OFF, BORDER_ACTIVE);
vtkGetMacro(ShowVerticalBorder, int);
///@}
///@{
/**
* Specify when and if the horizontal border should appear.
* See Also: SetShowBorder(), SetShowVerticalBorder()
*/
vtkSetClampMacro(ShowHorizontalBorder, int, BORDER_OFF, BORDER_ACTIVE);
vtkGetMacro(ShowHorizontalBorder, int);
///@}
///@{
/**
* Specify the properties of the border.
*/
vtkGetObjectMacro(BorderProperty, vtkProperty2D);
///@}
///@{
/**
* Whether to enforce the minimum normalized viewport size and limit
* the normalized viewport coordinates to [0.0 -> 1.0]. This keeps
* widgets from being moved offscreen or being scaled down past their
* minimum viewport size.
*
* Off by Default.
*
* Note: ProportionalResize must be off for this function to take effect.
*/
vtkSetMacro(EnforceNormalizedViewportBounds, vtkTypeBool);
vtkGetMacro(EnforceNormalizedViewportBounds, vtkTypeBool);
vtkBooleanMacro(EnforceNormalizedViewportBounds, vtkTypeBool);
//@}
//@{
/**
* Indicate whether resizing operations should keep the x-y directions
* proportional to one another. Also, if ProportionalResize is on, then
* the rectangle (Position,Position2) is a bounding rectangle, and the
* representation will be placed in the rectangle in such a way as to
* preserve the aspect ratio of the representation.
*
* Off by Default.
*/
vtkSetMacro(ProportionalResize, vtkTypeBool);
vtkGetMacro(ProportionalResize, vtkTypeBool);
vtkBooleanMacro(ProportionalResize, vtkTypeBool);
///@}
///@{
/**
* Specify a minimum and/or maximum size [0.0 -> 1.0] that this representation
* can take. These methods require two values: size values in the x and y
* directions, respectively.
*
* Default is { 0.0, 0.0 }.
*/
vtkSetVector2Macro(MinimumNormalizedViewportSize, double);
vtkGetVector2Macro(MinimumNormalizedViewportSize, double);
//@}
//@{
/**
* Specify a minimum and/or maximum size (in pixels) that this representation
* can take. These methods require two values: size values in the x and y
* directions, respectively.
*
* Default is { 1, 1 }.
*/
vtkSetVector2Macro(MinimumSize, int);
vtkGetVector2Macro(MinimumSize, int);
vtkSetVector2Macro(MaximumSize, int);
vtkGetVector2Macro(MaximumSize, int);
///@}
///@{
/**
* The tolerance representing the distance to the widget (in pixels)
* in which the cursor is considered to be on the widget, or on a
* widget feature (e.g., a corner point or edge).
*
* Default is 3.
*/
vtkSetClampMacro(Tolerance, int, 1, 10);
vtkGetMacro(Tolerance, int);
///@}
///@{
/**
* After a selection event within the region interior to the border; the
* normalized selection coordinates may be obtained.
*/
vtkGetVectorMacro(SelectionPoint, double, 2);
///@}
///@{
/**
* This is a modifier of the interaction state. When set, widget interaction
* allows the border (and stuff inside of it) to be translated with mouse
* motion.
*/
vtkSetMacro(Moving, vtkTypeBool);
vtkGetMacro(Moving, vtkTypeBool);
vtkBooleanMacro(Moving, vtkTypeBool);
///@}
/**
* Define the various states that the representation can be in.
*/
enum _InteractionState
{
Outside = 0,
Inside,
AdjustingP0,
AdjustingP1,
AdjustingP2,
AdjustingP3,
AdjustingE0,
AdjustingE1,
AdjustingE2,
AdjustingE3
};
vtkSetClampMacro(InteractionState, int, 0, AdjustingE3);
/**
* Return the MTime of this object. It takes into account MTimes
* of position coordinates and border's property.
*/
vtkMTimeType GetMTime() override;
///@{
/**
* Subclasses should implement these methods. See the superclasses'
* documentation for more information.
*/
void BuildRepresentation() override;
void StartWidgetInteraction(double eventPos[2]) override;
void WidgetInteraction(double eventPos[2]) override;
virtual void GetSize(double size[2])
{
size[0] = 1.0;
size[1] = 1.0;
}
int ComputeInteractionState(int X, int Y, int modify = 0) override;
///@}
///@{
/**
* These methods are necessary to make this representation behave as
* a vtkProp.
*/
void GetActors2D(vtkPropCollection*) override;
void ReleaseGraphicsResources(vtkWindow*) override;
int RenderOverlay(vtkViewport*) override;
int RenderOpaqueGeometry(vtkViewport*) override;
int RenderTranslucentPolygonalGeometry(vtkViewport*) override;
vtkTypeBool HasTranslucentPolygonalGeometry() override;
///@}
void SetBWActorDisplayOverlay(bool);
///@{
/**
* Set/Get the RGB color of the border.
* Default is white (1.0, 1.0, 1.0).
*/
vtkSetVector3Macro(BorderColor, double);
vtkGetVector3Macro(BorderColor, double);
///@}
///@{
/**
* Set/Get the thickness of the border in screen units.
* Default is 1.0.
*/
vtkSetClampMacro(BorderThickness, float, 0, VTK_FLOAT_MAX);
vtkGetMacro(BorderThickness, float);
///@}
///@{
/**
* Set/Get the ratio between no radius and maximum radius.
* In order to compute round corners, we create 2 points
* in each side of the corner. The maximum radius is then
* the minimum length of the two sides of each corners.
* This maximum radius is scaled by the CornerRadiusStrength.
* Default is 0.0 (no radius).
*/
vtkSetClampMacro(CornerRadiusStrength, double, 0.0, 1.0);
vtkGetMacro(CornerRadiusStrength, double);
///@}
///@{
/**
* Set/Get the number of points that define each round corners.
* A high value increase the resolution of the corners.
* Default is 20.
*/
vtkSetClampMacro(CornerResolution, int, 0, 1000);
vtkGetMacro(CornerResolution, int);
///@}
///@{
/**
* Set/Get the RGB color of the background polygon.
* Default is white (1.0, 1.0, 1.0).
*/
vtkSetVector3Macro(PolygonColor, double);
vtkGetVector3Macro(PolygonColor, double);
///@}
///@{
/**
* Set/Get the opacity of the background color.
* Default is 0.0.
*/
vtkSetClampMacro(PolygonOpacity, double, 0.0, 1.0);
vtkGetMacro(PolygonOpacity, double);
///@}
///@{
/**
* Convenience method to set the background color and the opacity at once
*/
void SetPolygonRGBA(double rgba[4]);
void SetPolygonRGBA(double r, double g, double b, double a);
/**
* Convenience method to get the background color and the opacity at once
*/
void GetPolygonRGBA(double rgba[4]);
void GetPolygonRGBA(double& r, double& g, double& b, double& a);
///@}
protected:
vtkBorderRepresentation();
~vtkBorderRepresentation() override;
// Ivars
int ShowVerticalBorder = BORDER_ON;
int ShowHorizontalBorder = BORDER_ON;
vtkNew<vtkProperty2D> BorderProperty;
vtkNew<vtkProperty2D> PolygonProperty;
vtkTypeBool EnforceNormalizedViewportBounds = 0;
vtkTypeBool ProportionalResize = 0;
int Tolerance = 3;
vtkTypeBool Moving = 0;
double SelectionPoint[2] = { 0.0, 0.0 };
// Layout (position of lower left and upper right corners of border)
vtkNew<vtkCoordinate> PositionCoordinate;
vtkNew<vtkCoordinate> Position2Coordinate;
// Sometimes subclasses must negotiate with their superclasses
// to achieve the correct layout.
int Negotiated;
virtual void NegotiateLayout();
// Update the border visibility based on InteractionState.
// See Also: SetShowHorizontalBorder(), SetShowHorizontalBorder(),
// ComputeInteractionState()
virtual void UpdateShowBorder();
// Keep track of start position when moving border
double StartPosition[2];
// Border representation. Subclasses may use the BWTransform class
// to transform their geometry into the region surrounded by the border.
vtkNew<vtkPoints> BWPoints;
vtkNew<vtkPolyData> BWPolyData;
vtkNew<vtkPolyData> PolyDataEdges;
vtkNew<vtkPolyData> PolyDataPolygon;
vtkNew<vtkTransform> BWTransform;
vtkNew<vtkTransformPolyDataFilter> BWTransformFilter;
vtkNew<vtkPolyDataMapper2D> BWMapperEdges;
vtkNew<vtkPolyDataMapper2D> BWMapperPolygon;
vtkNew<vtkActor2D> BWActorEdges;
vtkNew<vtkActor2D> BWActorPolygon;
// Constraints on size
double MinimumNormalizedViewportSize[2] = { 0.0, 0.0 };
int MinimumSize[2] = { 1, 1 };
int MaximumSize[2] = { VTK_INT_MAX, VTK_INT_MAX };
// Properties of the border
double BorderColor[3] = { 1.0, 1.0, 1.0 };
float BorderThickness = 1.0;
double CornerRadiusStrength = 0.0;
int CornerResolution = 20;
// Properties of the inner polygon (ie. the background)
double PolygonColor[3] = { 1.0, 1.0, 1.0 };
double PolygonOpacity = 0.0;
/**
* Create all 4 round corners with the specified radius and resolution.
*/
void ComputeRoundCorners();
/**
* Create a quarter circle centered in point[idCenterX].x, point[idCenterY].y),
* of radius 'radius' with a starting angle 'startAngle' ending in
* 'startAngle + PI/2' with CornerResolution number of points.
* Computed points are stored in the vtkPoints 'points' and
* inserted in the vtkCellArray 'polys'
*/
void ComputeOneRoundCorner(vtkCellArray* polys, vtkPoints* points, const double radius,
vtkIdType xPt, vtkIdType yPt, const double startAngle);
private:
vtkBorderRepresentation(const vtkBorderRepresentation&) = delete;
void operator=(const vtkBorderRepresentation&) = delete;
};
#endif