VTK
vtkFinitePlaneRepresentation.h
Go to the documentation of this file.
1 /*=========================================================================
2 
3  Program: Visualization Toolkit
4  Module: vtkFinitePlaneRepresentation.h
5 
6  Copyright (c)
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 =========================================================================*/
34 #ifndef vtkFinitePlaneRepresentation_h
35 #define vtkFinitePlaneRepresentation_h
36 
37 #include "vtkInteractionWidgetsModule.h" // For export macro
39 
40 class vtkActor;
41 class vtkBox;
42 class vtkCellPicker;
43 class vtkConeSource;
44 class vtkFeatureEdges;
45 class vtkLineSource;
46 class vtkPolyData;
47 class vtkPolyDataMapper;
48 class vtkProperty;
49 class vtkSphereSource;
50 class vtkTransform;
51 class vtkTubeFilter;
52 
53 class VTKINTERACTIONWIDGETS_EXPORT vtkFinitePlaneRepresentation : public vtkWidgetRepresentation
54 {
55 public:
60 
62 
66  void PrintSelf(ostream& os, vtkIndent indent);
68 
73  void GetPolyData(vtkPolyData *pd);
74 
76 
81  vtkGetObjectMacro(V1HandleProperty, vtkProperty);
82  vtkGetObjectMacro(V2HandleProperty, vtkProperty);
83  vtkGetObjectMacro(SelectedHandleProperty, vtkProperty);
85 
87 
92  vtkGetObjectMacro(PlaneProperty, vtkProperty);
93  vtkGetObjectMacro(SelectedPlaneProperty, vtkProperty);
95 
97 
101  vtkSetMacro(Tubing, bool);
102  vtkGetMacro(Tubing, bool);
103  vtkBooleanMacro(Tubing, bool);
105 
107 
113  void SetDrawPlane(bool plane);
114  vtkGetMacro(DrawPlane, bool);
115  vtkBooleanMacro(DrawPlane, bool);
117 
119 
123  void SetHandles(bool handles);
124  virtual void HandlesOn();
125  virtual void HandlesOff();
127 
129 
132  virtual void PlaceWidget(double bounds[6]);
133  virtual void BuildRepresentation();
134  virtual int ComputeInteractionState(int X, int Y, int modify=0);
135  virtual void StartWidgetInteraction(double e[2]);
136  virtual void WidgetInteraction(double e[2]);
137  virtual double *GetBounds();
139 
141 
144  virtual void ReleaseGraphicsResources(vtkWindow*);
145  virtual int RenderOpaqueGeometry(vtkViewport*);
147  virtual int HasTranslucentPolygonalGeometry();
149 
150  vtkSetClampMacro(InteractionState, int, Outside, Pushing);
151 
153 
156  void SetOrigin(double x, double y, double z);
157  void SetOrigin(double x[3]);
158  vtkGetVector3Macro(Origin, double);
160 
162 
165  void SetNormal(double x, double y, double z);
166  void SetNormal(double x[3]);
167  vtkGetVector3Macro(Normal, double);
169 
171 
174  void SetV1(double x, double y);
175  void SetV1(double x[2]);
176  vtkGetVector2Macro(V1, double);
178 
180 
183  void SetV2(double x, double y);
184  void SetV2(double x[2]);
185  vtkGetVector2Macro(V2, double);
187 
189 
193  virtual void SetRepresentationState(int);
194  vtkGetMacro(RepresentationState, int);
196 
198 
201  vtkGetObjectMacro(NormalProperty, vtkProperty);
202  vtkGetObjectMacro(SelectedNormalProperty, vtkProperty);
204 
205  // Methods to manipulate the plane
206  void TranslateOrigin(double *p1, double *p2);
207  void MovePoint1(double *p1, double *p2);
208  void MovePoint2(double *p1, double *p2);
209  void Push(double *p1, double *p2);
210  void Rotate(int X, int Y, double *p1, double *p2, double *vpn);
211 
213  {
214  Outside = 0,
220  Pushing
221  };
222 
223 protected:
226 
227  virtual void CreateDefaultProperties();
228 
229  // Size the glyphs representing hot spots (e.g., handles)
230  virtual void SizeHandles();
231 
232  // Register internal Pickers within PickingManager
233  virtual void RegisterPickers();
234 
235  void SetHighlightNormal(int highlight);
236  void SetHighlightPlane(int highlight);
237  void SetHighlightHandle(vtkProp *prop);
238 
239  double LastEventPosition[3];
240 
241  // the representation state
243 
244  // the origin
248  double Origin[3];
249 
250  // the normal
251  double Normal[3];
252 
253  // the previous normal
254  double PreviousNormal[3];
255 
256  // the rotation transform
258 
259  // the X Vector
263  double V1[3];
264 
265  // the Y Vector
269  double V2[3];
270 
271  // The + normal cone
275 
276  // The + normal line
280 
281  // The - normal cone
285 
286  // The - normal line
290 
291  // The finite plane
295 
296  // Optional tubes are represented by extracting boundary edges
301  bool Tubing; //control whether tubing is on
302  bool DrawPlane; //control whether plane is on
303 
304  // Picking objects
307 
308  // Transform the planes (used for rotations)
310 
311  // Support GetBounds() method
313 
314  // Properties used to control the appearance of selected objects and
315  // the manipulator in general.
324 
325 private:
327  void operator=(const vtkFinitePlaneRepresentation&) VTK_DELETE_FUNCTION;
328 };
329 
330 #endif
abstract superclass for all actors, volumes and annotations
Definition: vtkProp.h:50
represents an object (geometry & properties) in a rendered scene
Definition: vtkActor.h:51
virtual int ComputeInteractionState(int X, int Y, int modify=0)
abstract specification for Viewports
Definition: vtkViewport.h:47
represent surface properties of a geometric object
Definition: vtkProperty.h:64
virtual void StartWidgetInteraction(double eventPos[2])
generate polygonal cone
Definition: vtkConeSource.h:44
describes linear transformations via a 4x4 matrix
Definition: vtkTransform.h:60
concrete dataset represents vertices, lines, polygons, and triangle strips
Definition: vtkPolyData.h:85
virtual void ReleaseGraphicsResources(vtkWindow *)
WARNING: INTERNAL METHOD - NOT INTENDED FOR GENERAL USE Release any graphics resources that are being...
abstract class defines interface between the widget and widget representation classes ...
virtual void BuildRepresentation()=0
Subclasses of vtkWidgetRepresentation must implement these methods.
window superclass for vtkRenderWindow
Definition: vtkWindow.h:37
create a polygonal sphere centered at the origin
virtual double * GetBounds()
Methods to make this class behave as a vtkProp.
filter that generates tubes around lines
Definition: vtkTubeFilter.h:83
virtual int HasTranslucentPolygonalGeometry()
WARNING: INTERNAL METHOD - NOT INTENDED FOR GENERAL USE DO NOT USE THESE METHODS OUTSIDE OF THE RENDE...
a simple class to control print indentation
Definition: vtkIndent.h:39
virtual void RegisterPickers()
Register internal Pickers in the Picking Manager.
extract boundary, non-manifold, and/or sharp edges from polygonal data
represent the vtkFinitePlaneWidget.
virtual void WidgetInteraction(double newEventPos[2])
vtkSetMacro(IgnoreDriverBugs, bool)
When set known driver bugs are ignored during driver feature detection.
create a line defined by two end points
Definition: vtkLineSource.h:42
map vtkPolyData to graphics primitives
virtual int RenderOpaqueGeometry(vtkViewport *vtkNotUsed(viewport))
virtual void PlaceWidget(double *vtkNotUsed(bounds[6]))
The following is a suggested API for widget representations.
ray-cast cell picker for all kinds of Prop3Ds
Definition: vtkCellPicker.h:69
void PrintSelf(ostream &os, vtkIndent indent)
Standard methods for instances of this class.
vtkBooleanMacro(IgnoreDriverBugs, bool)
When set known driver bugs are ignored during driver feature detection.
static vtkObject * New()
Create an object with Debug turned off, modified time initialized to zero, and reference counting on...
implicit function for a bounding box
Definition: vtkBox.h:41
virtual int RenderTranslucentPolygonalGeometry(vtkViewport *vtkNotUsed(viewport))