VTK
vtkConstrainedPointHandleRepresentation.h
Go to the documentation of this file.
1/*=========================================================================
2
3 Program: Visualization Toolkit
4 Module: vtkConstrainedPointHandleRepresentation.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=========================================================================*/
40#ifndef vtkConstrainedPointHandleRepresentation_h
41#define vtkConstrainedPointHandleRepresentation_h
42
43#include "vtkInteractionWidgetsModule.h" // For export macro
45
46class vtkProperty;
47class vtkActor;
49class vtkPolyData;
50class vtkGlyph3D;
51class vtkPoints;
52class vtkPolyData;
53class vtkPlane;
55class vtkPlanes;
56class vtkRenderer;
57
58class VTKINTERACTIONWIDGETS_EXPORT vtkConstrainedPointHandleRepresentation : public vtkHandleRepresentation
59{
60public:
65
67
71 void PrintSelf(ostream& os, vtkIndent indent);
73
75
80 void SetCursorShape(vtkPolyData *cursorShape);
83
85
93
95
100 vtkSetClampMacro(ProjectionNormal,int,
103 vtkGetMacro(ProjectionNormal,int);
105
107 { this->SetProjectionNormal(vtkConstrainedPointHandleRepresentation::XAxis); }
109 { this->SetProjectionNormal(vtkConstrainedPointHandleRepresentation::YAxis); }
111 { this->SetProjectionNormal(vtkConstrainedPointHandleRepresentation::ZAxis); }
113 { this->SetProjectionNormal(vtkConstrainedPointHandleRepresentation::Oblique); }
114
116
121 vtkGetObjectMacro(ObliquePlane, vtkPlane);
123
125
133 vtkGetMacro(ProjectionPosition, double);
135
137
149 vtkGetObjectMacro(BoundingPlanes,vtkPlaneCollection);
152
158 virtual int CheckConstraint(vtkRenderer *renderer, double pos[2]);
159
161
166 void SetPosition(double x, double y, double z);
167 void SetPosition(double xyz[3]);
168 double* GetPosition();
169 void GetPosition(double xyz[3]);
171
173
177 vtkGetObjectMacro(Property,vtkProperty);
179
181
185 vtkGetObjectMacro(SelectedProperty,vtkProperty);
187
189
193 vtkGetObjectMacro(ActiveProperty,vtkProperty);
195
197
202 virtual void SetRenderer(vtkRenderer *ren);
203 virtual void BuildRepresentation();
204 virtual void StartWidgetInteraction(double eventPos[2]);
205 virtual void WidgetInteraction(double eventPos[2]);
206 virtual int ComputeInteractionState(int X, int Y, int modify);
208
213 virtual void SetDisplayPosition(double pos[3]);
214
216
221 virtual int RenderOverlay(vtkViewport *viewport);
222 virtual int RenderOpaqueGeometry(vtkViewport *viewport);
225 virtual void ShallowCopy(vtkProp* prop);
227
228 enum {XAxis=0,YAxis,ZAxis,Oblique};
229
230 void Highlight(int highlight);
231
232protected:
235
236 // Render the cursor
244
245 // Support picking
246 double LastPickPosition[3];
247 double LastEventPosition[2];
248
249 // Methods to manipulate the cursor
250 void Translate(double eventPos[2]);
251 void Scale(double eventPos[2]);
252
253
254 // Properties used to control the appearance of selected objects and
255 // the manipulator in general.
260
261 // Controlling vars
266
268
269 // Internal method for computing 3D location from 2D screen position
270 int GetIntersectionPosition( double eventPos[2],
271 double worldPos[3],
272 double tolerance = 0.0,
273 vtkRenderer *renderer=0);
274
275 // Internal method for getting the project normal as a vector
276 void GetProjectionNormal( double normal[3] );
277
278 // Internal method for getting the origin of the
279 // constraining plane as a 3-tuple
280 void GetProjectionOrigin( double origin[3] );
281
282
283
284 // Distance between where the mouse event happens and where the
285 // widget is focused - maintain this distance during interaction.
286 double InteractionOffset[2];
287
288private:
290 void operator=(const vtkConstrainedPointHandleRepresentation&) VTK_DELETE_FUNCTION;
291};
292
293#endif
represents an object (geometry & properties) in a rendered scene
Definition: vtkActor.h:52
point representation constrained to a 2D plane
void PrintSelf(ostream &os, vtkIndent indent)
Methods invoked by print to print information about the object including superclasses.
virtual int HasTranslucentPolygonalGeometry()
WARNING: INTERNAL METHOD - NOT INTENDED FOR GENERAL USE DO NOT USE THESE METHODS OUTSIDE OF THE RENDE...
virtual void StartWidgetInteraction(double eventPos[2])
int GetIntersectionPosition(double eventPos[2], double worldPos[3], double tolerance=0.0, vtkRenderer *renderer=0)
virtual void ReleaseGraphicsResources(vtkWindow *)
WARNING: INTERNAL METHOD - NOT INTENDED FOR GENERAL USE Release any graphics resources that are being...
virtual int RenderOpaqueGeometry(vtkViewport *viewport)
WARNING: INTERNAL METHOD - NOT INTENDED FOR GENERAL USE DO NOT USE THESE METHODS OUTSIDE OF THE RENDE...
virtual int RenderOverlay(vtkViewport *viewport)
virtual void SetDisplayPosition(double pos[3])
Method overridden from Superclass.
virtual int RenderTranslucentPolygonalGeometry(vtkViewport *viewport)
virtual void SetRenderer(vtkRenderer *ren)
Subclasses of vtkConstrainedPointHandleRepresentation must implement these methods.
void AddBoundingPlane(vtkPlane *plane)
A collection of plane equations used to bound the position of the point.
virtual int CheckConstraint(vtkRenderer *renderer, double pos[2])
Overridden from the base class.
virtual int ComputeInteractionState(int X, int Y, int modify)
virtual void WidgetInteraction(double eventPos[2])
void SetProjectionPosition(double position)
The position of the bounding plane from the origin along the normal.
virtual void ShallowCopy(vtkProp *prop)
Methods to make this class properly act like a vtkWidgetRepresentation.
void SetPosition(double x, double y, double z)
Set/Get the position of the point in display coordinates.
void SetActiveCursorShape(vtkPolyData *activeShape)
Specify the shape of the cursor (handle) when it is active.
static vtkConstrainedPointHandleRepresentation * New()
Instantiate this class.
void SetCursorShape(vtkPolyData *cursorShape)
Specify the cursor shape.
void SetBoundingPlanes(vtkPlanes *planes)
virtual void SetBoundingPlanes(vtkPlaneCollection *)
void RemoveBoundingPlane(vtkPlane *plane)
void GetProjectionOrigin(double origin[3])
void Translate(double eventPos[2])
virtual void GetActors(vtkPropCollection *)
Methods to make this class behave as a vtkProp.
void GetProjectionNormal(double normal[3])
void SetObliquePlane(vtkPlane *)
If the ProjectionNormal is set to Oblique, then this is the oblique plane used to constrain the handl...
copy oriented and scaled glyph geometry to every input point
Definition: vtkGlyph3D.h:112
abstract class for representing widget handles
a simple class to control print indentation
Definition: vtkIndent.h:40
maintain a list of planes
perform various plane computations
Definition: vtkPlane.h:38
implicit function for convex set of planes
Definition: vtkPlanes.h:55
represent and manipulate 3D points
Definition: vtkPoints.h:40
map vtkPolyData to graphics primitives
concrete dataset represents vertices, lines, polygons, and triangle strips
Definition: vtkPolyData.h:86
a list of Props
abstract superclass for all actors, volumes and annotations
Definition: vtkProp.h:48
represent surface properties of a geometric object
Definition: vtkProperty.h:65
abstract specification for renderers
Definition: vtkRenderer.h:64
abstract specification for Viewports
Definition: vtkViewport.h:48
window superclass for vtkRenderWindow
Definition: vtkWindow.h:35
@ position
Definition: vtkX3D.h:261