VTK  9.1.0
vtkCameraOrientationWidget.h
Go to the documentation of this file.
1 /*=========================================================================
2 
3  Program: Visualization Toolkit
4  Module: vtkCameraOrientationWidget.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 =========================================================================*/
154 #ifndef vtkCameraOrientationWidget_h
155 #define vtkCameraOrientationWidget_h
156 
157 #include "vtkAbstractWidget.h"
158 #include "vtkInteractionWidgetsModule.h" // needed for export macro
159 #include "vtkWeakPointer.h" // for weak pointer ivar
160 
163 class vtkRenderer;
164 
165 class VTKINTERACTIONWIDGETS_EXPORT vtkCameraOrientationWidget : public vtkAbstractWidget
166 {
167 public:
170  void PrintSelf(ostream& os, vtkIndent indent) override;
171 
173 
177  vtkSetMacro(Animate, bool);
178  vtkGetMacro(Animate, bool);
179  vtkBooleanMacro(Animate, bool);
181 
183 
186  vtkSetClampMacro(AnimatorTotalFrames, int, 2, VTK_INT_MAX);
187  vtkGetMacro(AnimatorTotalFrames, int);
189 
194 
198  void SquareResize();
199 
201 
211 
212 protected:
214  ~vtkCameraOrientationWidget() override = default;
215 
216  // These methods handle events
217  void ComputeWidgetState(int X, int Y, int modify = 0);
221 
222  // These control the representation and parent renderer's camera.
223  void OrientParentCamera(double back[3], double up[3]);
225  void InterpolateCamera(int t);
226 
227  // Manage the state of the widget
228  enum class WidgetStateType : int
229  {
230  Inactive, // mouse is not over the widget, none of the handles are selected.
231  Hot, // mouse is over the widget but none of the handles are selected
232  Active // any one handle is selected, representation could be rotating.
233  };
234  WidgetStateType WidgetState = WidgetStateType::Inactive;
235 
237 
238  // Store camera interpolations.
240 
241  bool Animate = true;
242  int AnimatorTotalFrames = 20;
243 
244  int ResizeObserverTag = -1;
245 
246 private:
248  void operator=(const vtkCameraOrientationWidget&) = delete;
249 };
250 
251 #endif
define the API for widget / widget representation
interpolate a series of cameras to update a new camera
a 3D axes representation for interactive widgets
A widget to manipulate vtkCameraOrientationWidget.
vtkWeakPointer< vtkRenderer > ParentRenderer
vtkNew< vtkCameraInterpolator > CameraInterpolator
~vtkCameraOrientationWidget() override=default
static vtkCameraOrientationWidget * New()
static void SelectAction(vtkAbstractWidget *)
void PrintSelf(ostream &os, vtkIndent indent) override
Standard macros implementing standard VTK methods.
static void MoveAction(vtkAbstractWidget *)
void CreateDefaultRepresentation() override
Create a vtkCameraOrientationRepresentation.
static void EndSelectAction(vtkAbstractWidget *)
void ComputeWidgetState(int X, int Y, int modify=0)
vtkRenderer * GetParentRenderer()
This widget shows and manipulates the orientation of the parent renderer's active camera.
void SetParentRenderer(vtkRenderer *renderer)
This widget shows and manipulates the orientation of the parent renderer's active camera.
void OrientParentCamera(double back[3], double up[3])
void SquareResize()
Fits the widget's renderer to a square viewport.
a simple class to control print indentation
Definition: vtkIndent.h:113
abstract specification for renderers
Definition: vtkRenderer.h:173
#define VTK_INT_MAX
Definition: vtkType.h:155