VTK  9.2.6
vtkPointHandleRepresentation3D.h
Go to the documentation of this file.
1/*=========================================================================
2
3 Program: Visualization Toolkit
4 Module: vtkPointHandleRepresentation3D.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=========================================================================*/
29
30#ifndef vtkPointHandleRepresentation3D_h
31#define vtkPointHandleRepresentation3D_h
32
33#include "vtkCursor3D.h" // Needed for delegation to cursor3D
35#include "vtkInteractionWidgetsModule.h" // For export macro
36
37class vtkCursor3D;
38class vtkProperty;
39class vtkActor;
41class vtkCellPicker;
42
43class VTKINTERACTIONWIDGETS_EXPORT vtkPointHandleRepresentation3D : public vtkHandleRepresentation
44{
45public:
50
52
56 void PrintSelf(ostream& os, vtkIndent indent) override;
58
60
62
69 void SetWorldPosition(double p[3]) override;
70 void SetDisplayPosition(double p[3]) override;
72
76 void SetOutline(int o) { this->Cursor3D->SetOutline(o); }
77 int GetOutline() { return this->Cursor3D->GetOutline(); }
78 void OutlineOn() { this->Cursor3D->OutlineOn(); }
79 void OutlineOff() { this->Cursor3D->OutlineOff(); }
80
84 void SetXShadows(int o) { this->Cursor3D->SetXShadows(o); }
85 int GetXShadows() { return this->Cursor3D->GetXShadows(); }
86 void XShadowsOn() { this->Cursor3D->XShadowsOn(); }
87 void XShadowsOff() { this->Cursor3D->XShadowsOff(); }
88
92 void SetYShadows(int o) { this->Cursor3D->SetYShadows(o); }
93 int GetYShadows() { return this->Cursor3D->GetYShadows(); }
94 void YShadowsOn() { this->Cursor3D->YShadowsOn(); }
95 void YShadowsOff() { this->Cursor3D->YShadowsOff(); }
96
100 void SetZShadows(int o) { this->Cursor3D->SetZShadows(o); }
101 int GetZShadows() { return this->Cursor3D->GetZShadows(); }
102 void ZShadowsOn() { this->Cursor3D->ZShadowsOn(); }
103 void ZShadowsOff() { this->Cursor3D->ZShadowsOff(); }
104
106
119 vtkBooleanMacro(TranslationMode, vtkTypeBool);
121
123
126 void AllOn()
127 {
128 this->OutlineOn();
129 this->XShadowsOn();
130 this->YShadowsOn();
131 this->ZShadowsOn();
132 }
133 void AllOff()
134 {
135 this->OutlineOff();
136 this->XShadowsOff();
137 this->YShadowsOff();
138 this->ZShadowsOff();
139 }
140
141
143
148 vtkGetObjectMacro(Property, vtkProperty);
149 vtkGetObjectMacro(SelectedProperty, vtkProperty);
151
153
159 vtkSetClampMacro(HotSpotSize, double, 0.0, 1.0);
160 vtkGetMacro(HotSpotSize, double);
162
166 void SetHandleSize(double size) override;
167
169
172 double* GetBounds() VTK_SIZEHINT(6) override;
173 void BuildRepresentation() override;
174 void StartWidgetInteraction(double eventPos[2]) override;
175 void WidgetInteraction(double eventPos[2]) override;
176 int ComputeInteractionState(int X, int Y, int modify = 0) override;
177 void PlaceWidget(double bounds[6]) override;
179 unsigned long event, void* calldata) override;
181 unsigned long event, void* calldata) override;
183 unsigned long event, void* calldata, int modify = 0) override;
185
187
190 void ShallowCopy(vtkProp* prop) override;
191 void DeepCopy(vtkProp* prop) override;
194 int RenderOpaqueGeometry(vtkViewport* viewport) override;
198
199 void Highlight(int highlight) override;
200
202
215 vtkBooleanMacro(SmoothMotion, vtkTypeBool);
217
218 /*
219 * Register internal Pickers within PickingManager
220 */
221 void RegisterPickers() override;
222
229 void SetVisibility(vtkTypeBool visible) override;
230
231protected:
234
235 // the cursor3D
239
240 // Do the picking
244
245 // Methods to manipulate the cursor
247 void Translate(const double* p1, const double* p2) override;
248 void Scale(const double* p1, const double* p2, const double eventPos[2]);
249 void MoveFocus(const double* p1, const double* p2);
251
264 const double* p1, const double* p2, const double currPos[2], double center[3]);
265
266 // Properties used to control the appearance of selected objects and
267 // the manipulator in general.
271
272 // The size of the hot spot.
274 int DetermineConstraintAxis(int constraint, double* x, double* startPoint);
277
278 // Current handle sized (may reflect scaling)
280
281 // Control how translation works
283
285
286private:
288 void operator=(const vtkPointHandleRepresentation3D&) = delete;
289};
290
291#endif
define the API for widget / widget representation
represents an object (geometry & properties) in a rendered scene
Definition vtkActor.h:52
ray-cast cell picker for all kinds of Prop3Ds
generate a 3D cursor representation
Definition vtkCursor3D.h:40
virtual void Translate(const double *p1, const double *p2)
Translates world position by vector p1p2 projected on the constraint axis if any.
a simple class to control print indentation
Definition vtkIndent.h:40
int RenderTranslucentPolygonalGeometry(vtkViewport *viewport) override
Methods to make this class behave as a vtkProp.
void AllOn()
Convenience methods to turn outline and shadows on and off.
void SetHandleSize(double size) override
Overload the superclasses SetHandleSize() method to update internal variables.
int RenderOpaqueGeometry(vtkViewport *viewport) override
Methods to make this class behave as a vtkProp.
void MoveFocusRequest(const double *p1, const double *p2, const double currPos[2], double center[3])
Given a motion vector defined by p1 --> p2 (p1 and p2 are in world coordinates), the new display posi...
int DetermineConstraintAxis(int constraint, double *x, double *startPoint)
void AllOff()
Convenience methods to turn outline and shadows on and off.
void PlaceWidget(double bounds[6]) override
Methods to make this class properly act like a vtkWidgetRepresentation.
void SetYShadows(int o)
Turn on/off the wireframe y-shadows.
vtkTypeBool HasTranslucentPolygonalGeometry() override
Methods to make this class behave as a vtkProp.
void Scale(const double *p1, const double *p2, const double eventPos[2])
void ComplexInteraction(vtkRenderWindowInteractor *iren, vtkAbstractWidget *widget, unsigned long event, void *calldata) override
Methods to make this class properly act like a vtkWidgetRepresentation.
int ComputeInteractionState(int X, int Y, int modify=0) override
Methods to make this class properly act like a vtkWidgetRepresentation.
void SetOutline(int o)
Turn on/off the wireframe bounding box.
void SetProperty(vtkProperty *)
Set/Get the handle properties when unselected and selected.
void StartComplexInteraction(vtkRenderWindowInteractor *iren, vtkAbstractWidget *widget, unsigned long event, void *calldata) override
Methods to make this class properly act like a vtkWidgetRepresentation.
void SetZShadows(int o)
Turn on/off the wireframe z-shadows.
void RegisterPickers() override
Register internal Pickers in the Picking Manager.
void ReleaseGraphicsResources(vtkWindow *) override
Methods to make this class behave as a vtkProp.
void GetActors(vtkPropCollection *) override
Methods to make this class behave as a vtkProp.
void ShallowCopy(vtkProp *prop) override
Methods to make this class behave as a vtkProp.
void SetXShadows(int o)
Turn on/off the wireframe x-shadows.
void PrintSelf(ostream &os, vtkIndent indent) override
Standard methods for instances of this class.
void Highlight(int highlight) override
void SetVisibility(vtkTypeBool visible) override
Override to ensure that the internal actor's visibility is consistent with this representation's visi...
void StartWidgetInteraction(double eventPos[2]) override
Methods to make this class properly act like a vtkWidgetRepresentation.
void WidgetInteraction(double eventPos[2]) override
Methods to make this class properly act like a vtkWidgetRepresentation.
void DeepCopy(vtkProp *prop) override
Methods to make this class behave as a vtkProp.
void SetTranslationMode(vtkTypeBool mode)
If translation mode is on, as the widget is moved the bounding box, shadows, and cursor are all trans...
void SetSelectedProperty(vtkProperty *)
Set/Get the handle properties when unselected and selected.
void MoveFocus(const double *p1, const double *p2)
void SetDisplayPosition(double p[3]) override
Set the position of the point in world and display coordinates.
int ComputeComplexInteractionState(vtkRenderWindowInteractor *iren, vtkAbstractWidget *widget, unsigned long event, void *calldata, int modify=0) override
Methods to make this class properly act like a vtkWidgetRepresentation.
void BuildRepresentation() override
Methods to make this class properly act like a vtkWidgetRepresentation.
void Translate(const double *p1, const double *p2) override
Translates world position by vector p1p2 projected on the constraint axis if any.
static vtkPointHandleRepresentation3D * New()
Instantiate this class.
double * GetBounds() override
Methods to make this class properly act like a vtkWidgetRepresentation.
void SetWorldPosition(double p[3]) override
Set the position of the point in world and display coordinates.
map vtkPolyData to graphics primitives
an ordered list of Props
represent surface properties of a geometric object
Definition vtkProperty.h:68
platform-independent render window interaction including picking and frame rate control.
abstract specification for Viewports
Definition vtkViewport.h:56
window superclass for vtkRenderWindow
Definition vtkWindow.h:39
int vtkTypeBool
Definition vtkABI.h:69
#define VTK_SIZEHINT(...)