VTK
vtkPointWidget.h
Go to the documentation of this file.
1/*=========================================================================
2
3 Program: Visualization Toolkit
4 Module: vtkPointWidget.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=========================================================================*/
70#ifndef vtkPointWidget_h
71#define vtkPointWidget_h
72
73#include "vtkInteractionWidgetsModule.h" // For export macro
74#include "vtk3DWidget.h"
75#include "vtkCursor3D.h" // Needed for faster access to the Cursor3D
76
77class vtkActor;
79class vtkCellPicker;
80class vtkPolyData;
81class vtkProperty;
82
83class VTKINTERACTIONWIDGETS_EXPORT vtkPointWidget : public vtk3DWidget
84{
85public:
90
92 void PrintSelf(ostream& os, vtkIndent indent);
93
95
98 virtual void SetEnabled(int);
99 virtual void PlaceWidget(double bounds[6]);
101 {this->Superclass::PlaceWidget();}
102 void PlaceWidget(double xmin, double xmax, double ymin, double ymax,
103 double zmin, double zmax)
104 {this->Superclass::PlaceWidget(xmin,xmax,ymin,ymax,zmin,zmax);}
106
112
118 void SetPosition(double x, double y, double z)
119 {this->Cursor3D->SetFocalPoint(x,y,z);}
120 void SetPosition(double x[3])
121 {this->SetPosition(x[0],x[1],x[2]);}
122 double* GetPosition()
123 {return this->Cursor3D->GetFocalPoint();}
124 void GetPosition(double xyz[3])
125 {this->Cursor3D->GetFocalPoint(xyz);}
126
130 void SetOutline(int o)
131 {this->Cursor3D->SetOutline(o);}
133 {return this->Cursor3D->GetOutline();}
135 {this->Cursor3D->OutlineOn();}
137 {this->Cursor3D->OutlineOff();}
138
142 void SetXShadows(int o)
143 {this->Cursor3D->SetXShadows(o);}
145 {return this->Cursor3D->GetXShadows();}
147 {this->Cursor3D->XShadowsOn();}
149 {this->Cursor3D->XShadowsOff();}
150
154 void SetYShadows(int o)
155 {this->Cursor3D->SetYShadows(o);}
157 {return this->Cursor3D->GetYShadows();}
159 {this->Cursor3D->YShadowsOn();}
161 {this->Cursor3D->YShadowsOff();}
162
166 void SetZShadows(int o)
167 {this->Cursor3D->SetZShadows(o);}
169 {return this->Cursor3D->GetZShadows();}
171 {this->Cursor3D->ZShadowsOn();}
173 {this->Cursor3D->ZShadowsOff();}
174
181 { this->Cursor3D->SetTranslationMode(mode); this->Cursor3D->Update(); }
183 { return this->Cursor3D->GetTranslationMode(); }
185 { this->SetTranslationMode(1); }
187 { this->SetTranslationMode(0); }
188
190
193 void AllOn()
194 {
195 this->OutlineOn();
196 this->XShadowsOn();
197 this->YShadowsOn();
198 this->ZShadowsOn();
199 }
200 void AllOff()
201 {
202 this->OutlineOff();
203 this->XShadowsOff();
204 this->YShadowsOff();
205 this->ZShadowsOff();
206 }
208
210
215 vtkGetObjectMacro(Property,vtkProperty);
216 vtkGetObjectMacro(SelectedProperty,vtkProperty);
218
220
226 vtkSetClampMacro(HotSpotSize,double,0.0,1.0);
227 vtkGetMacro(HotSpotSize,double);
229
230protected:
233
234 // Manage the state of the widget
235 friend class vtkLineWidget;
236
237 int State;
239 {
244 Outside
245 };
246
247 // Handles the events
248 static void ProcessEvents(vtkObject* object,
249 unsigned long event,
250 void* clientdata,
251 void* calldata);
252
253 // ProcessEvents() dispatches to these methods.
254 virtual void OnMouseMove();
255 virtual void OnLeftButtonDown();
256 virtual void OnLeftButtonUp();
257 virtual void OnMiddleButtonDown();
258 virtual void OnMiddleButtonUp();
259 virtual void OnRightButtonDown();
260 virtual void OnRightButtonUp();
261
262 // the cursor3D
266 void Highlight(int highlight);
267
268 // Do the picking
270
271 // Register internal Pickers within PickingManager
272 virtual void RegisterPickers();
273
274 // Methods to manipulate the cursor
276 void Translate(double *p1, double *p2);
277 void Scale(double *p1, double *p2, int X, int Y);
278 void MoveFocus(double *p1, double *p2);
280
281 // Properties used to control the appearance of selected objects and
282 // the manipulator in general.
286
287 // The size of the hot spot.
289 int DetermineConstraintAxis(int constraint, double *x);
292
293private:
294 vtkPointWidget(const vtkPointWidget&) VTK_DELETE_FUNCTION;
295 void operator=(const vtkPointWidget&) VTK_DELETE_FUNCTION;
296};
297
298#endif
an abstract superclass for 3D widgets
Definition: vtk3DWidget.h:68
represents an object (geometry & properties) in a rendered scene
Definition: vtkActor.h:52
ray-cast cell picker for all kinds of Prop3Ds
Definition: vtkCellPicker.h:70
generate a 3D cursor representation
Definition: vtkCursor3D.h:40
a simple class to control print indentation
Definition: vtkIndent.h:40
3D widget for manipulating a line
Definition: vtkLineWidget.h:94
abstract base class for most VTK objects
Definition: vtkObject.h:60
position a point in 3D space
void CreateDefaultProperties()
double * GetPosition()
virtual void OnMouseMove()
void PlaceWidget(double xmin, double xmax, double ymin, double ymax, double zmin, double zmax)
void GetPolyData(vtkPolyData *pd)
Grab the polydata (including points) that defines the point.
vtkPolyDataMapper * Mapper
static void ProcessEvents(vtkObject *object, unsigned long event, void *clientdata, void *calldata)
void TranslationModeOn()
void TranslationModeOff()
void Highlight(int highlight)
virtual void RegisterPickers()
Register internal Pickers in the Picking Manager.
void SetOutline(int o)
Turn on/off the wireframe bounding box.
void SetZShadows(int o)
Turn on/off the wireframe z-shadows.
vtkCursor3D * Cursor3D
int DetermineConstraintAxis(int constraint, double *x)
virtual void OnRightButtonDown()
void SetTranslationMode(int mode)
If translation mode is on, as the widget is moved the bounding box, shadows, and cursor are all trans...
void SetXShadows(int o)
Turn on/off the wireframe x-shadows.
static vtkPointWidget * New()
Instantiate this widget.
vtkActor * Actor
virtual void PlaceWidget(double bounds[6])
This method is used to initially place the widget.
virtual void OnLeftButtonUp()
void GetPosition(double xyz[3])
void Translate(double *p1, double *p2)
void PrintSelf(ostream &os, vtkIndent indent)
Methods invoked by print to print information about the object including superclasses.
virtual void OnRightButtonUp()
void SetPosition(double x[3])
virtual void OnMiddleButtonUp()
int GetTranslationMode()
virtual void OnMiddleButtonDown()
void SetPosition(double x, double y, double z)
Set/Get the position of the point.
virtual void SetEnabled(int)
Methods that satisfy the superclass' API.
vtkProperty * SelectedProperty
virtual void OnLeftButtonDown()
vtkProperty * Property
void SetYShadows(int o)
Turn on/off the wireframe y-shadows.
vtkCellPicker * CursorPicker
void AllOn()
Convenience methods to turn outline and shadows on and off.
void Scale(double *p1, double *p2, int X, int Y)
void MoveFocus(double *p1, double *p2)
map vtkPolyData to graphics primitives
concrete dataset represents vertices, lines, polygons, and triangle strips
Definition: vtkPolyData.h:86
represent surface properties of a geometric object
Definition: vtkProperty.h:65
@ mode
Definition: vtkX3D.h:247