VTK
vtkBorderRepresentation.h
Go to the documentation of this file.
1 /*=========================================================================
2 
3  Program: Visualization Toolkit
4  Module: vtkBorderRepresentation.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 =========================================================================*/
39 #ifndef vtkBorderRepresentation_h
40 #define vtkBorderRepresentation_h
41 
42 #include "vtkInteractionWidgetsModule.h" // For export macro
44 #include "vtkCoordinate.h" //Because of the viewport coordinate macro
45 
46 class vtkPoints;
47 class vtkPolyData;
48 class vtkTransform;
51 class vtkActor2D;
52 class vtkProperty2D;
53 
54 
55 class VTKINTERACTIONWIDGETS_EXPORT vtkBorderRepresentation : public vtkWidgetRepresentation
56 {
57 public:
61  static vtkBorderRepresentation *New();
62 
64 
68  void PrintSelf(ostream& os, vtkIndent indent) override;
70 
72 
81  vtkViewportCoordinateMacro(Position);
82  vtkViewportCoordinateMacro(Position2);
84 
85  enum {BORDER_OFF=0,BORDER_ON,BORDER_ACTIVE};
86 
88 
99  virtual void SetShowBorder(int border);
100  virtual int GetShowBorderMinValue();
101  virtual int GetShowBorderMaxValue();
102  virtual int GetShowBorder();
103  void SetShowBorderToOff() {this->SetShowBorder(BORDER_OFF);}
104  void SetShowBorderToOn() {this->SetShowBorder(BORDER_ON);}
105  void SetShowBorderToActive() {this->SetShowBorder(BORDER_ACTIVE);}
107 
109 
113  vtkSetClampMacro(ShowVerticalBorder,int,BORDER_OFF,BORDER_ACTIVE);
114  vtkGetMacro(ShowVerticalBorder,int);
116 
118 
122  vtkSetClampMacro(ShowHorizontalBorder,int,BORDER_OFF,BORDER_ACTIVE);
123  vtkGetMacro(ShowHorizontalBorder,int);
125 
127 
130  vtkGetObjectMacro(BorderProperty,vtkProperty2D);
132 
134 
141  vtkSetMacro(ProportionalResize,vtkTypeBool);
142  vtkGetMacro(ProportionalResize,vtkTypeBool);
143  vtkBooleanMacro(ProportionalResize,vtkTypeBool);
145 
147 
152  vtkSetVector2Macro(MinimumSize,int);
153  vtkGetVector2Macro(MinimumSize,int);
154  vtkSetVector2Macro(MaximumSize,int);
155  vtkGetVector2Macro(MaximumSize,int);
157 
159 
164  vtkSetClampMacro(Tolerance,int,1,10);
165  vtkGetMacro(Tolerance,int);
167 
169 
173  vtkGetVectorMacro(SelectionPoint,double,2);
175 
177 
182  vtkSetMacro(Moving,vtkTypeBool);
183  vtkGetMacro(Moving,vtkTypeBool);
184  vtkBooleanMacro(Moving,vtkTypeBool);
186 
191  {
192  Outside=0,
201  AdjustingE3
202  };
203 
208  vtkMTimeType GetMTime() override;
209 
211 
215  void BuildRepresentation() override;
216  void StartWidgetInteraction(double eventPos[2]) override;
217  void WidgetInteraction(double eventPos[2]) override;
218  virtual void GetSize(double size[2])
219  {size[0]=1.0; size[1]=1.0;}
220  int ComputeInteractionState(int X, int Y, int modify=0) override;
222 
224 
228  void GetActors2D(vtkPropCollection*) override;
229  void ReleaseGraphicsResources(vtkWindow*) override;
230  int RenderOverlay(vtkViewport*) override;
231  int RenderOpaqueGeometry(vtkViewport*) override;
233  int HasTranslucentPolygonalGeometry() override;
235 
236 protected:
238  ~vtkBorderRepresentation() override;
239 
240  // Ivars
247  double SelectionPoint[2];
248 
249  // Layout (position of lower left and upper right corners of border)
252 
253  // Sometimes subclasses must negotiate with their superclasses
254  // to achieve the correct layout.
256  virtual void NegotiateLayout();
257 
258  // Update the border visibility based on InteractionState.
259  // See Also: SetShowHorizontalBorder(), SetShowHorizontalBorder(),
260  // ComputeInteractionState()
261  virtual void UpdateShowBorder();
262 
263  // Keep track of start position when moving border
264  double StartPosition[2];
265 
266  // Border representation. Subclasses may use the BWTransform class
267  // to transform their geometry into the region surrounded by the border.
274 
275  // Constraints on size
276  int MinimumSize[2];
277  int MaximumSize[2];
278 
279 private:
281  void operator=(const vtkBorderRepresentation&) = delete;
282 };
283 
284 #endif
vtkPoints
represent and manipulate 3D points
Definition: vtkPoints.h:33
vtkWidgetRepresentation::StartWidgetInteraction
virtual void StartWidgetInteraction(double eventPos[2])
Definition: vtkWidgetRepresentation.h:136
vtkWidgetRepresentation.h
vtkBorderRepresentation::Inside
Definition: vtkBorderRepresentation.h:193
vtkBorderRepresentation::Tolerance
int Tolerance
Definition: vtkBorderRepresentation.h:245
vtkPolyDataMapper2D
draw vtkPolyData onto the image plane
Definition: vtkPolyDataMapper2D.h:45
vtkBorderRepresentation::AdjustingP3
Definition: vtkBorderRepresentation.h:197
vtkBorderRepresentation
represent a vtkBorderWidget
Definition: vtkBorderRepresentation.h:55
vtkBorderRepresentation::ShowVerticalBorder
int ShowVerticalBorder
Definition: vtkBorderRepresentation.h:241
vtkObject::New
static vtkObject * New()
Create an object with Debug turned off, modified time initialized to zero, and reference counting on.
vtkBorderRepresentation::BWTransform
vtkTransform * BWTransform
Definition: vtkBorderRepresentation.h:270
vtkBorderRepresentation::Moving
vtkTypeBool Moving
Definition: vtkBorderRepresentation.h:246
vtkWidgetRepresentation
abstract class defines interface between the widget and widget representation classes
Definition: vtkWidgetRepresentation.h:60
vtkBorderRepresentation::Position2Coordinate
vtkCoordinate * Position2Coordinate
Definition: vtkBorderRepresentation.h:251
vtkBorderRepresentation::PositionCoordinate
vtkCoordinate * PositionCoordinate
Definition: vtkBorderRepresentation.h:250
vtkBorderRepresentation::AdjustingP2
Definition: vtkBorderRepresentation.h:196
vtkBorderRepresentation::AdjustingP1
Definition: vtkBorderRepresentation.h:195
vtkBorderRepresentation::SetShowBorderToOff
void SetShowBorderToOff()
Definition: vtkBorderRepresentation.h:103
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:54
vtkBorderRepresentation::BWTransformFilter
vtkTransformPolyDataFilter * BWTransformFilter
Definition: vtkBorderRepresentation.h:271
vtkBorderRepresentation::SetShowBorderToActive
void SetShowBorderToActive()
Definition: vtkBorderRepresentation.h:105
vtkWindow
window superclass for vtkRenderWindow
Definition: vtkWindow.h:34
vtkWidgetRepresentation::RenderTranslucentPolygonalGeometry
int RenderTranslucentPolygonalGeometry(vtkViewport *vtkNotUsed(viewport)) override
Definition: vtkWidgetRepresentation.h:223
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
vtkBorderRepresentation::SetShowBorderToOn
void SetShowBorderToOn()
Definition: vtkBorderRepresentation.h:104
vtkWidgetRepresentation::WidgetInteraction
virtual void WidgetInteraction(double newEventPos[2])
Definition: vtkWidgetRepresentation.h:137
vtkWidgetRepresentation::HasTranslucentPolygonalGeometry
int HasTranslucentPolygonalGeometry() override
WARNING: INTERNAL METHOD - NOT INTENDED FOR GENERAL USE DO NOT USE THESE METHODS OUTSIDE OF THE RENDE...
Definition: vtkWidgetRepresentation.h:225
vtkBorderRepresentation::BorderProperty
vtkProperty2D * BorderProperty
Definition: vtkBorderRepresentation.h:243
vtkObject::GetMTime
virtual vtkMTimeType GetMTime()
Return this object's modified time.
vtkIndent
a simple class to control print indentation
Definition: vtkIndent.h:33
vtkBorderRepresentation::GetSize
virtual void GetSize(double size[2])
Definition: vtkBorderRepresentation.h:218
vtkBorderRepresentation::AdjustingE1
Definition: vtkBorderRepresentation.h:199
vtkCoordinate
perform coordinate transformation, and represent position, in a variety of vtk coordinate systems
Definition: vtkCoordinate.h:75
vtkX3D::size
Definition: vtkX3D.h:253
vtkBorderRepresentation::BWPolyData
vtkPolyData * BWPolyData
Definition: vtkBorderRepresentation.h:269
vtkTransformPolyDataFilter
transform points and associated normals and vectors for polygonal dataset
Definition: vtkTransformPolyDataFilter.h:45
vtkViewport
abstract specification for Viewports
Definition: vtkViewport.h:44
vtkBorderRepresentation::BWActor
vtkActor2D * BWActor
Definition: vtkBorderRepresentation.h:273
vtkBorderRepresentation::AdjustingE2
Definition: vtkBorderRepresentation.h:200
vtkCoordinate.h
vtkBorderRepresentation::BORDER_ON
Definition: vtkBorderRepresentation.h:85
vtkProperty2D
represent surface properties of a 2D image
Definition: vtkProperty2D.h:37
vtkActor2D
a actor that draws 2D data
Definition: vtkActor2D.h:39
vtkBorderRepresentation::ProportionalResize
vtkTypeBool ProportionalResize
Definition: vtkBorderRepresentation.h:244
vtkBorderRepresentation::_InteractionState
_InteractionState
Define the various states that the representation can be in.
Definition: vtkBorderRepresentation.h:190
vtkWidgetRepresentation::RenderOverlay
int RenderOverlay(vtkViewport *vtkNotUsed(viewport)) override
Definition: vtkWidgetRepresentation.h:221
vtkWidgetRepresentation::RenderOpaqueGeometry
int RenderOpaqueGeometry(vtkViewport *vtkNotUsed(viewport)) override
Definition: vtkWidgetRepresentation.h:222
vtkBorderRepresentation::AdjustingE0
Definition: vtkBorderRepresentation.h:198
vtkPolyData
concrete dataset represents vertices, lines, polygons, and triangle strips
Definition: vtkPolyData.h:79
vtkBorderRepresentation::Negotiated
int Negotiated
Definition: vtkBorderRepresentation.h:255
vtkBorderRepresentation::ShowHorizontalBorder
int ShowHorizontalBorder
Definition: vtkBorderRepresentation.h:242
vtkBorderRepresentation::BWMapper
vtkPolyDataMapper2D * BWMapper
Definition: vtkBorderRepresentation.h:272
vtkPropCollection
an ordered list of Props
Definition: vtkPropCollection.h:35
vtkBorderRepresentation::AdjustingP0
Definition: vtkBorderRepresentation.h:194
vtkTypeBool
int vtkTypeBool
Definition: vtkABI.h:69
vtkWidgetRepresentation::ComputeInteractionState
virtual int ComputeInteractionState(int X, int Y, int modify=0)
vtkMTimeType
vtkTypeUInt32 vtkMTimeType
Definition: vtkType.h:302
vtkWidgetRepresentation::PrintSelf
void PrintSelf(ostream &os, vtkIndent indent) override
Methods invoked by print to print information about the object including superclasses.
vtkBorderRepresentation::BWPoints
vtkPoints * BWPoints
Definition: vtkBorderRepresentation.h:268